From b869dd13e6d95cd330fac0ae36c916d92566a643 Mon Sep 17 00:00:00 2001 From: Priyadharshini <57977344+priyadharshini-sent@users.noreply.github.com> Date: Tue, 22 Sep 2020 19:02:46 +0530 Subject: [PATCH 001/792] Update index.yaml --- yaml/index.yaml | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/yaml/index.yaml b/yaml/index.yaml index 9679e18a1..99e104d94 100644 --- a/yaml/index.yaml +++ b/yaml/index.yaml @@ -195,6 +195,10 @@ Data: title: HDB Shelters Locations (SG) versions: v0.1: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/amenities_shelters_hdb_sg.yaml" + Business Check Dun & Bradstreet (SG): + title: Business Check Dun & Bradstreet (SG) + versions: + v0.1: "https://raw.githubusercontent.com/sentient-io/microservice-docs/dev/yaml/BusinessCheckDun&Bradstreet(SG).yaml" Data Alliance: Download Dataset API: title: Download Dataset API From 8889e429aa0809e9a88c54ccac1c2084a836c863 Mon Sep 17 00:00:00 2001 From: Priyadharshini <57977344+priyadharshini-sent@users.noreply.github.com> Date: Tue, 22 Sep 2020 19:08:33 +0530 Subject: [PATCH 002/792] Update BusinessCheckDun&Bradstreet(SG).yaml --- yaml/BusinessCheckDun&Bradstreet(SG).yaml | 8 ++------ 1 file changed, 2 insertions(+), 6 deletions(-) diff --git a/yaml/BusinessCheckDun&Bradstreet(SG).yaml b/yaml/BusinessCheckDun&Bradstreet(SG).yaml index 74beee471..c5964e985 100644 --- a/yaml/BusinessCheckDun&Bradstreet(SG).yaml +++ b/yaml/BusinessCheckDun&Bradstreet(SG).yaml @@ -22,11 +22,7 @@ paths: examples: xml: summary: A sample XML response - value: ' - -1199707714C - - GPS INDUSTRIES PTE LTD' + value: '' responses: '200': description: success response @@ -427,4 +423,4 @@ components: type: apiKey name: x-api-key in: header - x-amazon-apigateway-authtype: custom \ No newline at end of file + x-amazon-apigateway-authtype: custom From ae4fefb2d0a635f94ef61babd4569ffaf5cdf605 Mon Sep 17 00:00:00 2001 From: Priyadharshini <57977344+priyadharshini-sent@users.noreply.github.com> Date: Wed, 23 Sep 2020 09:53:59 +0530 Subject: [PATCH 003/792] Update BusinessCheckDun&Bradstreet(SG).yaml --- yaml/BusinessCheckDun&Bradstreet(SG).yaml | 125 ++++++++++++++++++++++ 1 file changed, 125 insertions(+) diff --git a/yaml/BusinessCheckDun&Bradstreet(SG).yaml b/yaml/BusinessCheckDun&Bradstreet(SG).yaml index c5964e985..f861b3a9c 100644 --- a/yaml/BusinessCheckDun&Bradstreet(SG).yaml +++ b/yaml/BusinessCheckDun&Bradstreet(SG).yaml @@ -30,6 +30,120 @@ paths: application/xml: schema: $ref: '#/components/schemas/success' + example: + success: + REPORT: + META_INFO: + SERVICE: string + SYSTEM_ID: string + CREATION_DATE: string + USER_ID: string + CLASS: string + REQ_SEARCH_INFO: + COMP_NAME: string + REG_NO: string + REQ_DATE: string + REQ_REG_NO: string + REQ_NAME: string + REQ_DATE_STR: string + REGISTRY_DETAIL: + COMP_NAME: string + RENEWAL_DATE: string + ADDRESS1: string + ADDRESS2: string + ADDRESS3: string + ADDRESS4: string + COMP_TYPE_CODE: string + REG_DATE: string + REG_ACTIVITY1: string + REG_ACTIVITY2: string + ACC_DATE: string + STATUS_EFFECT_DATE: string + NAME_EFFECT_DATE: string + EXPIRY_DATE: string + COMP_TYPE: string + CHANGE_ADDR_DATE: string + COMP_STATUS: string + REG_ACTIVITY_DESC1: string + REG_ACTIVITY_DESC2: string + AUDITOR: string + AUDITOR_APPMT_DATE: string + LAST_AR_DATE: string + LAST_AGM_DATE: string + COUNTRY_INCORP: string + EMPLOYEE_SIZE: + ELEMENTS: string + AMOUNT: string + LIST_BIZ_BRANCH: + BIZ_BRANCH: + ADDR_BUILDING: string + ADDR_POSTCODE: string + ADDR_ADDRESS1: string + LIST_REG_CHARGES: + REG_CHARGES: + CHARGE_NO: string + CHARGE_DATE: string + CHARGEE_COMP: string + CURRENCY: string + AMT_SECURED: string + STATUS_SATISFACTION: string + LIST_LIQUIDATOR: + LIQUIDATOR: + LIQ_NAME: string + LIQ_ID: string + LIQ_POSITION: string + LIQ_COMP: string + LIQ_ADDRESS1: string + LIQ_ADDRESS2: string + LIQ_ADDRESS3: string + LIQ_ADDRESS4: string + LIQ_APPOINTMENT_DATE: string + LIST_SALES_REVENUE_AMOUNT: + SALES_REVENUE_AMOUNT: + ELEMENTS: string + YEAR: string + CURRENCY: string + AMOUNT: 0 + LIST_SHAREHOLDER: + SHAREHOLDER: + ADDRESS: string + COMP_ID: string + NO_OF_SHARE: string + CURRENCY: string + SHAREHOLDER_TYPE: string + SHARE_TYPE: string + SHAREHOLDER_NAME: string + CHANGE_ADDR_DATE: string + ADDR_TYPE: string + NATIONALITY: string + LIST_SHARE_INTEREST_COMP: + SHARE_INTEREST_COMP: + COMP_NAME: string + SHARE_OWNED_UNIT: string + SHARE_OWNED_PERCENT: string + STATUS: string + LIST_OFFICER_OWNER: + OFFICER_OWNER: + ADDRESS: string + IDENTITY_ID: string + POSITION: string + ADDR_TYPE: string + CESSATION_DATE: string + OFFICER_NAME: string + CHANGE_ADDR_DATE: string + APPMT_DATE: string + NATIONALITY: string + LIST_CAPITAL: + CAPITAL: + CAPITAL_CATEGORY: string + CAPITAL_TYPE: string + CURRENCY: string + CAPITAL_AMT: string + NO_OF_SHARES: string + LIST_NAME_CHANGE: + NAME_CHANGE: + PREV_NAME: string + EFFECT_DATE: string '401': description: Unauthorized content: @@ -418,9 +532,20 @@ components: status: type: string example: Failure + versions: + type: object + properties: + v0.1: + type: array + items: + oneOf: + - type: string + example: Published Date - Jul 23, 2019 + description: Initial version release securitySchemes: APIAuthorizer: type: apiKey name: x-api-key in: header x-amazon-apigateway-authtype: custom + description: Authentication is done using the x-api-key in the request header From a7a9e69ce2fa77f3ae627ec6d34dc430c4ddeadf Mon Sep 17 00:00:00 2001 From: Priyadharshini <57977344+priyadharshini-sent@users.noreply.github.com> Date: Wed, 23 Sep 2020 15:36:31 +0530 Subject: [PATCH 004/792] Update BusinessCheckDun&Bradstreet(SG).yaml --- yaml/BusinessCheckDun&Bradstreet(SG).yaml | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/yaml/BusinessCheckDun&Bradstreet(SG).yaml b/yaml/BusinessCheckDun&Bradstreet(SG).yaml index f861b3a9c..2e93b768d 100644 --- a/yaml/BusinessCheckDun&Bradstreet(SG).yaml +++ b/yaml/BusinessCheckDun&Bradstreet(SG).yaml @@ -456,7 +456,7 @@ components: EFFECT_DATE: type: string unauthorized: - type: array + type: object items: properties: message: @@ -466,7 +466,7 @@ components: type: string example: Failure forbidden: - type: array + type: object items: properties: message: @@ -476,7 +476,7 @@ components: type: string example: Failure paymentrequired: - type: array + type: object items: properties: message: @@ -486,7 +486,7 @@ components: type: string example: Failure notfound: - type: array + type: object items: properties: message: @@ -496,7 +496,7 @@ components: type: string example: Failure servererror: - type: array + type: object items: properties: message: From fda2616dec69c828ebd2484737dc46f2cadd3c22 Mon Sep 17 00:00:00 2001 From: Priyadharshini <57977344+priyadharshini-sent@users.noreply.github.com> Date: Wed, 23 Sep 2020 16:13:36 +0530 Subject: [PATCH 005/792] Update BusinessCheckDun&Bradstreet(SG).yaml --- yaml/BusinessCheckDun&Bradstreet(SG).yaml | 75 +++++++++++------------ 1 file changed, 35 insertions(+), 40 deletions(-) diff --git a/yaml/BusinessCheckDun&Bradstreet(SG).yaml b/yaml/BusinessCheckDun&Bradstreet(SG).yaml index 2e93b768d..3535c5afa 100644 --- a/yaml/BusinessCheckDun&Bradstreet(SG).yaml +++ b/yaml/BusinessCheckDun&Bradstreet(SG).yaml @@ -457,54 +457,49 @@ components: type: string unauthorized: type: object - items: - properties: - message: - type: string - example: Missing Authentication Token - status: - type: string - example: Failure + properties: + message: + type: string + example: Missing Authentication Token + status: + type: string + example: Failure forbidden: type: object - items: - properties: - message: - type: string - example: Access Denied Unauthorized User - status: - type: string - example: Failure + properties: + message: + type: string + example: Access Denied Unauthorized User + status: + type: string + example: Failure paymentrequired: type: object - items: - properties: - message: - type: string - example: Insufficient Credits Kindly Top Up - status: - type: string - example: Failure + properties: + message: + type: string + example: Insufficient Credits Kindly Top Up + status: + type: string + example: Failure notfound: type: object - items: - properties: - message: - type: string - example: Invalid Request URL - status: - type: string - example: Failure + properties: + message: + type: string + example: Invalid Request URL + status: + type: string + example: Failure servererror: type: object - items: - properties: - message: - type: string - example: Internal Server Error - status: - type: string - example: Failure + properties: + message: + type: string + example: Internal Server Error + status: + type: string + example: Failure gatewaytimeout: type: object properties: From 0efc924532caf05f4df93e41e5d5aecb9aa922d8 Mon Sep 17 00:00:00 2001 From: Priyadharshini <57977344+priyadharshini-sent@users.noreply.github.com> Date: Wed, 23 Sep 2020 16:22:54 +0530 Subject: [PATCH 006/792] Update BusinessCheckDun&Bradstreet(SG).yaml --- yaml/BusinessCheckDun&Bradstreet(SG).yaml | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/yaml/BusinessCheckDun&Bradstreet(SG).yaml b/yaml/BusinessCheckDun&Bradstreet(SG).yaml index 3535c5afa..6ba19f999 100644 --- a/yaml/BusinessCheckDun&Bradstreet(SG).yaml +++ b/yaml/BusinessCheckDun&Bradstreet(SG).yaml @@ -527,6 +527,12 @@ components: status: type: string example: Failure + input: + type: object + properties: + status: + type: string + example: Input Limit Exceeded versions: type: object properties: From 45fc123e1f318bc07a4a55ed71c269856f773b46 Mon Sep 17 00:00:00 2001 From: Priyadharshini <57977344+priyadharshini-sent@users.noreply.github.com> Date: Wed, 23 Sep 2020 16:33:58 +0530 Subject: [PATCH 007/792] Update BusinessCheckDun&Bradstreet(SG).yaml --- yaml/BusinessCheckDun&Bradstreet(SG).yaml | 251 ++++++++++++---------- 1 file changed, 138 insertions(+), 113 deletions(-) diff --git a/yaml/BusinessCheckDun&Bradstreet(SG).yaml b/yaml/BusinessCheckDun&Bradstreet(SG).yaml index 6ba19f999..a3720bd51 100644 --- a/yaml/BusinessCheckDun&Bradstreet(SG).yaml +++ b/yaml/BusinessCheckDun&Bradstreet(SG).yaml @@ -31,119 +31,144 @@ paths: schema: $ref: '#/components/schemas/success' example: - success: - REPORT: - META_INFO: - SERVICE: string - SYSTEM_ID: string - CREATION_DATE: string - USER_ID: string - CLASS: string - REQ_SEARCH_INFO: - COMP_NAME: string - REG_NO: string - REQ_DATE: string - REQ_REG_NO: string - REQ_NAME: string - REQ_DATE_STR: string - REGISTRY_DETAIL: - COMP_NAME: string - RENEWAL_DATE: string - ADDRESS1: string - ADDRESS2: string - ADDRESS3: string - ADDRESS4: string - COMP_TYPE_CODE: string - REG_DATE: string - REG_ACTIVITY1: string - REG_ACTIVITY2: string - ACC_DATE: string - STATUS_EFFECT_DATE: string - NAME_EFFECT_DATE: string - EXPIRY_DATE: string - COMP_TYPE: string - CHANGE_ADDR_DATE: string - COMP_STATUS: string - REG_ACTIVITY_DESC1: string - REG_ACTIVITY_DESC2: string - AUDITOR: string - AUDITOR_APPMT_DATE: string - LAST_AR_DATE: string - LAST_AGM_DATE: string - COUNTRY_INCORP: string - EMPLOYEE_SIZE: - ELEMENTS: string - AMOUNT: string - LIST_BIZ_BRANCH: - BIZ_BRANCH: - ADDR_BUILDING: string - ADDR_POSTCODE: string - ADDR_ADDRESS1: string - LIST_REG_CHARGES: - REG_CHARGES: - CHARGE_NO: string - CHARGE_DATE: string - CHARGEE_COMP: string - CURRENCY: string - AMT_SECURED: string - STATUS_SATISFACTION: string - LIST_LIQUIDATOR: - LIQUIDATOR: - LIQ_NAME: string - LIQ_ID: string - LIQ_POSITION: string - LIQ_COMP: string - LIQ_ADDRESS1: string - LIQ_ADDRESS2: string - LIQ_ADDRESS3: string - LIQ_ADDRESS4: string - LIQ_APPOINTMENT_DATE: string - LIST_SALES_REVENUE_AMOUNT: - SALES_REVENUE_AMOUNT: - ELEMENTS: string - YEAR: string - CURRENCY: string - AMOUNT: 0 - LIST_SHAREHOLDER: - SHAREHOLDER: - ADDRESS: string - COMP_ID: string - NO_OF_SHARE: string - CURRENCY: string - SHAREHOLDER_TYPE: string - SHARE_TYPE: string - SHAREHOLDER_NAME: string - CHANGE_ADDR_DATE: string - ADDR_TYPE: string - NATIONALITY: string - LIST_SHARE_INTEREST_COMP: - SHARE_INTEREST_COMP: - COMP_NAME: string - SHARE_OWNED_UNIT: string - SHARE_OWNED_PERCENT: string - STATUS: string - LIST_OFFICER_OWNER: - OFFICER_OWNER: - ADDRESS: string - IDENTITY_ID: string - POSITION: string - ADDR_TYPE: string - CESSATION_DATE: string - OFFICER_NAME: string - CHANGE_ADDR_DATE: string - APPMT_DATE: string - NATIONALITY: string - LIST_CAPITAL: - CAPITAL: - CAPITAL_CATEGORY: string - CAPITAL_TYPE: string - CURRENCY: string - CAPITAL_AMT: string - NO_OF_SHARES: string - LIST_NAME_CHANGE: - NAME_CHANGE: - PREV_NAME: string - EFFECT_DATE: string + + + + + string + string + string + string + string + + + string + string + string + string + string + string + + + string + string + string + string + string + string + string + string + string + string + string + string + string + string + string + string + string + string + string + string + string + string + string + string + + + string + string + + + + string + string + string + + + + + string + string + string + string + string + string + + + + + string + string + string + string + string + string + string + string + string + + + + + string + string + string + 0 + + + + +
string
+ string + string + string + string + string + string + string + string + string + + + + + string + string + string + string + + + + +
string
+ string + string + string + string + string + string + string + string + + + + + string + string + string + string + string + + + + + string + string + + + + '401': description: Unauthorized content: From 27aecf2223fb586a9f9274220e28bf94775032af Mon Sep 17 00:00:00 2001 From: Priyadharshini <57977344+priyadharshini-sent@users.noreply.github.com> Date: Wed, 23 Sep 2020 16:42:31 +0530 Subject: [PATCH 008/792] Update index.yaml --- yaml/index.yaml | 4 ---- 1 file changed, 4 deletions(-) diff --git a/yaml/index.yaml b/yaml/index.yaml index 99e104d94..9679e18a1 100644 --- a/yaml/index.yaml +++ b/yaml/index.yaml @@ -195,10 +195,6 @@ Data: title: HDB Shelters Locations (SG) versions: v0.1: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/amenities_shelters_hdb_sg.yaml" - Business Check Dun & Bradstreet (SG): - title: Business Check Dun & Bradstreet (SG) - versions: - v0.1: "https://raw.githubusercontent.com/sentient-io/microservice-docs/dev/yaml/BusinessCheckDun&Bradstreet(SG).yaml" Data Alliance: Download Dataset API: title: Download Dataset API From 38bfbeb3f0295de07a827bb2a1dc976e77db20b2 Mon Sep 17 00:00:00 2001 From: Priyadharshini <57977344+priyadharshini-sent@users.noreply.github.com> Date: Thu, 24 Sep 2020 08:52:01 +0530 Subject: [PATCH 009/792] Update index.yaml --- yaml/index.yaml | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/yaml/index.yaml b/yaml/index.yaml index 9679e18a1..99e104d94 100644 --- a/yaml/index.yaml +++ b/yaml/index.yaml @@ -195,6 +195,10 @@ Data: title: HDB Shelters Locations (SG) versions: v0.1: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/amenities_shelters_hdb_sg.yaml" + Business Check Dun & Bradstreet (SG): + title: Business Check Dun & Bradstreet (SG) + versions: + v0.1: "https://raw.githubusercontent.com/sentient-io/microservice-docs/dev/yaml/BusinessCheckDun&Bradstreet(SG).yaml" Data Alliance: Download Dataset API: title: Download Dataset API From 96b35b1bb25dad9e65b73412baa57e09ff21dc9a Mon Sep 17 00:00:00 2001 From: Priyadharshini <57977344+priyadharshini-sent@users.noreply.github.com> Date: Thu, 24 Sep 2020 09:01:06 +0530 Subject: [PATCH 010/792] Update BusinessCheckDun&Bradstreet(SG).yaml --- yaml/BusinessCheckDun&Bradstreet(SG).yaml | 251 ++++++++++------------ 1 file changed, 113 insertions(+), 138 deletions(-) diff --git a/yaml/BusinessCheckDun&Bradstreet(SG).yaml b/yaml/BusinessCheckDun&Bradstreet(SG).yaml index a3720bd51..6ba19f999 100644 --- a/yaml/BusinessCheckDun&Bradstreet(SG).yaml +++ b/yaml/BusinessCheckDun&Bradstreet(SG).yaml @@ -31,144 +31,119 @@ paths: schema: $ref: '#/components/schemas/success' example: - - - - - string - string - string - string - string - - - string - string - string - string - string - string - - - string - string - string - string - string - string - string - string - string - string - string - string - string - string - string - string - string - string - string - string - string - string - string - string - - - string - string - - - - string - string - string - - - - - string - string - string - string - string - string - - - - - string - string - string - string - string - string - string - string - string - - - - - string - string - string - 0 - - - - -
string
- string - string - string - string - string - string - string - string - string - - - - - string - string - string - string - - - - -
string
- string - string - string - string - string - string - string - string - - - - - string - string - string - string - string - - - - - string - string - - - - + success: + REPORT: + META_INFO: + SERVICE: string + SYSTEM_ID: string + CREATION_DATE: string + USER_ID: string + CLASS: string + REQ_SEARCH_INFO: + COMP_NAME: string + REG_NO: string + REQ_DATE: string + REQ_REG_NO: string + REQ_NAME: string + REQ_DATE_STR: string + REGISTRY_DETAIL: + COMP_NAME: string + RENEWAL_DATE: string + ADDRESS1: string + ADDRESS2: string + ADDRESS3: string + ADDRESS4: string + COMP_TYPE_CODE: string + REG_DATE: string + REG_ACTIVITY1: string + REG_ACTIVITY2: string + ACC_DATE: string + STATUS_EFFECT_DATE: string + NAME_EFFECT_DATE: string + EXPIRY_DATE: string + COMP_TYPE: string + CHANGE_ADDR_DATE: string + COMP_STATUS: string + REG_ACTIVITY_DESC1: string + REG_ACTIVITY_DESC2: string + AUDITOR: string + AUDITOR_APPMT_DATE: string + LAST_AR_DATE: string + LAST_AGM_DATE: string + COUNTRY_INCORP: string + EMPLOYEE_SIZE: + ELEMENTS: string + AMOUNT: string + LIST_BIZ_BRANCH: + BIZ_BRANCH: + ADDR_BUILDING: string + ADDR_POSTCODE: string + ADDR_ADDRESS1: string + LIST_REG_CHARGES: + REG_CHARGES: + CHARGE_NO: string + CHARGE_DATE: string + CHARGEE_COMP: string + CURRENCY: string + AMT_SECURED: string + STATUS_SATISFACTION: string + LIST_LIQUIDATOR: + LIQUIDATOR: + LIQ_NAME: string + LIQ_ID: string + LIQ_POSITION: string + LIQ_COMP: string + LIQ_ADDRESS1: string + LIQ_ADDRESS2: string + LIQ_ADDRESS3: string + LIQ_ADDRESS4: string + LIQ_APPOINTMENT_DATE: string + LIST_SALES_REVENUE_AMOUNT: + SALES_REVENUE_AMOUNT: + ELEMENTS: string + YEAR: string + CURRENCY: string + AMOUNT: 0 + LIST_SHAREHOLDER: + SHAREHOLDER: + ADDRESS: string + COMP_ID: string + NO_OF_SHARE: string + CURRENCY: string + SHAREHOLDER_TYPE: string + SHARE_TYPE: string + SHAREHOLDER_NAME: string + CHANGE_ADDR_DATE: string + ADDR_TYPE: string + NATIONALITY: string + LIST_SHARE_INTEREST_COMP: + SHARE_INTEREST_COMP: + COMP_NAME: string + SHARE_OWNED_UNIT: string + SHARE_OWNED_PERCENT: string + STATUS: string + LIST_OFFICER_OWNER: + OFFICER_OWNER: + ADDRESS: string + IDENTITY_ID: string + POSITION: string + ADDR_TYPE: string + CESSATION_DATE: string + OFFICER_NAME: string + CHANGE_ADDR_DATE: string + APPMT_DATE: string + NATIONALITY: string + LIST_CAPITAL: + CAPITAL: + CAPITAL_CATEGORY: string + CAPITAL_TYPE: string + CURRENCY: string + CAPITAL_AMT: string + NO_OF_SHARES: string + LIST_NAME_CHANGE: + NAME_CHANGE: + PREV_NAME: string + EFFECT_DATE: string '401': description: Unauthorized content: From c96b49515b2d30a2ba87cf9c6a4dcee19e82a50f Mon Sep 17 00:00:00 2001 From: Priyadharshini <57977344+priyadharshini-sent@users.noreply.github.com> Date: Thu, 24 Sep 2020 09:45:35 +0530 Subject: [PATCH 011/792] Update BusinessCheckDun&Bradstreet(SG).yaml --- yaml/BusinessCheckDun&Bradstreet(SG).yaml | 6 +----- 1 file changed, 1 insertion(+), 5 deletions(-) diff --git a/yaml/BusinessCheckDun&Bradstreet(SG).yaml b/yaml/BusinessCheckDun&Bradstreet(SG).yaml index 6ba19f999..f11540176 100644 --- a/yaml/BusinessCheckDun&Bradstreet(SG).yaml +++ b/yaml/BusinessCheckDun&Bradstreet(SG).yaml @@ -18,11 +18,7 @@ paths: content: application/xml: schema: - type: string - examples: - xml: - summary: A sample XML response - value: '' + $ref: '#/components/schemas/success' responses: '200': description: success response From ba0cd2088ac89f3880de0d6b158a865b0e181abe Mon Sep 17 00:00:00 2001 From: Priyadharshini <57977344+priyadharshini-sent@users.noreply.github.com> Date: Thu, 24 Sep 2020 10:15:09 +0530 Subject: [PATCH 012/792] Update BusinessCheckDun&Bradstreet(SG).yaml --- yaml/BusinessCheckDun&Bradstreet(SG).yaml | 255 ++++++++++++---------- 1 file changed, 140 insertions(+), 115 deletions(-) diff --git a/yaml/BusinessCheckDun&Bradstreet(SG).yaml b/yaml/BusinessCheckDun&Bradstreet(SG).yaml index f11540176..1cc4e01d1 100644 --- a/yaml/BusinessCheckDun&Bradstreet(SG).yaml +++ b/yaml/BusinessCheckDun&Bradstreet(SG).yaml @@ -18,7 +18,7 @@ paths: content: application/xml: schema: - $ref: '#/components/schemas/success' + $ref: '#/components/schemas/success' responses: '200': description: success response @@ -26,120 +26,145 @@ paths: application/xml: schema: $ref: '#/components/schemas/success' - example: - success: - REPORT: - META_INFO: - SERVICE: string - SYSTEM_ID: string - CREATION_DATE: string - USER_ID: string - CLASS: string - REQ_SEARCH_INFO: - COMP_NAME: string - REG_NO: string - REQ_DATE: string - REQ_REG_NO: string - REQ_NAME: string - REQ_DATE_STR: string - REGISTRY_DETAIL: - COMP_NAME: string - RENEWAL_DATE: string - ADDRESS1: string - ADDRESS2: string - ADDRESS3: string - ADDRESS4: string - COMP_TYPE_CODE: string - REG_DATE: string - REG_ACTIVITY1: string - REG_ACTIVITY2: string - ACC_DATE: string - STATUS_EFFECT_DATE: string - NAME_EFFECT_DATE: string - EXPIRY_DATE: string - COMP_TYPE: string - CHANGE_ADDR_DATE: string - COMP_STATUS: string - REG_ACTIVITY_DESC1: string - REG_ACTIVITY_DESC2: string - AUDITOR: string - AUDITOR_APPMT_DATE: string - LAST_AR_DATE: string - LAST_AGM_DATE: string - COUNTRY_INCORP: string - EMPLOYEE_SIZE: - ELEMENTS: string - AMOUNT: string - LIST_BIZ_BRANCH: - BIZ_BRANCH: - ADDR_BUILDING: string - ADDR_POSTCODE: string - ADDR_ADDRESS1: string - LIST_REG_CHARGES: - REG_CHARGES: - CHARGE_NO: string - CHARGE_DATE: string - CHARGEE_COMP: string - CURRENCY: string - AMT_SECURED: string - STATUS_SATISFACTION: string - LIST_LIQUIDATOR: - LIQUIDATOR: - LIQ_NAME: string - LIQ_ID: string - LIQ_POSITION: string - LIQ_COMP: string - LIQ_ADDRESS1: string - LIQ_ADDRESS2: string - LIQ_ADDRESS3: string - LIQ_ADDRESS4: string - LIQ_APPOINTMENT_DATE: string - LIST_SALES_REVENUE_AMOUNT: - SALES_REVENUE_AMOUNT: - ELEMENTS: string - YEAR: string - CURRENCY: string - AMOUNT: 0 - LIST_SHAREHOLDER: - SHAREHOLDER: - ADDRESS: string - COMP_ID: string - NO_OF_SHARE: string - CURRENCY: string - SHAREHOLDER_TYPE: string - SHARE_TYPE: string - SHAREHOLDER_NAME: string - CHANGE_ADDR_DATE: string - ADDR_TYPE: string - NATIONALITY: string - LIST_SHARE_INTEREST_COMP: - SHARE_INTEREST_COMP: - COMP_NAME: string - SHARE_OWNED_UNIT: string - SHARE_OWNED_PERCENT: string - STATUS: string - LIST_OFFICER_OWNER: - OFFICER_OWNER: - ADDRESS: string - IDENTITY_ID: string - POSITION: string - ADDR_TYPE: string - CESSATION_DATE: string - OFFICER_NAME: string - CHANGE_ADDR_DATE: string - APPMT_DATE: string - NATIONALITY: string - LIST_CAPITAL: - CAPITAL: - CAPITAL_CATEGORY: string - CAPITAL_TYPE: string - CURRENCY: string - CAPITAL_AMT: string - NO_OF_SHARES: string - LIST_NAME_CHANGE: - NAME_CHANGE: - PREV_NAME: string - EFFECT_DATE: string + example: |+ + + + + + string + string + string + string + string + + + string + string + string + string + string + string + + + string + string + string + string + string + string + string + string + string + string + string + string + string + string + string + string + string + string + string + string + string + string + string + string + + + string + string + + + + string + string + string + + + + + string + string + string + string + string + string + + + + + string + string + string + string + string + string + string + string + string + + + + + string + string + string + 0 + + + + +
string
+ string + string + string + string + string + string + string + string + string + + + + + string + string + string + string + + + + +
string
+ string + string + string + string + string + string + string + string + + + + + string + string + string + string + string + + + + + string + string + + + + '401': description: Unauthorized content: From c3f53f9f20a7b7ca4398f2c5f8ff01086a809aa6 Mon Sep 17 00:00:00 2001 From: priyaPeristera Date: Thu, 24 Sep 2020 14:46:39 +1000 Subject: [PATCH 013/792] change mandatory fields --- yaml/asr_with_vad_eng_sg.yaml | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/yaml/asr_with_vad_eng_sg.yaml b/yaml/asr_with_vad_eng_sg.yaml index 77ace0fef..54728faf7 100644 --- a/yaml/asr_with_vad_eng_sg.yaml +++ b/yaml/asr_with_vad_eng_sg.yaml @@ -194,17 +194,17 @@ components: 1. news_parliament - 16 kHz, mono channel, .wav format. Trained on Singapore news and parliament corpus. 2. nsc_parliament - 16 kHz, mono channel, .wav format. Trained on National Speech Corpus and parliament corpus. 3. nscfull_8k - 8 kHz, mono channel, .wav format. Trained on National Speech Corpus. Trained on Full National Speech Corpus corpus. - wav_url/wav_base64: - x-name: wav_url/wav_base64 + wav_base64: + x-name: wav_base64 type: string default: true - example: https://api.sentient.io/test2.wav or UklGRpxNHQBXQVZFZm10IBAAAAABAAEAgD4AAAB9AAACABAAT ... + example: UklGRpxNHQBXQVZFZm10IBAAAAABAAEAgD4AAAB9AAACABAAT ... description: |+ - The public URL link to the wave file or Input audio wav file in base64 format. Mono channel, 8kHz / 16kHz sampling rate. + Input audio wav file in base64 format. Mono channel, 8kHz / 16kHz sampling rate. file_type: x-name: file_type type: string - default: false + default: true example: wav description: |+ Input file extension. Only “wav” is supported at the moment. @@ -212,7 +212,7 @@ components: x-name: vad_threshold type: number format: float - default: false + default: true example: 0.4 description: |+ 0.0 to 1.0. Lower will result in more sentence splits. Recommended value is 0.25. From a79217839fae7744cfabcd990b70d3c08bfb1602 Mon Sep 17 00:00:00 2001 From: priyaPeristera Date: Thu, 24 Sep 2020 14:52:34 +1000 Subject: [PATCH 014/792] Add missing input fields --- yaml/automatic_speech_recognition_chi_sg.yaml | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/yaml/automatic_speech_recognition_chi_sg.yaml b/yaml/automatic_speech_recognition_chi_sg.yaml index 00cf3e134..41af29144 100644 --- a/yaml/automatic_speech_recognition_chi_sg.yaml +++ b/yaml/automatic_speech_recognition_chi_sg.yaml @@ -180,6 +180,14 @@ components: description: |+ Input file in base64 format and needs to be prefixed by the data type and encoding data:audio/wav;base64, + language: + x-name: language + type: string + default: true + example: 1 + description: |+ + Language setting: + 1 Mandarin versions: type: object properties: From 7b6b7586f0706de37b40c64b6ae32dc684ab42e7 Mon Sep 17 00:00:00 2001 From: priyaPeristera Date: Thu, 24 Sep 2020 19:08:34 +1000 Subject: [PATCH 015/792] Update automatic_speech_recognition_eng_sg.yaml --- yaml/automatic_speech_recognition_eng_sg.yaml | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/yaml/automatic_speech_recognition_eng_sg.yaml b/yaml/automatic_speech_recognition_eng_sg.yaml index efa8277ee..21f786104 100644 --- a/yaml/automatic_speech_recognition_eng_sg.yaml +++ b/yaml/automatic_speech_recognition_eng_sg.yaml @@ -201,9 +201,11 @@ components: default: true example: nsc_parliament description: |+ - Model name: - 1. news_parliament. 16 kHz, mono channel. wav format. “news_parliament” is trained on Singapore news and parliament corpus. - 2. nsc_parliament. 16 kHz, mono channel. wav format. “nsc_parliament” is trained on National Speech Corpus and parliament corpus. + Model selection. For best performance, select the model which best matches the use-case: + + 1. news_parliament - 16 kHz, mono channel, .wav format. Trained on Singapore news and parliament corpus. + 2. nsc_parliament - 16 kHz, mono channel, .wav format. Trained on National Speech Corpus and parliament corpus. + 3. nscfull_8k - 8 kHz, mono channel, .wav format. Trained on National Speech Corpus. Trained on Full National Speech Corpus corpus. wav_base64: x-name: wav_base64 type: string From b6da5e88315658beaf5d2c57d20f9287203a20d6 Mon Sep 17 00:00:00 2001 From: priyaPeristera Date: Thu, 24 Sep 2020 23:20:05 +1000 Subject: [PATCH 016/792] Update carpark_hdb_sg.yaml --- yaml/carpark_hdb_sg.yaml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/yaml/carpark_hdb_sg.yaml b/yaml/carpark_hdb_sg.yaml index d51736462..5b25479a8 100644 --- a/yaml/carpark_hdb_sg.yaml +++ b/yaml/carpark_hdb_sg.yaml @@ -185,8 +185,8 @@ paths: _source: cpk_no: BE37 block: BLK 282 - street: BE37 BISHAN STREET 22 - address: BLK 282 BE37 BISHAN STREET 22 + street: BISHAN STREET 22 + address: BLK 282 BISHAN STREET 22 source: hdb xcoord: '29235.553' ycoord: '37787.1371' From 88d6dc8c46b8c6917bd692acd04e47312d51db31 Mon Sep 17 00:00:00 2001 From: Priyadharshini <57977344+priyadharshini-sent@users.noreply.github.com> Date: Fri, 25 Sep 2020 10:33:39 +0530 Subject: [PATCH 017/792] Update index.yaml --- yaml/index.yaml | 4 ---- 1 file changed, 4 deletions(-) diff --git a/yaml/index.yaml b/yaml/index.yaml index 99e104d94..9679e18a1 100644 --- a/yaml/index.yaml +++ b/yaml/index.yaml @@ -195,10 +195,6 @@ Data: title: HDB Shelters Locations (SG) versions: v0.1: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/amenities_shelters_hdb_sg.yaml" - Business Check Dun & Bradstreet (SG): - title: Business Check Dun & Bradstreet (SG) - versions: - v0.1: "https://raw.githubusercontent.com/sentient-io/microservice-docs/dev/yaml/BusinessCheckDun&Bradstreet(SG).yaml" Data Alliance: Download Dataset API: title: Download Dataset API From 4a53cf131b4687f6897215060f8d670387707a7d Mon Sep 17 00:00:00 2001 From: Priyadharshini Date: Wed, 30 Sep 2020 14:34:54 +0530 Subject: [PATCH 018/792] latest yaml files from dev branch merge --- ...sicIndividualSearchDun&Bradstreet(SG).yaml | 1070 +++++++++++-- ...FinancialExtractionDun&Bradstreet(SG).yaml | 1398 ++++++++++++---- yaml/BusinessCheckDun&Bradstreet(SG).yaml | 1085 +++++++++---- yaml/BusinessCheckPlusDun&Bradstreet(SG).yaml | 1400 +++++++++++++++-- yaml/asr_with_vad_eng_sg.yaml | 12 +- yaml/automatic_speech_recognition_chi_sg.yaml | 8 - yaml/automatic_speech_recognition_eng_sg.yaml | 8 +- yaml/carpark_hdb_sg.yaml | 4 +- yaml/named-entity_recognition_eng.yaml | 7 + yaml/named-entity_recognition_eng_v1.0.yaml | 237 +++ yaml/named-entity_recognition_jap.yaml | 7 + yaml/named-entity_recognition_jap_v1.0.yaml | 304 ++++ yaml/named-entity_recognition_thai.yaml | 7 + yaml/named-entity_recognition_thai_v1.0.yaml | 304 ++++ yaml/newspaper_article_scraper.yaml | 6 +- yaml/page_profiler_eng.yaml | 13 +- yaml/page_profiler_eng_v2.0.yaml | 227 +++ yaml/page_profiler_jp.yaml | 242 +++ yaml/page_profiler_thai.yaml | 255 +++ yaml/spacy_named-entity_recognition_eng.yaml | 298 ++++ yaml/web_scraper.yaml | 2 +- 21 files changed, 6024 insertions(+), 870 deletions(-) create mode 100644 yaml/named-entity_recognition_eng_v1.0.yaml create mode 100644 yaml/named-entity_recognition_jap_v1.0.yaml create mode 100644 yaml/named-entity_recognition_thai_v1.0.yaml create mode 100644 yaml/page_profiler_eng_v2.0.yaml create mode 100644 yaml/page_profiler_jp.yaml create mode 100644 yaml/page_profiler_thai.yaml create mode 100644 yaml/spacy_named-entity_recognition_eng.yaml diff --git a/yaml/BasicIndividualSearchDun&Bradstreet(SG).yaml b/yaml/BasicIndividualSearchDun&Bradstreet(SG).yaml index 578a7a3b1..a4eb784ce 100644 --- a/yaml/BasicIndividualSearchDun&Bradstreet(SG).yaml +++ b/yaml/BasicIndividualSearchDun&Bradstreet(SG).yaml @@ -1,7 +1,8 @@ openapi: 3.0.1 info: title: Basic Individual Search Dun & Bradstreet (SG) - description: This Data microservice provides the information on the (Singapore-registered) business interest of an individual that includes the individual’s actual name, residential address, business and shareholding in businesses, current & previous ownership, litigation against individual and businesses, bankruptcy record and count on the times this individual has been searched on. Updated daily.

Authentication:

Authentication is done using the x-api-key in the request header. + description: |+ + This Data microservice provides the information on the (Singapore-registered) business interest of an individual that includes the individual’s actual name, residential address, business and shareholding in businesses, current & previous ownership, litigation against individual and businesses, bankruptcy record and count on the times this individual has been searched on. Updated daily. version: '0.1' servers: - url: 'https://api.sentient.io' @@ -18,15 +19,7 @@ paths: content: application/xml: schema: - type: string - examples: - xml: - summary: A sample XML response - value: ' - -1197803191K - -' + $ref: '#/components/schemas/REQUEST' responses: '200': description: success response @@ -34,6 +27,74 @@ paths: application/xml: schema: $ref: '#/components/schemas/success' + example: |+ + + 25/02/2009 17:31:44.678 + + + + + + 25/02/2009 17:31:44 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - - S7250163B + + + - - S7250163B + + + + + + 1 1 1 1 1 1 1 1 1 1 1 1 2017 1 + + 0 0 0 0 0 0 0 0 0 0 0 0 2016 1 + + 0 0 0 0 0 0 0 0 0 0 0 0 2015 1 + + 0 0 0 0 0 0 0 0 0 0 0 0 2017 0 + + 0 0 0 0 0 0 0 0 0 0 0 0 2016 0 + + 0 0 0 0 0 0 0 0 0 0 0 + 0 2015 0 + + '401': description: Unauthorized content: @@ -91,336 +152,1069 @@ components: properties: REPORT: type: object + example: + description: |+ + Report details with following children: + [META_INFO] + [BASIC_INFO] + [LIT_SEARCH_INFO] + [LIST_CURRENT_COMP] + [LIST_PREVIOUS_COMP] + [LIST_BANKRUPTCY] + [LIST_LIT] + [LIST_LIT_DTL] properties: META_INFO: type: object + example: |+ + + + + 25/02/2009 17:31:44.678 + + + description: |+ + Meta Information details with following children: + SERVICE + SYSTEM_ID + CREATION_DATE + USER_ID properties: SERVICE: type: string + example: "BIS" + description: Report Requested SYSTEM_ID : type: string + example: "DDP" + description: System ID CREATION_DATE: - type: string + type: datetime + example: "25/02/2009 17:31:44.678" + description: Report Request Date USER_ID : type: string + example: N/A + description: Valid user id in DDP system. It is for (For internal use) BASIC_INFO : type: object + description: |+ + Basic Information with following children: + PA_REG_NO + ADDRESS1 + ADDRESS2 + ADDRESS3 + example: |+ + + + + + + properties: - PA_REG_NO : + PA_REG_NO: type: string + description: Public Accountant Registration No. + example: "00091" ADDRESS1: type: string + description: Address 1 + example: "137" ADDRESS2: type: string + description: Address 2 + example: "vvvvv" ADDRESS3: type: string + description: Address 3 + example: "470137, SINGAPORE" LIT_SEARCH_INFO : type: object + example: |+ + + + + + 25/02/2009 17:31:44 + + + + + description: |+ + Litigation search information with following children: + COMP_NAME + REG_NO + REPORT_TYPE + REQ_DATE + REQ_REG_NO + REQ_NAME + REQ_DATE_STR properties: COMP_NAME: type: string + description: Company Name + example: "ENG YICK HOLDINGS PTE LTD" REG_NO: type: string + description: Company Registration No + example: "197803191K" REPORT_TYPE: type: string + description: Report Type + example: "BIS" REQ_DATE: - type: string + type: datetime + description: Requested Date + example: "25/02/2009 17:31:44" REQ_REG_NO: type: string + description: Request Registration Number + example: "197803191K" REQ_NAME: type: string + description: Request Name + example: "LOY KOK TOON" REQ_DATE_STR: - type: string + type: string + description: Request Date String + example: "25/02/2009 15:04:14" LIST_CURRENT_COMP : - type: object - properties: - CURRENT_COMP : - type: object - properties: - POSITION: - type: string - APPOINTMENT_DATE: - type: string - COMP_NAME: - type: string - SEQ_NO: - type: string - SHARE_VALUE1: - type: string - COMP_STATUS: - type: string - PROFIT_VALUE1: - type: string - PROFIT_VALUE2: - type: string - PROFIT_VALUE3: - type: string - SHARE_VALUE: - type: string - TEL: - type: string - FAX: - type: string - SIC: - type: string - SIC_DESC: - type: string + type: array + description: |+ + List of current companies with following children: + [CURRENT_COMP] + example: |+ + + + + + + + + + + + + + + + + + + + items: + properties: + CURRENT_COMP: + type: object + description: |+ + Current companies detail with following children: + POSITION + APPOINTMENT_DATE + COMP_NAME + SEQ_NO + SHARE_VALUE1 + COMP_STATUS + PROFIT_VALUE + SHARE_VALUE + TEL + FAX + SIC + SIC_DESC + example: |+ + + + + + + + + + + + + + + + + + properties: + POSITION: + type: string + description: Position + example: "OWNER" + APPOINTMENT_DATE: + type: string + description: Appointment Date + example: "01/09/1971" + COMP_NAME: + type: string + description: Company Name + example: "BAN HOE LEONG COMPANY" + SEQ_NO: + type: string + description: Company Registration No. + example: "03647300J" + SHARE_VALUE1: + type: string + description: Share Percentage + example: "15.00" + COMP_STATUS: + type: string + description: Company Status + example: "LIVE" + PROFIT_VALUE1: + type: string + description: Profit Making 1 + example: "2008 = -" + PROFIT_VALUE2: + type: string + description: Profit Making 2 + example: "2007 = -" + PROFIT_VALUE3: + type: string + description: Profit Making 3 + example: "2006 = -" + SHARE_VALUE: + type: string + description: Number Of Shares + example: "150000" + TEL: + type: string + description: Telephone Number + example: "62994842" + FAX: + type: string + description: Fax Number + example: "62992797" + SIC: + type: string + description: SIC Code + example: "5012" + SIC_DESC: + type: string + description: SIC Description + example: "Automobiles and other Motor Vehicles" LIST_PREVIOUS_COMP: type: array + example: |+ + + + + + + + + + + + + + + + + + description: |+ + List of previous companies with following children: + [PREVIOUS_COMP] items: properties: PREVIOUS_COMP : type: object + description: |+ + Previous companies detail with following children: + POSITION + APPOINTMENT_DATE + COMP_NAME + SEQ_NO + SHARE_VALUE1 + COMP_STATUS + CESSATION_DATE + SHARE_VALUE + TEL + FAX + SIC + SIC_DESC + example: |+ + + + + + + + + + + + + + + properties: POSITION : type: string + description: Position + example: "SHAREHOLDER" APPOINTMENT_DATE: type: string + description: Appointment Date + example: "30/06/1988" COMP_NAME: type: string + description: Company Name + example: "ENG YICK INDUSTRIES PTE LTD" SEQ_NO: type: string + description: Company Registration No. + example: "198101820Z" SHARE_VALUE1: type: string + description: Share Value Percentage + example: "100.00" COMP_STATUS: type: string + description: Company Status + example: "DISSOLVED - COMPULSORY WINDING UP (INSOLVENCY)" CESSATION_DATE : type: string + description: Cessation Date + example: "22/09/1992" SHARE_VALUE: type: string + description: Number Of Shares + example: "390002" TEL: type: string + description: Telephone Number + example: "62994842" FAX: type: string + description: Fax Number + example: "67467646" SIC: type: string + description: SIC Code + example: "2325" SIC_DESC: - type: string + type: string + description: SIC Description + example: "Men’s and Boys’ Separate Trousers and Slacks" LIST_BANKRUPTCY: type: array + description: |+ + Bankruptcy/ Winding up with following children: + [BANKRUPTCY] + example: |+ + + + + + + + + + + + + + + + + + + + + + + + + + + items: properties: BANKRUPTCY : type: object + description: |+ + Bankruptcy/Winding up detail with following children: + SUBJECT_NAME + COURT_CODE + CASE_CODE + CASE_YEAR + ACTION_DATE + BANKRUPTCY_ACT + HEARING_DATE + CURRENCY1 + AMOUNT1 + CURRENCY2 + AMOUNT2 + CURRENCY3 + AMOUNT3 + BANKRUPTCY_TYPE + [LIST_PLAINTIFF] + example: |+ + + + + + + + + + + + + + + + + + + + + + + + + properties: SUBJECT_NAME : type: string + description: Subject Name + example: COURT_CODE: type: string + description: Court Code + example: "CWU" CASE_CODE: type: string + description: Case Code + example: "381" CASE_YEAR: type: string + description: Case Year + example: "2000" ACTION_DATE: type: string + description: Action Date + example: "22/12/2000" BANKRUPTCY_ACT: type: string + description: Act of Bankruptcy + example: "Petition for Winding Up" HEARING_DATE : type: string + description: Hearing Date + example: "26/03/2009" CURRENCY1: type: string + description: Currency + example: AMOUNT1: type: string + description: Amount + example: "334,616.00" CURRENCY2: type: string + description: Currency + example: AMOUNT2: type: string + description: Amount + example: "0.00" CURRENCY3: - type: string + type: string + description: Currency + example: + AMOUNT3: + type: string + description: Amount + example: "0.00" BANKRUPTCY_TYPE: - type: string + type: string + description: Bankruptcy Type + example: "COMPANY WINDING UP PETITION" LIST_PLAINTIFF: type: array + description: |+ + List of Plaintiff with following children: + [PLAINTIFF] + example: |+ + + + + + + + + items: properties: PLAINTIFF: type: object + description: |+ + Plaintiff detail with following children: + PLA_NAME + PLA_SOLICITOR + PLA_SOLICITOR_ID + PLA_FILE_REF + example: |+ + + + + + + properties: PLA_NAME: type: string + description: Pla. Name + example: "B 2003 P1" PLA_SOLICITOR: type: string + description: Pla. Solicitor + example: "PATRICK KHOO ENG HOCK" PLA_SOLICITOR_ID: type: string + description: Pla. Solicitor ID + example: PLA_FILE_REF: - type: string + type: string + description: Pla. File Ref. + example: "RSP/292668/1" LIST_LIT: type: array + description: |+ + List of litigation with following children: + [LIT] + example: |+ + + + + + + + items: properties: LIT: type: object + description: |+ + Basic litigation info with following children: + SUBJECT_NAME + SEQ_NO + FORMATTED_ID + [LIST_LIT_DTL] + example: |+ + + + + + properties: SUBJECT_NAME: type: string + description: Name + example: "ENG YICK HOLDINGS PTE LTD" SEQ_NO: - type: string + type: integer + description: Sequence No. + example: 1 FORMATTED_ID: type: string + description: Formatted ID + example: "197803191K" LIST_LIT_DTL: type: array + description: |+ + List of litigation detail with following children: + [LIT_DTL] + example: |+ + + + + + + + + + + + + + + + + + + + + + + + + + + + - + - + S7250163B + + + + + + + + + - + - + S7250163B + + + + + + + + + + + + items: properties: LIT_DTL: type: object + description: |+ + Litigation detail with following children: + NATURE_OF_CLAIM + STATUS_DATE + CASE_NO + FORMATTED_ID + DOC_REMARKS + CURRENCY1 + CURRENCY2 + CURRENCY3 + CURRENCY4 + CURRENCY5 + CASE_STATUS + AMOUNT1 + AMOUNT2 + AMOUNT3 + AMOUNT4 + AMOUNT5 + [LIST_PLAINTIFF] + [LIST_DEFENDANT] + example: |+ + + + + + + + + + + + + + + + + + + + + + + + + + + - + - + S7250163B + + + + + + + + + - + - + S7250163B + + + + + + + + + + + properties: NATURE_OF_CLAIM: type: string + description: Nature of Claim + example: "CONTRACTS-WORK DONE & SERVICES RENDERED" STATUS_DATE: type: string + description: Status Date + example: "13/08/2001" CASE_NO: type: string + description: Case No. + example: "MC 23631 / 2001" FORMATTED_ID: type: string + description: Formatted ID + example: "197803191K" DOC_REMARKS: type: string + description: Document Remark + example: "WRIT OF SUMMONS" CURRENCY1: - type: string + type: string + description: Currency 1 + example: "SIN" CURRENCY2: type: string + description: Currency 2 + example: CURRENCY3: type: string + description: Currency 3 + example: CURRENCY4: - type: string + type: string + description: Currency 4 + example: CURRENCY5: type: string + description: Currency 5 + example: CASE_STATUS: type: string + description: Status + example: "PENDING AS AT STATUS DATE" AMOUNT1: - type: string + type: string + description: Amount 1 + example: "36,196.00" AMOUNT2: type: string + description: Amount 2 + example: "0.00" AMOUNT3: type: string + description: Amount 3 + example: "0.00" AMOUNT4: - type: string + type: string + description: Amount 4 + example: "0.00" AMOUNT5: - type: string + type: string + description: Amount 5 + example: "0.00" LIST_PLAINTIFF: type: array + description: |+ + List of plaintiff with following children: + [PLAINTIFF] + example: |+ + + + + + + + + + - + - + S7250163B + + items: properties: PLAINTIFF: type: object + description: |+ + Plaintiff detail with following children: + PLA_NAME + LAW_FIRM + WRITE_DATE + PLA_SOLICITOR + PLA_SOLICITOR_ID + PLA_FILE_REF + PLA_STATUS + PLA_STATUS_DATE + PLA_ID + example: |+ + + + + + + + + - + - + S7250163B + properties: PLA_NAME: type: string + description: Plaintiff Name + example: "ROTARY PILING PTE LTD" LAW_FIRM: type: string + description: Pla. Law Firm + example: "JOSEPH HOO MORRIS & KUMAR" WRITE_DATE: type: string + description: Writ date + example: "13/08/2001" PLA_SOLICITOR: - type: string + type: string + description: Plaintiff Solicitor + example: "HOO JOSEPH" PLA_SOLICITOR_ID: type: string + description: Plaintiff Solicitor ID + example: "ORS" PLA_FILE_REF: type: string + description: Pla. File Ref. + example: "CHH 6253 D27" PLA_STATUS: type: string + description: Plaintiff Status + example: PLA_STATUS_DATE: - type: string + type: string + description: Plaintiff Status Date + example: PLA_ID: - type: string + type: string + description: Plaintiff ID + example: "S7250163B" LIST_DEFENDANT: type: array + description: |+ + List of defendant with following children: + [DEFENDANT] + example: |+ + + + + + + + + items: properties: DEFENDANT: type: object + description: |+ + Defendant detail with following children: + DEF_SOLICITOR + DEF_SOLICITOR_ID + DEF_LAW_FIRM + DEF_FILE_REF + example: |+ + + + + + + properties: DEF_SOLICITOR: type: string + description: Def. Solicitor + example: DEF_SOLICITOR_ID: type: string + description: Def. Solicitor ID + example: N/A DEF_LAW_FIRM: type: string + description: Def. Law Firm + example: DEF_FILE_REF: type: string + description: Def. File Ref. + example: LIST_Ddrptcount: type: array + description: |+ + List of Search By Financial Sectors and Search By Non-Financial Sectors with following children: + [Ddrptcount] + example: |+ + + + 1 + 1 + 1 + 1 + 1 + 1 + 1 + 1 + 1 + 1 + 1 + 1 + 2017 + 1 + + items: properties: Ddrptcount: type: object + description: |+ + 6 XML tags (open then close) displays Search By Financial Sectors (counts for 3 recent years).Search By Non-Financial Sectors (counts for 3 recent years) with following children: + Rcjan + Rcfeb + Rcmar + Rcapr + Rcmay + Rcjun + Rcjul + Rcaug + Rcsep + Rcoct + Rcnov + Rcdec + Rcyear + Rcsecflag + example: |+ + + 1 + 1 + 1 + 1 + 1 + 1 + 1 + 1 + 1 + 1 + 1 + 1 + 2017 + 1 + properties: Rcjan: - type: number + type: integer + description: Count for January + example: "1" Rcfeb: - type: number + type: integer + description: Count for February + example: "1" Rcmar: - type: number + type: integer + description: Count for March + example: "1" Rcapr: - type: number + type: integer + description: Count for April + example: "1" Rcmay: - type: number + type: integer + description: Count for May + example: "1" Rcjun: - type: number + type: integer + description: Count for June + example: "1" Rcjul: - type: number + type: integer + description: Count for July + example: "1" Rcaug: - type: number + type: integer + description: Count for August + example: "1" Rcsep: - type: number + type: integer + description: Count for September + example: "1" Rcoct: - type: number + type: integer + description: Count for October + example: "1" Rcnov: - type: number + type: integer + description: Count for November + example: "1" Rcdec: - type: number + type: integer + description: Count for December + example: "1" Rcyear: - type: number + type: integer + description: To show the year + example: "1" Rcsecflag: - type: number + type: integer + description: Differentiate Search By Financial Sectors and Search By Non-Financial Sectors + example: "1" unauthorized: - type: array - items: - properties: - message: - type: string - example: Missing Authentication Token - status: - type: string - example: Failure + type: object + properties: + message: + type: string + example: Missing Authentication Token + status: + type: string + example: Failure forbidden: - type: array - items: - properties: - message: - type: string - example: Access Denied Unauthorized User - status: - type: string - example: Failure + type: object + properties: + message: + type: string + example: Access Denied Unauthorized User + status: + type: string + example: Failure paymentrequired: - type: array - items: - properties: - message: - type: string - example: Insufficient Credits Kindly Top Up - status: - type: string - example: Failure + type: object + properties: + message: + type: string + example: Insufficient Credits Kindly Top Up + status: + type: string + example: Failure notfound: - type: array - items: - properties: - message: - type: string - example: Invalid Request URL - status: - type: string - example: Failure + type: object + properties: + message: + type: string + example: Invalid Request URL + status: + type: string + example: Failure servererror: - type: array - items: - properties: - message: - type: string - example: Internal Server Error - status: - type: string - example: Failure + type: object + properties: + message: + type: string + example: Internal Server Error + status: + type: string + example: Failure gatewaytimeout: type: object properties: @@ -448,9 +1242,45 @@ components: status: type: string example: Failure + REQUEST: + type: object + properties: + TOT_ITEMS: + type: number + example: 1 + description: Number of subjects being enquired relating to the Run + default: false + ENQUIRY: + type: object + example: |+ + 197601887ETRANSTAR TRAVEL PTE LTD + description: Contains information of each request details + default: true + properties: + SUBJECT_IDNO: + type: string + example: 199707714C + description: "Subject’s ID Number (individual) or Registration Number (company/business) as captured in DDP" + default: true + SUBJECT_NAME: + type: string + example: GPS INDUSTRIES PTE LTD + description: Subjects Name as captured in DDP + default: false + versions: + type: object + properties: + v0.1: + type: array + items: + oneOf: + - type: string + example: Published Date - Jul 23, 2019 + description: Initial version release securitySchemes: APIAuthorizer: type: apiKey name: x-api-key in: header - x-amazon-apigateway-authtype: custom \ No newline at end of file + x-amazon-apigateway-authtype: custom + description: Authentication is done using the x-api-key in the request header diff --git a/yaml/BriefFinancialExtractionDun&Bradstreet(SG).yaml b/yaml/BriefFinancialExtractionDun&Bradstreet(SG).yaml index d77c87702..4d32f6888 100644 --- a/yaml/BriefFinancialExtractionDun&Bradstreet(SG).yaml +++ b/yaml/BriefFinancialExtractionDun&Bradstreet(SG).yaml @@ -1,7 +1,7 @@ openapi: 3.0.1 info: - title: Brief Financial Info Dun & Bradstreet (SG) - description: This Data microservice provides the annual financial information of the Singapore-registered business, inclusive of annual profit and loss and financial ratios. Updated daily.

Authentication:

Authentication is done using the x-api-key in the request header. + title: Brief Financial Extraction Dun & Bradstreet (SG) + description: This Data microservice provides the annual financial information of the Singapore-registered business, inclusive of annual profit and loss and financial ratios. Updated daily. version: '0.1' servers: - url: 'https://api.sentient.io' @@ -18,11 +18,7 @@ paths: content: application/xml: schema: - type: string - examples: - xml: - summary: A sample XML response - value: '1197803191K' + $ref: '#/components/schemas/REQUEST' responses: '200': description: success response @@ -30,6 +26,34 @@ paths: application/xml: schema: $ref: '#/components/schemas/success' + example: |+ + + 25/02/2009 17:31:44> + + + 2009-04-21 10:56:06.716 + 2004 2003 2002 2005 + 2006 2007 2008 2009 2008 2007 2006 2005 2004 + + 9403795.00 8617168.00 7807393.00 31467.00 162620.00 1281387.00 31467.00 162620.00 1281387.00 0.00 0.00 60318.00> 31467.00 162620.00 1341705.00 3889213.00 3395740.00 4374368.00 3359007.00 2855754.00 3546381.00 530206.00 539986.00 827987.00> 7370430.00 6845490.00 7661498.00 6739073.00 6157560.00 6435365.00 631357.00 687930.00 122133.00 -3481217.00 -3449750.00 -3287130.00 2000000.00 2000000.00 2000000.00 0.00 0.00 0.00 5481217.00 5449750.00 5287130.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 + 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 + + 10877254.00 9982533.00 1121483.00 262632.00 1347380.00 262632.00 6562990.00 5424551.00 6283449.00 4948821.00 279541.00 475730.00 8434195.00 8643136.00 8434195.00 7933013.00 0.00 710123.00 -1871205.00 -3218585.00 2000000.00 2000000.00 0.00 0.00 -3,871,205.00 -5,218,585.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 + 0.00 0.00 0.00 0.00 + + 12.39 2.63 0.00 0.00 0.00 20.53 4.84 0.00 0.00 0.00 -72.01 -8.16 -0.00 -0.00 -0.00 1.66 1.84 2.42 2.54 1.78 0.74 0.62 0.50 0.46 0.55 -28.51 -59.33 -89.51 -101.59 -75.15 128.51 168.27 189.51 201.59 175.15 + + 1121483.0 10877254 2008 + + 262632.0> 9982533 2007 + + -31467.0 9403795 2006 + + -162620.0 8617168 2005 + + -1281387.0 7807393 2004 + + '401': description: Unauthorized content: @@ -87,509 +111,1207 @@ components: properties: REPORT: type: object + description: |+ + Report details with following children: + [META_INFO] + [FH_SEARCH_INFO] + [FH_DTL] + [XBRL_DTL] + [FH_RATIO_DTL] + [LIST_FH_CHART_INFO] + example: properties: META_INFO: type: object + description: |+ + Meta Information details with following children: + SERVICE + SYSTEM_ID + CREATION_DATE + USER_ID + example: |+ + + + + 25/02/2009 17:31:44> + + properties: SERVICE: type: string - SYSTEM_ID : + description: Report Requested + example: "BFE" + SYSTEM_ID : type: string + description: System ID + example: "DDP" CREATION_DATE: type: string + description: Report Request Date + example: "25/02/2009 17:31:44" USER_ID : type: string + description: Valid user id in DDP system. It is for (For internal use) + example: N/A FH_SEARCH_INFO: type: object + description: |+ + FH search information with following children: + COMP_NAME + REG_NO + REQ_DATE + REQ_REG_NO + REQ_NAME + REQ_DATE_STR + FH_BEFORE_YR1 + FH_BEFORE_YR2 + FH_BEFORE_YR3 + FH_BEFORE_YR4 + FH_BEFORE_YR5 + FH_AFTER_YR1 + FH_AFTER_YR2 + FH_AFTER_YR3 + FH_AFTER_YR4 + FH_AFTER_YR5 + AC_RATIOS_YR1 + AC_RATIOS_YR2 + AC_RATIOS_YR3 + AC_RATIOS_YR4 + AC_RATIOS_YR5 + example: |+ + + + + 2009-04-21 10:56:06.716 + + + + 2004 + 2003 + 2002 + 2005 + 2006 + 2007 + 2008 + 2009 + 2008 + 2007 + 2006 + 2005 + 2004 + properties: COMP_NAME : type: string + description: Company Name + example: "DUN & BRADSTREET (SINGAPORE) PTE. LTD." REG_NO : type: string + description: Company Registration No + example: "200003058W" REQ_DATE : - type: string + type: datetime + description: Requested Date + example: "2009-04-21 10:56:06.716" REQ_REG_NO : type: string + description: Request Registration Number + example: "200003058W" REQ_NAME : type: string + description: Request Name + example: "DUN & BRADSTREET (SINGAPORE) PTE. LTD." REQ_DATE_STR : type: string + description: Request Date String + example: "21/04/2009 10:56:06" FH_BEFORE_YR1 : type: string + description: Financial Highlight filed before year 1 + example: "2004" FH_BEFORE_YR2 : type: string + description: Financial Highlight filed before year 2 + example: "2003" FH_BEFORE_YR3 : type: string + description: Financial Highlight filed before year 3 + example: "2002" FH_AFTER_YR1: - type: string + type: string + description: Financial Highlight filed after year 1 + example: "2005" FH_AFTER_YR2 : type: string + description: Financial Highlight filed after year 2 + example: "2006" FH_AFTER_YR3 : type: string + description: Financial Highlight filed after year 3 + example: "2007" FH_AFTER_YR4: type: string + description: Financial Highlight filed after year 4 + example: "2008" FH_AFTER_YR5: - type: string + type: string + description: Financial Highlight filed after year 5 + example: "2009" AC_RATIOS_YR1 : type: string + description: Account Ratio year 1 + example: "2008" AC_RATIOS_YR2 : type: string + description: Account Ratio year 2 + example: "2007" AC_RATIOS_YR3 : type: string + description: Account Ratio year 3 + example: "2006" AC_RATIOS_YR4 : type: string + description: Account Ratio year 4 + example: "2005" AC_RATIOS_YR5 : - type: string + type: string + description: Account Ratio year 5 + example: "2004" FH_DTL: type: object + description: |+ + Financial Highlight with following children: + FH_YR1_CURR + TURNOVER1 + PL_BEF_TAX1 + PL_AFT_TAX1 + NETINC_NON_EXT1 + PL_AFT_TAX_EXT1 + TOT_ASSETS1 + TA_CURRENT1 + TA_FIXED1 + TOT_LIABILITIES1 + TL_CURRENT1 + TL_NON_CURRENT1 + SH_FUNDS1 + SH_PAIDUP_CAPITAL1 + SH_RESERVES1 + SH_ACCUM_LOSS1 + GRP_TURNOVER1 + GRP_PL_BEF_TAX1 + GRP_PL_AFT_TAX1 + GRP_NETINC_NON_EXT1 + GRP_PL_AFT_TAX_EXT1 + GRP_TOT_ASSETS1 + GRP_TA_CURRENT1 + GRP_TA_FIXED1 + GRP_TOT_LIABILITIES1 + GRP_TL_CURRENT1 + GRP_TL_NON_CURRENT1 + GRP_SH_FUNDS1 + GRP_SH_PAIDUP_CAPITAL1 + GRP_SH_RESERVES1 + GRP_SH_ACCUM_LOSS1 + GRP_INDICATOR1 + + Note: Each tag will consist of maximum 5 sets with suffix 1 to 5. But it is optional, depending on how many years of FH data displayed in the report. + example: |+ + + + + + 9403795.00 + 8617168.00 + 7807393.00 + 31467.00 + 162620.00 + 1281387.00 + 31467.00 + 162620.00 + 1281387.00 + 0.00 + 0.00 + 60318.00> + 31467.00 + 162620.00 + 1341705.00 + 3889213.00 + 3395740.00 + 4374368.00 + 3359007.00 + 2855754.00 + 3546381.00 + 530206.00 + 539986.00 + 827987.00> + 7370430.00 + 6845490.00 + 7661498.00 + 6739073.00 + 6157560.00 + 6435365.00 + 631357.00 + 687930.00 + 122133.00 + -3481217.00 + -3449750.00 + -3287130.00 + 2000000.00 + 2000000.00 + 2000000.00 + 0.00 + 0.00 + 0.00 + 5481217.00 + 5449750.00 + 5287130.00 + 0.00 + 0.00 + 0.00 + 0.00 + 0.00 + 0.00 + 0.00 + 0.00 + 0.00 + 0.00 + 0.00 + 0.00 + 0.00 + 0.00 + 0.00 + 0.00 + 0.00 + 0.00 + 0.00 + 0.00 + 0.00 + 0.00 + 0.00 + 0.00 + 0.00 + 0.00 + 0.00 + 0.00 + 0.00 + 0.00 + 0.00 + 0.00 + 0.00 + 0.00 + 0.00 + 0.00 + 0.00 + 0.00 + 0.00 + 0.00 + 0.00 + 0.00 + 0.00 + 0.00 + 0.00 + + + + properties: FH_YR1_CURR : type: string - FH_YR2_CURR : - type: string - FH_YR3_CURR : - type: string + description: |+ + FH Before Year 1 Currency + Subsequent Years: + FH_YR2_CURR + FH_YR3_CURR + FH_YR4_CURR + FH_YR5_CURR + example: "(SGD)" TURNOVER1 : type: string - TURNOVER2: - type: string - TURNOVER3 : - type: string + description: |+ + Turnover / Sales And Other Operating Revenues + Subsequent Years: + TURNOVER2 + TURNOVER3 + TURNOVER4 + TURNOVER5 + example: "9403795.00" PL_BEF_TAX1 : type: string - PL_BEF_TAX2 : - type: string - PL_BEF_TAX3 : - type: string + description: |+ + Profit / Loss Before Tax + Subsequent Years: + PL_BEF_TAX2 + PL_BEF_TAX3 + PL_BEF_TAX4 + PL_BEF_TAX5 + example: "31467.00" PL_AFT_TAX1: - type: string - PL_AFT_TAX2 : - type: string - PL_AFT_TAX3 : - type: string + type: string + description: |+ + Profit / Loss After Tax + Subsequent Years: + PL_AFT_TAX2 + PL_AFT_TAX3 + PL_AFT_TAX4 + PL_AFT_TAX5 + example: "31467.00" NETINC_NON_EXT1: type: string - NETINC_NON_EXT2: - type: string - NETINC_NON_EXT3 : - type: string + description: |+ + Net Income / Loss From Extraordinary And Non- Operating Items + Subsequent Years: + NETINC_NON_EXT2 + NETINC_NON_EXT3 + NETINC_NON_EXT4 + NETINC_NON_EXT5 + example: "0.00" PL_AFT_TAX_EXT1 : type: string - PL_AFT_TAX_EXT2 : - type: string - PL_AFT_TAX_EXT3 : - type: string + description: |+ + Profit / Loss After Tax and Extraordinary Items + Subsequent Years: + PL_AFT_TAX_EXT2 + PL_AFT_TAX_EXT3 + PL_AFT_TAX_EXT4 + PL_AFT_TAX_EXT5 + example: "31467.00" TOT_ASSETS1 : - type: string - TOT_ASSETS2 : - type: string - TOT_ASSETS3: type: string + description: |+ + Total Assets + Subsequent Years: + TOT_ASSETS2 + TOT_ASSETS3 + TOT_ASSETS4 + TOT_ASSETS5 + example: "3889213.00" TA_CURRENT1 : - type: string - TA_CURRENT2 : - type: string - TA_CURRENT3 : - type: string + type: string + description: |+ + Total Assets - Current + Subsequent Years: + TA_CURRENT2 + TA_CURRENT3 + TA_CURRENT4 + TA_CURRENT5 + example: "3359007.00" TA_FIXED1 : type: string - TA_FIXED2: - type: string - TA_FIXED3 : - type: string + description: |+ + Total Assets – Fixed and Others + Subsequent Years: + TA_FIXED2 + TA_FIXED3 + TA_FIXED4 + TA_FIXED5 + example: "530206.00" TOT_LIABILITIES1 : type: string - TOT_LIABILITIES2: - type: string - TOT_LIABILITIES3: - type: string + description: |+ + Total Liabilities + Subsequent Years: + TOT_LIABILITIES2 + TOT_LIABILITIES3 + TOT_LIABILITIES4 + TOT_LIABILITIES5 + example: "7370430.00" TL_CURRENT1 : type: string - TL_CURRENT2 : - type: string - TL_CURRENT3 : - type: string + description: |+ + Total Liabilities - Current + Subsequent Years: + TL_CURRENT2 + TL_CURRENT3 + TL_CURRENT4 + TL_CURRENT5 + example: "6739073.00" TL_NON_CURRENT1 : type: string - TL_NON_CURRENT2 : - type: string - TL_NON_CURRENT3 : - type: string + description: |+ + Total Liabilities – Non- Current & Long Term + Subsequent Years: + TL_NON_CURRENT2 + TL_NON_CURRENT3 + TL_NON_CURRENT4 + TL_NON_CURRENT5 + example: "631357.00" SH_FUNDS1: type: string - SH_FUNDS2 : - type: string - SH_FUNDS3 : - type: string + description: |+ + Shareholder’s Fund + Subsequent Years: + SH_FUNDS2 + SH_FUNDS3 + SH_FUNDS4 + SH_FUNDS5 + example: "-3481217.00" SH_PAIDUP_CAPITAL1 : type: string - SH_PAIDUP_CAPITAL2 : - type: string - SH_PAIDUP_CAPITAL3: - type: string + description: |+ + Shareholder’s Fund – Paid Up Capital + Subsequent Years: + SH_PAIDUP_CAPITAL2 + SH_PAIDUP_CAPITAL3 + SH_PAIDUP_CAPITAL4 + SH_PAIDUP_CAPITAL5 + example: "2000000.00" SH_RESERVES1 : type: string - SH_RESERVES2 : - type: string - SH_RESERVES3: - type: string + description: |+ + Shareholder’s Fund - Reserves + Subsequent Years: + SH_RESERVES2 + SH_RESERVES3 + SH_RESERVES4 + SH_RESERVES5 + example: "0.00" SH_ACCUM_LOSS1: - type: string - SH_ACCUM_LOSS2 : - type: string - SH_ACCUM_LOSS3 : type: string + description: |+ + Shareholder’s Fund – Accumulated Loss + Subsequent Years: + SH_ACCUM_LOSS2 + SH_ACCUM_LOSS3 + SH_ACCUM_LOSS4 + SH_ACCUM_LOSS5 + example: "5481217.00" GRP_TURNOVER1 : type: string - GRP_TURNOVER2 : - type: string - GRP_TURNOVER3 : - type: string + description: |+ + Group Turnover / Sales and Other Operating Revenues + Subsequent Years: + GRP_TURNOVER2 + GRP_TURNOVER3 + GRP_TURNOVER4 + GRP_TURNOVER5 + example: "0.00" GRP_PL_BEF_TAX1 : type: string - GRP_PL_BEF_TAX2 : - type: string - GRP_PL_BEF_TAX3 : - type: string + description: |+ + Group Profit / Loss Before Tax + Subsequent Years: + GRP_PL_BEF_TAX2 + GRP_PL_BEF_TAX3 + GRP_PL_BEF_TAX4 + GRP_PL_BEF_TAX5 + example: "0.00" GRP_PL_AFT_TAX1 : type: string - GRP_PL_AFT_TAX2: - type: string - GRP_PL_AFT_TAX3 : - type: string + description: |+ + Group Profit / Loss After Tax + Subsequent Years: + GRP_PL_AFT_TAX2 + GRP_PL_AFT_TAX3 + GRP_PL_AFT_TAX4 + GRP_PL_AFT_TAX5 + example: "0.00" GRP_NETINC_NON_EXT1 : type: string - GRP_NETINC_NON_EXT2 : - type: string - GRP_NETINC_NON_EXT3 : - type: string + description: |+ + Group Net Income / Loss From Extraordinary and Non-Operating Items + Subsequent Years: + GRP_NETINC_NON_EXT2 + GRP_NETINC_NON_EXT3 + GRP_NETINC_NON_EXT4 + GRP_NETINC_NON_EXT5 + example: "0.00" GRP_PL_AFT_TAX_EXT1: - type: string - GRP_PL_AFT_TAX_EXT2 : - type: string - GRP_PL_AFT_TAX_EXT3 : type: string + description: |+ + Group Profit / Loss After Tax and Extraordinary items + Subsequent Years: + GRP_ PL_AFT_TAX_EXT2 + GRP_ PL_AFT_TAX_EXT3 + GRP_ PL_AFT_TAX_EXT4 + GRP_ PL_AFT_TAX_EXT5 + example: "0.00" GRP_TOT_ASSETS1: type: string - GRP_TOT_ASSETS2: - type: string - GRP_TOT_ASSETS3 : - type: string + description: |+ + Group Total Assets + Subsequent Years: + GRP_TOT_ASSETS2 + GRP_TOT_ASSETS3 + GRP_TOT_ASSETS4 + GRP_TOT_ASSETS5 + example: "0.00" GRP_TA_CURRENT1 : type: string - GRP_TA_CURRENT2 : - type: string - GRP_TA_CURRENT3 : - type: string + description: |+ + Group Total Assets – Current + Subsequent Years: + GRP_TA_CURRENT2 + GRP_TA_CURRENT3 + GRP_TA_CURRENT4 + GRP_TA_CURRENT5 + example: "0.00" GRP_TA_FIXED1 : - type: string - GRP_TA_FIXED2 : - type: string - GRP_TA_FIXED3: type: string + description: |+ + Group Total Assets – Fixed and Others + Subsequent Years: + GRP_TA_FIXED2 + GRP_TA_FIXED3 + GRP_TA_FIXED4 + GRP_TA_FIXED5 + example: "0.00" GRP_TOT_LIABILITIES1 : - type: string - GRP_TOT_LIABILITIES2 : - type: string - GRP_TOT_LIABILITIES3 : type: string + description: |+ + Group Total Liabilities + Subsequent Years: + GRP_TOT_LIABILITIES2 + GRP_TOT_LIABILITIES3 + GRP_TOT_LIABILITIES4 + GRP_TOT_LIABILITIES5 + example: "0.00" GRP_TL_CURRENT1 : type: string - GRP_TL_CURRENT2: - type: string - GRP_TL_CURRENT3 : - type: string + description: |+ + Group Total Liabilities - Current + Subsequent Years: + GRP_TL_CURRENT2 + GRP_TL_CURRENT3 + GRP_TL_CURRENT4 + GRP_TL_CURRENT5 + example: "0.00" GRP_TL_NON_CURRENT1 : type: string - GRP_TL_NON_CURRENT2: - type: string - GRP_TL_NON_CURRENT3: - type: string + description: |+ + Group Total Liabilities – Non-Current & Long Term + Subsequent Years: + GRP_TL_NON_CURRENT2 + GRP_TL_NON_CURRENT3 + GRP_TL_NON_CURRENT4 + GRP_TL_NON_CURRENT5 + example: "0.00" GRP_SH_FUNDS1 : type: string - GRP_SH_FUNDS2 : - type: string - GRP_SH_FUNDS3 : - type: string + description: |+ + Group Shareholder’s Fund + Subsequent Years: + GRP_ SH_FUNDS2 + GRP_ SH_FUNDS3 + GRP_ SH_FUNDS4 + GRP_ SH_FUNDS5 + example: "0.00" GRP_SH_PAIDUP_CAPITAL1 : - type: string - GRP_SH_PAIDUP_CAPITAL2 : - type: string - GRP_SH_PAIDUP_CAPITAL3 : type: string + description: |+ + Group Shareholder’s Fund – Paid Up Capital + Subsequent Years: + GRP_SH_PAIDUP_CAPITAL2 + GRP_SH_PAIDUP_CAPITAL3 + GRP_SH_PAIDUP_CAPITAL4 + GRP_SH_PAIDUP_CAPITAL5 + example: "0.00" GRP_SH_RESERVES1: type: string - GRP_SH_RESERVES2 : - type: string - GRP_SH_RESERVES3 : - type: string + description: |+ + Group Shareholder’s Fund - Reserves + Subsequent Years: + GRP_SH_RESERVES2 + GRP_SH_RESERVES3 + GRP_SH_RESERVES4 + GRP_SH_RESERVES5 + example: "0.00" GRP_SH_ACCUM_LOSS1 : type: string - GRP_SH_ACCUM_LOSS2 : - type: string - GRP_SH_ACCUM_LOSS3: - type: string + description: |+ + Group Shareholder’s Fund – Accumulated Loss + Subsequent Years: + GRP_SH_ACCUM_LOSS2 + GRP_SH_ACCUM_LOSS3 + GRP_SH_ACCUM_LOSS4 + GRP_SH_ACCUM_LOSS5 + example: "0.00" GRP_INDICATOR1 : type: string - GRP_INDICATOR2 : - type: string - GRP_INDICATOR3: - type: string + description: |+ + Company Financial Highlights Group Indicator + Subsequent Years: + GRP_INDICATOR2 + GRP_INDICATOR3 + GRP_INDICATOR4 + GRP_INDICATOR5 + example: "B" XBRL_DTL: type: object + description: |+ + XBRL filed after 1 Nov 2007 with following children: + XBRL_YR1_CURR + REVENUE1 + PL_BEF_TAX1 + PL_AFT_TAX1 + TOT_ASSETS1 + TA_CURRENT1 + TA_NON_CURRENT1 + TOT_LIABILITIES1 + TL_CURRENT1 + TL_NON_CURRENT1 + TOT_EQUITY1 + EQ_SH_CAPITAL1 + EQ_RESERVES1 + EQ_RETAINED_EARN1 + GRP_REVENUE1 + GRP_PL_BEF_TAX1 + GRP_PL_AFT_TAX1 + GRP_TOT_ASSETS1 + GRP_TA_CURRENT1 + GRP_TA_NON_CURRENT1 + GRP_TOT_LIABILITIES1 + GRP_TL_CURRENT1 + GRP_TL_NON_CURRENT1 + GRP_TOT_EQUITY1 + GRP_SH_CAPITAL1 + GRP_RESERVES1 + GRP_RETAINED_EARN1 + GRP_INDICATOR1 + + Note: Each tag will consist of maximum 5 sets with suffix 1 to 5. But it is optional, depending on how many years of XBRL data displayed in the report. + example: |+ + + + + 10877254.00 + 9982533.00 + 1121483.00 + 262632.00 + 1347380.00 + 262632.00 + 6562990.00 + 5424551.00 + 6283449.00 + 4948821.00 + 279541.00 + 475730.00 + 8434195.00 + 8643136.00 + 8434195.00 + 7933013.00 + 0.00 + 710123.00 + -1871205.00 + -3218585.00 + 2000000.00 + 2000000.00 + 0.00 + 0.00 + -3,871,205.00 + -5,218,585.00 + 0.00 + 0.00 + 0.00 + 0.00 + 0.00 + 0.00 + 0.00 + 0.00 + 0.00 + 0.00 + 0.00 + 0.00 + 0.00 + 0.00 + 0.00 + 0.00 + 0.00 + 0.00 + 0.00 + 0.00 + 0.00 + 0.00 + 0.00 + 0.00 + 0.00 + 0.00 + + + + properties: - XBRL_YR1_CURR : - type: string - XBRL_YR2_CURR : - type: string + XBRL_YR1_CURR: + type: string + description: |+ + FH After Year 1 Currency + Subsequent Years: + XBRL_YR2_CURR + XBRL_YR3_CURR + XBRL_YR4_CURR + XBRL_YR5_CURR + example: "(SGD)" REVENUE1 : type: string - REVENUE2 : - type: string - PL_BEF_TAX1: + description: |+ + Revenue Amount + Subsequent Years: + REVENUE2 + REVENUE3 + REVENUE4 + REVENUE5 + example: "10877254.00" + PL_BEF_TAX1 : type: string - PL_BEF_TAX2 : - type: string + description: |+ + Profit / Loss Before Tax from Continuing Operations + Subsequent Years: + PL_BEF_TAX2 + PL_BEF_TAX3 + PL_BEF_TAX4 + PL_BEF_TAX5 + example: "1121483.00" PL_AFT_TAX1 : type: string - PL_AFT_TAX2 : - type: string - PL_BEF_TAX3 : - type: string - TOT_ASSETS1: - type: string - TOT_ASSETS2 : + description: |+ + Profit / Loss After Tax from Continuing Operations + Subsequent Years: + PL_AFT_TAX2 + PL_AFT_TAX3 + PL_AFT_TAX4 + PL_AFT_TAX5 + example: "1347380.00" + TOT_ASSETS1 : type: string + description: |+ + Total Assets + Subsequent Years: + TOT_ASSETS2 + TOT_ASSETS3 + TOT_ASSETS4 + TOT_ASSETS5 + example: "6562990.00" TA_CURRENT1 : type: string - TA_CURRENT2: - type: string - TA_NON_CURRENT1: - type: string - TA_NON_CURRENT2 : - type: string + description: |+ + Total Current Assets (Only for Balance Sheet by Current / Non-Current) + Subsequent Years: + TA_CURRENT2 + TA_CURRENT3 + TA_CURRENT4 + TA_CURRENT5 + example: "6283449.00" + TA_NON_CURRENT1 : + type: string + description: |+ + Total Non-Current Assets (Only for Balance Sheet by Current / Non-Current) + Subsequent Years: + TA_NON_CURRENT2 + TA_NON_CURRENT3 + TA_NON_CURRENT4 + TA_NON_CURRENT5 + example: "279541.00" TOT_LIABILITIES1 : type: string - TOT_LIABILITIES2 : - type: string + description: |+ + Total Liabilities + Subsequent Years: + TOT_LIABILITIES2 + TOT_LIABILITIES3 + TOT_LIABILITIES4 + TOT_LIABILITIES5 + example: "8434195.00" TL_CURRENT1 : - type: string - TL_CURRENT2 : - type: string - TL_NON_CURRENT1 : type: string - TL_NON_CURRENT2: + description: |+ + Total Current Liabilities (Only for Balance Sheet by Current / Non-Current) + Subsequent Years: + TL_CURRENT2 + TL_CURRENT3 + TL_CURRENT4 + TL_CURRENT5 + example: "8434195.00" + TL_NON_CURRENT1 : type: string + description: |+ + Total Non-Current Liabilities (Only for Balance Sheet by Current / Non- Current) + Subsequent Years: + TL_NON_CURRENT2 + TL_NON_CURRENT3 + TL_NON_CURRENT4 + TL_NON_CURRENT5 + example: "0.00" TOT_EQUITY1 : - type: string - TOT_EQUITY2 : type: string + description: |+ + Total Equity (inclusive of Equity Attributable to Equity Holders of Parent and Minority Interest) + Subsequent Years: + TOT_EQUITY2 + TOT_EQUITY3 + TOT_EQUITY4 + TOT_EQUITY5 + example: "-1871205.00" EQ_SH_CAPITAL1 : type: string - EQ_SH_CAPITAL2 : - type: string - EQ_RESERVES1: - type: string - EQ_RESERVES2 : - type: string + description: |+ + Total Equity – Share Capital + Subsequent Years: + EQ_SH_CAPITAL2 + EQ_SH_CAPITAL3 + EQ_SH_CAPITAL4 + EQ_SH_CAPITAL5 + example: "2000000.00" + EQ_RESERVES1 : + type: string + description: |+ + Total Equity – Other Reserves + Subsequent Years: + EQ_RESERVES2 + EQ_RESERVES3 + EQ_RESERVES4 + EQ_RESERVES5 + example: "0.00" EQ_RETAINED_EARN1 : type: string - EQ_RETAINED_EARN2: - type: string - GRP_REVENUE1: - type: string - GRP_REVENUE2 : - type: string + description: |+ + Total Equity – Retained Earnings (Accumulated Loss) + Subsequent Years: + EQ_RETAINED_EARN2 + EQ_RETAINED_EARN3 + EQ_RETAINED_EARN4 + EQ_RETAINED_EARN5 + example: "-3,871,205.00" + GRP_REVENUE1 : + type: string + description: |+ + Group’s Revenue Amount + Subsequent Years: + GRP_REVENUE2 + GRP_REVENUE3 + GRP_REVENUE4 + GRP_REVENUE5 + example: "0.00" GRP_PL_BEF_TAX1 : type: string - GRP_PL_BEF_TAX2 : - type: string + description: |+ + Group Profit / Loss Before Tax from Continuing Operations + Subsequent Years: + GRP_PL_BEF_TAX2 + GRP_PL_BEF_TAX3 + GRP_PL_BEF_TAX4 + GRP_PL_BEF_TAX5 + example: "0.00" GRP_PL_AFT_TAX1 : - type: string - GRP_PL_AFT_TAX2 : - type: string - GRP_TOT_ASSETS1 : type: string - GRP_TOT_ASSETS2: + description: |+ + Group Profit / Loss After Tax from Continuing Operations + Subsequent Years: + GRP_PL_AFT_TAX2 + GRP_PL_AFT_TAX3 + GRP_PL_AFT_TAX4 + GRP_PL_AFT_TAX5 + example: "0.00" + GRP_TOT_ASSETS1 : type: string + description: |+ + Group’s Total Assets + Subsequent Years: + GRP_TOT_ASSETS2 + GRP_TOT_ASSETS3 + GRP_TOT_ASSETS4 + GRP_TOT_ASSETS5 + example: "0.00" GRP_TA_CURRENT1 : - type: string - GRP_TA_CURRENT2 : type: string + description: |+ + Group’s Total Current Assets (Only for Balance Sheet by Current / Non- Current) + Subsequent Years: + GRP_TA_CURRENT2 + GRP_TA_CURRENT3 + GRP_TA_CURRENT4 + GRP_TA_CURRENT4 + example: "0.00" GRP_TA_NON_CURRENT1 : type: string - GRP_TA_NON_CURRENT2 : - type: string - GRP_TOT_LIABILITIES1: - type: string - GRP_TOT_LIABILITIES2 : + description: |+ + Group’s Total Non-Current Assets (Only for Balance Sheet by Current / Non- Current) + Subsequent Years: + GRP_TA_NON_CURRENT2 + GRP_TA_NON_CURRENT3 + GRP_TA_NON_CURRENT4 + GRP_TA_NON_CURRENT4 + example: "0.00" + GRP_TOT_LIABILITIES1 : type: string + description: |+ + Group’s Total Liabilities + Subsequent Years: + GRP_TOT_LIABILITIES2 + GRP_TOT_LIABILITIES3 + GRP_TOT_LIABILITIES4 + GRP_TOT_LIABILITIES5 + example: "0.00" GRP_TL_CURRENT1 : type: string - GRP_TL_CURRENT2: - type: string - GRP_TL_NON_CURRENT1: - type: string - GRP_TL_NON_CURRENT2 : + description: |+ + Group’s Total Current Liabilities (Only for Balance Sheet by Current / Non- Current) + Subsequent Years: + GRP_TL_CURRENT2 + GRP_TL_CURRENT3 + GRP_TL_CURRENT4 + GRP_TL_CURRENT5 + example: "0.00" + GRP_TL_NON_CURRENT1 : type: string + description: |+ + Group’s Total Non-Current Liabilities (Only for Balance Sheet by Current / Non- Current) + Subsequent Years: + GRP_TL_NON_CURRENT2 + GRP_TL_NON_CURRENT3 + GRP_TL_NON_CURRENT4 + GRP_TL_NON_CURRENT5 + example: "0.00" GRP_TOT_EQUITY1 : type: string - GRP_TOT_EQUITY2 : - type: string + description: |+ + Group’s Total Equity (inclusive of Equity Attributable to Equity Holders of Parent and Minority Interest) + Subsequent Years: + GRP_TOT_EQUITY2 + GRP_TOT_EQUITY3 + GRP_TOT_EQUITY4 + GRP_TOT_EQUITY5 + example: "0.00" GRP_SH_CAPITAL1 : - type: string - GRP_SH_CAPITAL2 : - type: string - GRP_RESERVES1 : type: string - GRP_RESERVES2 : + description: |+ + Group’s Share Capital + Subsequent Years: + GRP_SH_CAPITAL2 + GRP_SH_CAPITAL3 + GRP_SH_CAPITAL4 + GRP_SH_CAPITAL5 + example: "0.00" + GRP_RESERVES1 : type: string + description: |+ + Group’s Other Reserves + Subsequent Years: + GRP_RESERVES2 + GRP_RESERVES3 + GRP_RESERVES4 + GRP_RESERVES5 + example: "0.00" GRP_RETAINED_EARN1 : type: string - GRP_RETAINED_EARN2 : - type: string - GRP_INDICATOR1: - type: string - GRP_INDICATOR2 : - type: string - GRP_INDICATOR3 : + description: |+ + Group’s – Retained Earnings (Accumulated Loss) + Subsequent Years: + GRP_RETAINED_EARN2 + GRP_RETAINED_EARN3 + GRP_RETAINED_EARN4 + GRP_RETAINED_EARN5 + example: "0.00" + GRP_INDICATOR1 : type: string + description: |+ + XBRL Financial Highlights Group Indicator + Subsequent Years: + GRP_INDICATOR2 + GRP_INDICATOR3 + GRP_INDICATOR4 + GRP_INDICATOR5 + example: "B" FH_RATIOS_DTL: type: object + description: |+ + Accounting Ratios Details with following children: + RATE_NET_PROFIT1 + RET_INVESTMENT1 + RET_SH_FUNDS1 + TOT_ASSETS_TURNOVER1 + CURR_CAPITAL_RATIO1 + PROPRIETARY_RATIO1 + TOTAL_DEBT_RATIO1 + + Note: Each tag will consist of maximum 5 sets with suffix 1 to 5. But it is optional, depending on how many years of FH & XBRL data displayed in the report. + example: |+ + + 12.39 + 2.63 + 0.00 + 0.00 + 0.00 + 20.53 + 4.84 + 0.00 + 0.00 + 0.00 + -72.01 + -8.16 + -0.00 + -0.00 + -0.00 + 1.66 + 1.84 + 2.42 + 2.54 + 1.78 + 0.74 + 0.62 + 0.50 + 0.46 + 0.55 + -28.51 + -59.33 + -89.51 + -101.59 + -75.15 + 128.51 + 168.27 + 189.51 + 201.59 + 175.15 + properties: RATE_NET_PROFIT1 : type: string - RATE_NET_PROFIT2 : - type: string - RATE_NET_PROFIT3 : - type: string - RATE_NET_PROFIT4 : - type: string - RATE_NET_PROFIT5: - type: string + description: |+ + Rate of Net Profit On Sales (%) + Subsequent Years: + RATE_NET_PROFIT2 + RATE_NET_PROFIT3 + RATE_NET_PROFIT4 + RATE_NET_PROFIT5 + example: "12.39" RET_INVESTMENT1 : - type: string - RET_INVESTMENT2 : - type: string - RET_INVESTMENT3 : - type: string - RET_INVESTMENT4 : - type: string - RET_INVESTMENT5: type: string + description: |+ + Return of Investment (%) + Subsequent Years: + RET_INVESTMENT2 + RET_INVESTMENT3 + RET_INVESTMENT4 + RET_INVESTMENT5 + example: "20.53" RET_SH_FUNDS1 : type: string - RET_SH_FUNDS2 : - type: string - RET_SH_FUNDS3: - type: string - RET_SH_FUNDS4: - type: string - RET_SH_FUNDS5 : - type: string + description: |+ + Return of Shareholder’s Funds (%) + Subsequent Years: + RET_SH_FUNDS2 + RET_SH_FUNDS3 + RET_SH_FUNDS4 + RET_SH_FUNDS4 + example: "-72.01" TOT_ASSETS_TURNOVER1 : type: string - TOT_ASSETS_TURNOVER2 : - type: string - TOT_ASSETS_TURNOVER3 : - type: string - TOT_ASSETS_TURNOVER4 : - type: string - TOT_ASSETS_TURNOVER5 : - type: string + description: |+ + Total Assets Turnover (%) + Subsequent Years: + TOT_ASSETS_TURNOVER2 + TOT_ASSETS_TURNOVER3 + TOT_ASSETS_TURNOVER4 + TOT_ASSETS_TURNOVER5 + example: "1.66" CURR_CAPITAL_RATIO1: type: string - CURR_CAPITAL_RATIO2 : - type: string - CURR_CAPITAL_RATIO3 : - type: string - CURR_CAPITAL_RATIO4 : - type: string - CURR_CAPITAL_RATIO5 : - type: string + description: |+ + Current / Working Capital Ratio (%) + Subsequent Years: + CURR_CAPITAL_RATIO2 + CURR_CAPITAL_RATIO3 + CURR_CAPITAL_RATIO4 + CURR_CAPITAL_RATIO5 + example: "0.74" PROPRIETARY_RATIO1: - type: string - PROPRIETARY_RATIO2 : - type: string - PROPRIETARY_RATIO3 : type: string - PROPRIETARY_RATIO4: - type: string - PROPRIETARY_RATIO5: - type: string + description: |+ + Proprietary Ratio (%) 1 + Subsequent Years: + PROPRIETARY_RATIO2 + PROPRIETARY_RATIO3 + PROPRIETARY_RATIO4 + PROPRIETARY_RATIO5 + example: "-28.51" TOTAL_DEBT_RATIO1 : type: string - TOTAL_DEBT_RATIO2 : - type: string - TOTAL_DEBT_RATIO3 : - type: string - TOTAL_DEBT_RATIO4 : - type: string - TOTAL_DEBT_RATIO5 : - type: string + description: |+ + Total Debt to Equity Ratio (%) 1 + Subsequent Years: + TOTAL_DEBT_RATIO2 + TOTAL_DEBT_RATIO3 + TOTAL_DEBT_RATIO4 + TOTAL_DEBT_RATIO5 + example: "128.51" LIST_FH_CHART_INFO : type: array + example: |+ + + + 1121483.0 + 10877254 + 2008 + + + description: |+ + List of chart info with following children: + [FH_CHART_INFO] items: properties: FH_CHART_INFO: type: object + description: |+ + Chart Info info with following children: + YEAR + REVENUE + PROFIT_LOSS properties: PROFIT_LOSS: type: string + example: "1121483.0" + description: Profit / Loss Before Tax of the year REVENUE: type: string + example: "10877254" + description: Revenue Amount of the year YEAR: type: string + example: "2008" + description: Financial Year unauthorized: - type: array - items: - properties: - message: - type: string - example: Missing Authentication Token - status: - type: string - example: Failure + type: object + properties: + message: + type: string + example: Missing Authentication Token + status: + type: string + example: Failure forbidden: - type: array - items: - properties: - message: - type: string - example: Access Denied Unauthorized User - status: - type: string - example: Failure + type: object + properties: + message: + type: string + example: Access Denied Unauthorized User + status: + type: string + example: Failure paymentrequired: - type: array - items: - properties: - message: - type: string - example: Insufficient Credits Kindly Top Up - status: - type: string - example: Failure + type: object + properties: + message: + type: string + example: Insufficient Credits Kindly Top Up + status: + type: string + example: Failure notfound: - type: array - items: - properties: - message: - type: string - example: Invalid Request URL - status: - type: string - example: Failure + type: object + properties: + message: + type: string + example: Invalid Request URL + status: + type: string + example: Failure servererror: - type: array - items: - properties: - message: - type: string - example: Internal Server Error - status: - type: string - example: Failure + type: object + properties: + message: + type: string + example: Internal Server Error + status: + type: string + example: Failure gatewaytimeout: type: object properties: @@ -617,9 +1339,45 @@ components: status: type: string example: Failure + REQUEST: + type: object + properties: + TOT_ITEMS: + type: number + example: 1 + description: Number of subjects being enquired relating to the Run + default: false + ENQUIRY: + type: object + example: |+ + 197601887ETRANSTAR TRAVEL PTE LTD + description: Contains information of each request details + default: true + properties: + SUBJECT_IDNO: + type: string + example: 199707714C + description: "Subject’s ID Number (individual) or Registration Number (company/business) as captured in DDP" + default: true + SUBJECT_NAME: + type: string + example: GPS INDUSTRIES PTE LTD + description: Subjects Name as captured in DDP + default: false + versions: + type: object + properties: + v0.1: + type: array + items: + oneOf: + - type: string + example: Published Date - Jul 23, 2019 + description: Initial version release securitySchemes: APIAuthorizer: type: apiKey name: x-api-key in: header - x-amazon-apigateway-authtype: custom \ No newline at end of file + x-amazon-apigateway-authtype: custom + description: Authentication is done using the x-api-key in the request header diff --git a/yaml/BusinessCheckDun&Bradstreet(SG).yaml b/yaml/BusinessCheckDun&Bradstreet(SG).yaml index 1cc4e01d1..1d8950c0c 100644 --- a/yaml/BusinessCheckDun&Bradstreet(SG).yaml +++ b/yaml/BusinessCheckDun&Bradstreet(SG).yaml @@ -1,7 +1,8 @@ openapi: 3.0.1 info: title: Business Check Dun & Bradstreet (SG) - description: This Data microservice provides key business information of a Singapore-registered company includes the business name, registration number, registered address and date of change, company status, registered activities, shareholders details (i.e. date of commencement, residing address) capital amount and shares allocated to each shareholders. Updated daily.

Authentication:

Authentication is done using the x-api-key in the request header.

+ description: |+ + This Data microservice provides key business information of a Singapore-registered company includes the business name, registration number, registered address and date of change, company status, registered activities, shareholders details (i.e. date of commencement, residing address) capital amount and shares allocated to each shareholders. Updated daily. version: '0.1' servers: - url: 'https://api.sentient.io' @@ -18,7 +19,7 @@ paths: content: application/xml: schema: - $ref: '#/components/schemas/success' + $ref: '#/components/schemas/REQUEST' responses: '200': description: success response @@ -27,144 +28,11 @@ paths: schema: $ref: '#/components/schemas/success' example: |+ - - - - - string - string - string - string - string - - - string - string - string - string - string - string - - - string - string - string - string - string - string - string - string - string - string - string - string - string - string - string - string - string - string - string - string - string - string - string - string - - - string - string - - - - string - string - string - - - - - string - string - string - string - string - string - - - - - string - string - string - string - string - string - string - string - string - - - - - string - string - string - 0 - - - - -
string
- string - string - string - string - string - string - string - string - string - - - - - string - string - string - string - - - - -
string
- string - string - string - string - string - string - string - string - - - - - string - string - string - string - string - - - - - string - string - - - - + string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string 0
string
+ + string string string string string string string string string string string string string
string
+ + string string string string string string string string string string string string string string string '401': description: Unauthorized content: @@ -222,260 +90,922 @@ components: properties: REPORT: type: object + example: + description: |+ + Report details with following children: + [META_INFO] + [REGISTRY_DETAIL] + [REQ_SEARCH_INFO] + [EMPLOYEE_SIZE] + [LIST_BIZ_BRANCH] + [LIST_REG_CHARGES] + [LIST_LIQUIDATOR] + [LIST_SHARE_INTEREST_COMP] + [LIST_NAME_CHANGE] + [LIST_SHAREHOLDER] + [LIST_CAPITAL] + [LIST_OFFICER_OWNER] + [LIST_SALES_REVENUE_AMOUNT] properties: META_INFO: type: object + example: |+ + + + + + + + + description: |+ + Meta Information details with following children: + SERVICE + SYSTEM_ID + CREATION_DATE + USER_ID + CLASS properties: SERVICE: type: string + description: Report requested + example: "BC" SYSTEM_ID : type: string + description: System ID + example: "DDP" CREATION_DATE: - type: string + type: datetime + description: Report request date + example: "Wed Apr 08 11:37:51 MYT 2009" USER_ID : type: string - CLASS : - type: string - REQ_SEARCH_INFO : - type: object - properties: - COMP_NAME : - type: string - REG_NO : - type: string - REQ_DATE : - type: string - REQ_REG_NO : + description: Valid user id in DDP system. It is for (For internal use) + example: "N/A" + CLASS: type: string - REQ_NAME : - type: string - REQ_DATE_STR : - type: string + description: Class location for metabean. It is for (For internal use) + example: "N/A" REGISTRY_DETAIL : type: object + example: |+ + + + + + + + + + + + + + + + + + + + + + + + + + + description: |+ + Registry Details with following children: + RENEWAL_DATE + ADDRESS1 + ADDRESS2 + ADDRESS3 + ADDRESS4 + COMP_TYPE_CODE + REG_DATE + REG_ACTIVITY1 + REG_ACTIVITY2 + ACC_DATE + STATUS_EFFECT_DATE + NAME_EFFECT_DATE + EXPIRY_DATE + COMP_TYPE + CHANGE_ADDR_DATE + COMP_STATUS + REG_ACTIVITY_DESC1 + REG_ACTIVITY_DESC2 + AUDITOR + AUDITOR_APPMT_DATE + LAST_AR_DATE + LAST_AGM_DATE + COUNTRY_INCORP properties: - COMP_NAME: - type: string RENEWAL_DATE: type: string - ADDRESS1 : + description: Renewal Date + example: "23/12/2008" + ADDRESS1: type: string - ADDRESS2 : + description: Address Line 1 + example: "1 HARBOURFRONT AVENUE , 18 - 01" + ADDRESS2: type: string - ADDRESS3 : + description: Address Line 2 + example: "KEPPEL BAY TOWER" + ADDRESS3: type: string + description: Address Line 3 + example: "098632" ADDRESS4: - type: string + type: string + description: Address Line 4 + example: "SINGAPORE" COMP_TYPE_CODE: type: string - REG_DATE : + example: CP + description: |+ + Report Code. Available values are: + 1. CP Corporate + 2. SP Sole Proprietor + REG_DATE: type: string + description: Registration Date + example: "14/10/1974" REG_ACTIVITY1: type: string + description: Registered Activities 1 + example: "OTHER INVESTMENT HOLDING COMPANIES" REG_ACTIVITY2: type: string - ACC_DATE : + description: Registered Activities 2 + example: "SHIP MANAGEMENT SERVICES" + ACC_DATE: type: string + description: Account Date + example: "31/12/2007" STATUS_EFFECT_DATE: - type: string + type: string + description: Status Effective Date + example: "14/10/1974" NAME_EFFECT_DATE: type: string - EXPIRY_DATE : + description: Name Effective Date + example: "14/10/1974" + EXPIRY_DATE: type: string - COMP_TYPE : + description: Expiry Date + example: "25/10/2009" + COMP_TYPE: type: string - CHANGE_ADDR_DATE : + description: Company Type + example: "LIMITED PRIVATE COMPANY" + CHANGE_ADDR_DATE: type: string - COMP_STATUS : + description: Change Address Date + example: "09/05/2003" + COMP_STATUS: type: string - REG_ACTIVITY_DESC1 : - type: string - REG_ACTIVITY_DESC2 : + description: Company Status + example: "Live Company" + REG_ACTIVITY_DESC1: type: string - AUDITOR : + description: Registered Activities Description + example: + REG_ACTIVITY_DESC2: type: string - AUDITOR_APPMT_DATE : + description: Registered Activities Description + example: + AUDITOR: type: string - LAST_AR_DATE : + description: Auditor Name + example: + AUDITOR_APPMT_DATE: type: string - LAST_AGM_DATE : + description: Auditor Appointment Date + example: "13/06/1990" + LAST_AR_DATE: type: string + description: Date of Last AR + example: "30/06/2008" + LAST_AGM_DATE: + type: string + description: Date of Last AGM + example: "11/06/2008" COUNTRY_INCORP: - type: string + type: string + description: Country Incorporated + example: "SINGAPORE" + REQ_SEARCH_INFO : + type: object + example: |+ + + + + + + + + + description: |+ + Request criteria & search record with following children: + COMP_NAME + REG_NO + REQ_DATE + REQ_REG_NO + REQ_NAME + REQ_DATE_STR + properties: + COMP_NAME: + type: string + description: Company Name + example: "KAPAL MANAGEMENT (PRIVATE) LIMITED" + REG_NO: + type: string + description: Subject’s ID Number (individual) or Registration Number (company/business) + example: "197401835M" + REQ_DATE: + type: string + description: Report Requested Date + example: "2009-04-08 11:36:03.611" + REQ_REG_NO: + type: string + description: Request Registration Number + example: "197401835M" + REQ_NAME: + type: string + description: Request Name + example: "KAPAL MANAGEMENT (PRIVATE) LIMITED" + REQ_DATE_STR: + type: string + description: Request Date String + example: "08/04/2009 11:36:03" EMPLOYEE_SIZE : type: object + description: |+ + Employee Size details with following children: + ELEMENTS + AMOUNT + example: |+ + + + 300 + properties: ELEMENTS: type: string + description: Description + example: "Employee Size" AMOUNT: type: string + description: Number of employee + example: "300" LIST_BIZ_BRANCH : type: array + description: |+ + List of Business Branches with following children: + [BIZ_BRANCH] + example: |+ + + + + + + + properties: + BIZ_BRANCH : + type: object + description: |+ + Business Branches with following children: + ADDR_BUILDING + ADDR_POSTCODE + ADDR_ADDRESS1 + example: |+ + + + + + + properties: + ADDR_BUILDING: + type: string + description: Building Name + example: + ADDR_POSTCODE: + type: string + description: Postcode + example: 289848 + ADDR_ADDRESS1: + type: string + description: Address + example: 251A ARCADIA ROAD + LIST_REG_CHARGES: + type: array + description: |+ + List of Registered Charges with following children: + [REG_CHARGES] + example: |+ + + + + + + + + + + items: properties: - BIZ_BRANCH : + REG_CHARGES : type: object + description: |+ + Registered Charges details with following children: + CHARGE_NO + CHARGE_DATE + CHARGEE_COMP + CURRENCY + AMT_SECURED + STATUS_SATISFACTION + example: |+ + + + + + + + + properties: - ADDR_BUILDING : + CHARGE_NO : + type: string + description: Charge No. + example: 8205117 + CHARGE_DATE: type: string - ADDR_POSTCODE : + description: Charge Date + example: 26/11/1982 + CHARGEE_COMP: type: string - ADDR_ADDRESS1 : + description: Charges Company + example: UNITED OVERSEAS BANK LIMITED + CURRENCY: type: string - LIST_REG_CHARGES : + description: Currency + example: + AMT_SECURED: + type: string + description: Amount Secured + example: 0.00 + STATUS_SATISFACTION: + type: string + description: Status of Satisfaction + example: + LIST_LIQUIDATOR: type: array + description: |+ + List of Liquidator / Receiver / Judicial Manager with following children: + [LIQUIDATOR] + example: |+ + + + ABUTHAHIR ABDUL GAFOOR S1676216D + Liquidator + EL TICI FINANCIAL ADVISORY SERVICES PTE. LTD. 1 RAFFLES PLACE #20-01 + OUB CENTRE SINGAPORE 048616 30/03/2009 + + items: properties: - REG_CHARGES : + LIQUIDATOR : type: object + description: |+ + Liquidator details with following children: + LIQ_POSITION + LIQ_ID + LIQ_NAME + LIQ_COMP + LIQ_ADDRESS1 + LIQ_ADDRESS2 + LIQ_ADDRESS3 + LIQ_ADDRESS4 + LIQ_APPOINTMENT_DATE + example: |+ + + ABUTHAHIR ABDUL GAFOOR + S1676216D + Liquidator + EL TICI FINANCIAL ADVISORY SERVICES PTE. LTD. + 1 RAFFLES PLACE + #20-01 + OUB CENTRE + SINGAPORE 048616 + 30/03/2009 + properties: - CHARGE_NO : + LIQ_POSITION: type: string - CHARGE_DATE : + description: Liquidator / Receiver / Judicial Manager Position + example: Liquidator + LIQ_ID: type: string - CHARGEE_COMP : - type: string - CURRENCY : + description: Liquidator / Receiver / Judicial Manager ID + example: S1676216D + LIQ_NAME : type: string - AMT_SECURED : + description: Liquidator / Receiver / Judicial Manager Name + example: ABUTHAHIR ABDUL GAFOOR + LIQ_COMP: type: string - STATUS_SATISFACTION : - type: string - LIST_LIQUIDATOR : + description: Liquidator / Receiver / Judicial Manager Company Name + example: EL TICI FINANCIAL ADVISORY SERVICES PTE. LTD. + LIQ_ADDRESS1: + type: string + description: Liquidator / Receiver / Judicial Manager Address 1 + example: 1 RAFFLES PLACE + LIQ_ADDRESS2: + type: string + description: Liquidator / Receiver / Judicial Manager Address 2 + example: #20-01 + LIQ_ADDRESS3: + type: string + description: Liquidator / Receiver / Judicial Manager Address 3 + example: OUB CENTRE + LIQ_ADDRESS4: + type: string + description: Liquidator / Receiver / Judicial Manager Address 4 + example: SINGAPORE 048616 + LIQ_APPOINTMENT_DATE: + type: string + description: Liquidator / Receiver / Judicial Manager Appointment Date + example: 30/03/2009 + LIST_SHARE_INTEREST_COMP : type: array + description: |+ + List of Share Interest In Companies with following children: + [SHARE_INTEREST_COMP] + example: |+ + + + + + + + + items: properties: - LIQUIDATOR : + SHARE_INTEREST_COMP : type: object + description: |+ + Share Interest In Companies details with following children: + COMP_NAME + SHARE_OWNED_UNIT + SHARE_OWNED_PERCENT + STATUS + example: |+ + + + + + + properties: - LIQ_NAME : - type: string - LIQ_ID : - type: string - LIQ_POSITION : - type: string - LIQ_COMP: + COMP_NAME : type: string - LIQ_ADDRESS1 : + description: Company Name + example: ORCHID (HOLDINGS) PTE. LTD. + SHARE_OWNED_UNIT : type: string - LIQ_ADDRESS2 : - type: string - LIQ_ADDRESS3: + description: Shares Owned Unit + example: 500000 + SHARE_OWNED_PERCENT : type: string - LIQ_ADDRESS4 : + description: Shares Owned Value (%) + example: 100.00 + STATUS : type: string - LIQ_APPOINTMENT_DATE : - type: string - LIST_SALES_REVENUE_AMOUNT : + description: Status + example: DISSOLVED - MEMBERS' VOLUNTARY WINDING UP + LIST_NAME_CHANGE : type: array + description: |+ + List of Change of Company/Business Name(s) with following children: + [NAME_CHANGE] + example: |+ + + + + + + items: properties: - SALES_REVENUE_AMOUNT: + NAME_CHANGE : type: object + description: |+ + Change of Company/Business Name(s) with following children: + PREV_NAME + EFFECT_DATE + example: |+ + + + + properties: - ELEMENTS : + PREV_NAME : type: string - YEAR : - type: string - CURRENCY : + description: Previous Name + example: HUA XI EATING HOUSE + EFFECT_DATE : type: string - AMOUNT: - type: number - LIST_SHAREHOLDER: + description: Effective Date + example: 25/10/1997 00:00:00 + LIST_SHAREHOLDER : type: array + description: |+ + List of Shareholders with following children: + [SHAREHOLDER] + example: |+ + + +
+ + + + + + + + + items: properties: - SHAREHOLDER: + SHAREHOLDER : type: object + description: |+ + Shareholders details with following children: + ADDRESS + COMP_ID + NO_OF_SHARE + CURRENCY + SHAREHOLDER_TYPE + SHARE_TYPE + SHAREHOLDER_NAME + CHANGE_ADDR_DATE + ADDR_TYPE + NATIONALITY + example: |+ + +
+ + + + + + + + + + properties: - ADDRESS: + ADDRESS : type: string - COMP_ID: - type: string - NO_OF_SHARE: + description: Address + example: 1 HARBOURFRONT AVENUE , 18 – 01; KEPPEL BAY TOWER; 098632, SINGAPORE + COMP_ID : type: string - CURRENCY: - type: string - SHAREHOLDER_TYPE: + description: Company/ Identity No. + example: 198200406H + NO_OF_SHARE : type: string - SHARE_TYPE: - type: string - SHAREHOLDER_NAME: + description: No. of Shares + example: 657 + CURRENCY : type: string - CHANGE_ADDR_DATE: + description: Currency + example: UNITED STATES OF AMERICA, DOLLARS + SHAREHOLDER_TYPE : type: string - ADDR_TYPE: - type: string - NATIONALITY: - type: string - LIST_SHARE_INTEREST_COMP : + description: Indicator for Shareholder type + example: 2 + SHARE_TYPE : + type: string + description: Share Type + example: Preference + SHAREHOLDER_NAME : + type: string + description: Shareholder Name + example: KEPPEL COMMUNICATIONS PTE LTD + CHANGE_ADDR_DATE : + type: string + description: Change Address Date + example: 09/05/2003 + ADDR_TYPE : + type: string + description: Address Type, indicates if it is Singapore or foreign address. + example: + NATIONALITY : + type: string + description: Nationality + example: SINGAPORE + LIST_CAPITAL : type: array + description: |+ + List of Capital details with following children: + [CAPITAL] + example: |+ + + + + + + + + + items: properties: - SHARE_INTEREST_COMP: + CAPITAL : type: object + description: |+ + Capital details with following children: + CAPITAL_CATEGORY + CAPITAL_TYPE + CURRENCY + CAPITAL_AMT + NO_OF_SHARES + example: |+ + + + + + + + properties: - COMP_NAME: + CAPITAL_CATEGORY : type: string - SHARE_OWNED_UNIT: + description: Capital Category + example: Issued + CAPITAL_TYPE : type: string - SHARE_OWNED_PERCENT: + description: Capital Type + example: Ordinary + CURRENCY : type: string - STATUS: + description: Currency + example: SINGAPORE, DOLLARS + CAPITAL_AMT : + type: string + description: Capital Amount + example: 100,000.00 + NO_OF_SHARES : type: string + description: Nos. of Shares + example: 100,000 LIST_OFFICER_OWNER : type: array + description: |+ + List of Officer(s) / Owner(s) with following children: + [OFFICER_OWNER] + example: |+ + + +
+ + + + + + + items: properties: - OFFICER_OWNER: + OFFICER_OWNER : type: object + description: |+ + Officer(s) / Owner(s) details with following children: + ADDRESS + IDENTITY_ID + PA_REG_NO + POSITION + ADDR_TYPE + CESSATION_DATE + OFFICER_NAME + CHANGE_ADDR_DATE + APPMT_DATE + NATIONALITY + example: |+ + +
+ + + + + + + + + properties: ADDRESS : type: string + description: Address + example: 50A TOH TUCK ROAD, 04 - 08 ; SIGNATURE PARK; 596742, SINGAPORE IDENTITY_ID : - type: string + type: string + description: Identity No. + example: S1674174D + PA_REG_NO : + type: string + description: Public Accountant Registration No. + example: 00091 POSITION : type: string - ADDR_TYPE: - type: string + description: Position + example: DIRECTOR + ADDR_TYPE : + type: string + description: Address Type, indicates if it is Singapore or foreign address. + example: S CESSATION_DATE : - type: string - OFFICER_NAME : - type: string + type: string + description: Cessation Date + example: 30/10/2003 + OFFICER_NAME : + type: string + description: Officer Name + example: HENRY GOH CHANGE_ADDR_DATE : type: string - APPMT_DATE: - type: string + description: Change Address Date + example: 30/10/2003 + APPMT_DATE : + type: string + description: Appointment Date + example: 30/10/2003 NATIONALITY : - type: string - LIST_CAPITAL: + type: string + description: Nationality + example: SINGAPORE P.R. + LIST_SALES_REVENUE_AMOUNT : type: array + description: |+ + List of Sales Revenue Amount with following children: + [SALES_REVENUE_AMOUNT] + example: |+ + + + 30000.00 + + items: properties: - CAPITAL: + SALES_REVENUE_AMOUNT : type: object + description: |+ + Sales Revenue Amount details with following children: + ELEMENTS + YEAR + CURRENCY + AMOUNT + example: |+ + + + + + 30000.00 + properties: - CAPITAL_CATEGORY: + ELEMENTS : type: string - CAPITAL_TYPE: - type: string - CURRENCY: + description: Description + example: Sales Revenue Amount + YEAR : + type: integer + description: Year + example: 2008 + CURRENCY : type: string - CAPITAL_AMT : - type: string - NO_OF_SHARES : - type: string - LIST_NAME_CHANGE: + description: Currency + example: SGD + AMOUNT : + type: integer + description: Amount + example: 30000.00 + LIST_Ddrptcount : type: array + description: |+ + List of Search By Financial Sectors and Search By Non- Financial Sectors with following children: + [Ddrptcount] + example: items: properties: - NAME_CHANGE: + Ddrptcount : type: object + description: |+ + 6 XML tags (open then close) displays + Search By Financial Sectors (counts for 3 recent years) + Search By Non- Financial Sectors (counts for 3 recent years) + Following children are: + Rcyear + RcFlag (only respond for the year exists) + Rcjan + Rcfeb + Rcmar + Rcapr + Rcmay + Rcjun + Rcjul + Rcaug + Rcsep + Rcoct + Rcnov + Rcdec + Rcid (only respond for the year exists) Rcreg (only respond for the year exists) Rcrptyid (only respond for the year exists) + Rcsecflag + LastUpdateDate (only respond for the year exists) + example: properties: - PREV_NAME: + Rcyear : + type: string + description: To show the year + example: 2017 + RcFlag : + type: string + description: Internal database value + example: N/A + Rcjan : + type: integer + description: Count for January + example: 1 + Rcfeb : + type: integer + description: Count for February + example: 1 + Rcmar : + type: integer + description: Count for March + example: 1 + Rcapr : + type: integer + description: Count for April + example: 1 + Rcmay : + type: integer + description: Count for May + example: 1 + Rcjun : + type: integer + description: Count for June + example: 1 + Rcjul : + type: integer + description: Count for July + example: 1 + Rcaug : + type: integer + description: Count for August + example: 1 + Rcsep : + type: integer + description: Count for September + example: 1 + Rcoct : + type: integer + description: Count for October + example: 1 + Rcnov : + type: integer + description: Count for November + example: 1 + Rcdec : + type: integer + description: Count for December + example: 1 + Rcid : + type: integer + description: Internal database value + example: + Rcreg : type: string - EFFECT_DATE: - type: string + description: Company Registration Number + example: + Rcrptyid : + type: string + description: Product Type + example: + Rcsecflag : + type: integer + description: Differentiate Search By Financial Sectors and Search By Non- Financial Sectors + example: 1 + LastUpdateDate : + type: string + description: Last update date + example: unauthorized: type: object properties: @@ -548,12 +1078,31 @@ components: status: type: string example: Failure - input: + REQUEST: type: object properties: - status: - type: string - example: Input Limit Exceeded + TOT_ITEMS: + type: number + example: 1 + description: Number of subjects being enquired relating to the Run + default: false + ENQUIRY: + type: object + example: |+ + 197601887ETRANSTAR TRAVEL PTE LTD + description: Contains information of each request details + default: true + properties: + SUBJECT_IDNO: + type: string + example: 199707714C + description: "Subject’s ID Number (individual) or Registration Number (company/business) as captured in DDP" + default: true + SUBJECT_NAME: + type: string + example: GPS INDUSTRIES PTE LTD + description: Subjects Name as captured in DDP + default: false versions: type: object properties: diff --git a/yaml/BusinessCheckPlusDun&Bradstreet(SG).yaml b/yaml/BusinessCheckPlusDun&Bradstreet(SG).yaml index d2822200e..71dce2d07 100644 --- a/yaml/BusinessCheckPlusDun&Bradstreet(SG).yaml +++ b/yaml/BusinessCheckPlusDun&Bradstreet(SG).yaml @@ -1,7 +1,7 @@ openapi: 3.0.1 info: title: Business Check Plus Dun & Bradstreet (SG) - description: The Data microservice provides key business information, litigation information (High and Subordinate Courts) and Winding Up Trace of a company including the Business name, registration number, registered address and date of change, company status, registered activities, shareholders details (i.e. date of commencement, residing address) capital amount and shares allocated to each shareholder, litigation information. Updated daily.

Authentication:

Authentication is done using the x-api-key in the request header. + description: The Data microservice provides key business information, litigation information (High and Subordinate Courts) and Winding Up Trace of a company including the Business name, registration number, registered address and date of change, company status, registered activities, shareholders details (i.e. date of commencement, residing address) capital amount and shares allocated to each shareholder, litigation information. Updated daily. version: '0.1' servers: - url: 'https://api.sentient.io' @@ -18,13 +18,7 @@ paths: content: application/xml: schema: - type: string - examples: - xml: - summary: A sample XML response - value: ' -1199707714C - GPS INDUSTRIES PTE LTD' + $ref: '#/components/schemas/REQUEST' responses: '200': description: success response @@ -32,6 +26,199 @@ paths: application/xml: schema: $ref: '#/components/schemas/success' + example: |+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + 300 + + + + + + + + + + + + + + + + + + + + + + + ABUTHAHIR ABDUL GAFOOR S1676216D + Liquidator + EL TICI FINANCIAL ADVISORY SERVICES PTE. LTD. 1 RAFFLES PLACE #20-01 + OUB CENTRE SINGAPORE 048616 30/03/2009 + + ANGELA ANG + S1633336D + Liquidator + KING FINANCIAL ADVISORY SERVICES LEVEL 17 MLC CENTRE 19029 MARTIN PLACE SYDNEY NSW 2000 AUSTRALIA 18/02/2009 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + +
+ + + + + + +
+ + + + + + + + + 30000.00 + + 28000.00 + + 27,000.00 + + '401': description: Unauthorized content: @@ -89,417 +276,1324 @@ components: properties: REPORT: type: object + example: + description: |+ + Report details with following children: + [META_INFO] + [REGISTRY_DETAIL] + [REQ_SEARCH_INFO] + [EMPLOYEE_SIZE] + [LIST_BIZ_BRANCH] + [LIST_REG_CHARGES] + [LIST_LIQUIDATOR] + [LIST_WINDING_UP] + [LIST_LITIGATION] + [LIST_SHARE_INTEREST_COMP] + [LIST_NAME_CHANGE] + [LIST_SHAREHOLDER] + [LIST_CAPITAL] + [LIST_OFFICER_OWNER] + [LIST_SALES_REVENUE_AMOUNT] properties: META_INFO: type: object + example: |+ + + + + + + + description: |+ + Meta Information details with following children: + SERVICE + SYSTEM_ID + CREATION_DATE + USER_ID + CLASS properties: SERVICE: type: string + description: Report requested + example: "BCP" SYSTEM_ID : type: string + description: System ID + example: "DDP" CREATION_DATE: type: string + description: Report request date + example: "Wed Apr 08 11:37:51 MYT 2009" USER_ID : type: string - CLASS type: + description: Valid user id in DDP system. It is for (For internal use) + example: N/A + CLASS: type: string + description: Class location for metabean. It is for (For internal use) + example: N/A REGISTRY_DETAIL : type: object + example: |+ + + + + + + + + + + + + + + + + + + + + + + description: |+ + Registry Details with following children: + RENEWAL_DATE + ADDRESS1 + ADDRESS2 + ADDRESS3 + ADDRESS4 + COMP_TYPE_CODE + REG_DATE + REG_ACTIVITY1 + REG_ACTIVITY2 + ACC_DATE + STATUS_EFFECT_DATE + NAME_EFFECT_DATE + EXPIRY_DATE + COMP_TYPE + CHANGE_ADDR_DATE + COMP_STATUS + REG_ACTIVITY_DESC1 + REG_ACTIVITY_DESC2 + AUDITOR + AUDITOR_APPMT_DATE + LAST_AR_DATE + LAST_AGM_DATE + COUNTRY_INCORP properties: RENEWAL_DATE: type: string + description: Renewal Date + example: "23/12/2008" ADDRESS1: type: string + description: Address Line 1 + example: "1 HARBOURFRONT AVENUE , 18 - 01" ADDRESS2: type: string + description: Address Line 2 + example: "KEPPEL BAY TOWER" ADDRESS3: type: string + description: Address Line 3 + example: "098632" ADDRESS4: type: string + description: Address Line 4 + example: "SINGAPORE" COMP_TYPE_CODE: type: string + example: CP + description: |+ + Report Code. Available values are: + 1. CP Corporate + 2. SP Sole Proprietor REG_DATE: type: string + description: Registration Date + example: "14/10/1974" REG_ACTIVITY1: type: string + description: Registered Activities 1 + example: "OTHER INVESTMENT HOLDING COMPANIES" REG_ACTIVITY2: type: string + description: Registered Activities 2 + example: "SHIP MANAGEMENT SERVICES" ACC_DATE: type: string + description: Account Date + example: "31/12/2007" STATUS_EFFECT_DATE: type: string + description: Status Effective Date + example: "14/10/1974" NAME_EFFECT_DATE: type: string + description: Name Effective Date + example: "14/10/1974" EXPIRY_DATE: type: string + description: Expiry Date + example: "25/10/2009" COMP_TYPE: type: string + description: Company Type + example: "LIMITED PRIVATE COMPANY" CHANGE_ADDR_DATE: type: string + description: Change Address Date + example: "09/05/2003" COMP_STATUS: type: string + description: Company Status + example: "Live Company" REG_ACTIVITY_DESC1: type: string + description: Registered Activities Description + example: REG_ACTIVITY_DESC2: type: string + description: Registered Activities Description + example: AUDITOR: type: string + description: Auditor Name + example: AUDITOR_APPMT_DATE: type: string + description: Auditor Appointment Date + example: "13/06/1990" LAST_AR_DATE: type: string + description: Date of Last AR + example: "30/06/2008" LAST_AGM_DATE: - type: string + type: string + description: Date of Last AGM + example: "11/06/2008" COUNTRY_INCORP: type: string + description: Country Incorporated + example: "SINGAPORE" REQ_SEARCH_INFO : type: object + example: |+ + + + + + + + description: |+ + Request criteria & search record with following children: + COMP_NAME + REG_NO + REQ_DATE + REQ_REG_NO + REQ_NAME + REQ_DATE_STR properties: COMP_NAME: type: string + description: Company Name + example: "KAPAL MANAGEMENT (PRIVATE) LIMITED" REG_NO: type: string + description: Subject’s ID Number (individual) or Registration Number (company/business) + example: "197401835M" REQ_DATE: type: string + description: Report Requested Date + example: "2009-04-08 11:36:03.611" REQ_REG_NO: type: string + description: Request Registration Number + example: "197401835M" REQ_NAME: type: string + description: Request Name + example: "KAPAL MANAGEMENT (PRIVATE) LIMITED" REQ_DATE_STR: type: string + description: Request Date String + example: "08/04/2009 11:36:03" EMPLOYEE_SIZE : type: object + description: |+ + Employee Size details with following children: + ELEMENTS + AMOUNT + example: |+ + + + 300 + properties: ELEMENTS: type: string + description: Description + example: "Employee Size" AMOUNT: type: string + description: Number of employee + example: "300" LIST_BIZ_BRANCH : - type: object - properties: - BIZ_BRANCH : - type: object - properties: - REQADDR_BUILDING: - type: string - ADDR_POSTCODE: - type: string - ADDR_ADDRESS1: - type: string + type: array + description: |+ + List of Business Branches with following children: + [BIZ_BRANCH] + example: |+ + + + + + + + items: + properties: + BIZ_BRANCH : + type: object + description: |+ + Business Branches with following children: + ADDR_BUILDING + ADDR_POSTCODE + ADDR_ADDRESS1 + example: |+ + + + + + + properties: + ADDR_BUILDING: + type: string + description: Building Name + example: + ADDR_POSTCODE: + type: string + description: Postcode + example: 289848 + ADDR_ADDRESS1: + type: string + description: Address + example: 251A ARCADIA ROAD LIST_REG_CHARGES: type: array + description: |+ + List of Registered Charges with following children: + [REG_CHARGES] + example: |+ + + + + + + + + + items: properties: REG_CHARGES : type: object + description: |+ + Registered Charges details with following children: + CHARGE_NO + CHARGE_DATE + CHARGEE_COMP + CURRENCY + AMT_SECURED + STATUS_SATISFACTION + example: |+ + + + + + + + + properties: CHARGE_NO : type: string + description: Charge No. + example: 8205117 CHARGE_DATE: type: string + description: Charge Date + example: 26/11/1982 CHARGEE_COMP: type: string + description: Charges Company + example: UNITED OVERSEAS BANK LIMITED CURRENCY: type: string + description: Currency + example: AMT_SECURED: type: string + description: Amount Secured + example: 1000.00 STATUS_SATISFACTION: type: string + description: Status of Satisfaction + example: LIST_LIQUIDATOR: type: array + description: |+ + List of Liquidator / Receiver / Judicial Manager with following children: + [LIQUIDATOR] + example: |+ + + + ABUTHAHIR ABDUL GAFOOR S1676216D + Liquidator + EL TICI FINANCIAL ADVISORY SERVICES PTE. LTD. 1 RAFFLES PLACE #20-01 + OUB CENTRE SINGAPORE 048616 30/03/2009 + + items: properties: LIQUIDATOR : type: object + description: |+ + Liquidator details with following children: + LIQ_POSITION + LIQ_ID + LIQ_NAME + LIQ_COMP + LIQ_ADDRESS1 + LIQ_ADDRESS2 + LIQ_ADDRESS3 + LIQ_ADDRESS4 + LIQ_APPOINTMENT_DATE + example: |+ + + ABUTHAHIR ABDUL GAFOOR + S1676216D + Liquidator + EL TICI FINANCIAL ADVISORY SERVICES PTE. LTD. + 1 RAFFLES PLACE + #20-01 + OUB CENTRE + SINGAPORE 048616 + 30/03/2009 + properties: - LIQ_NAME : + LIQ_POSITION: type: string + description: Liquidator / Receiver / Judicial Manager Position + example: Liquidator LIQ_ID: type: string - LIQ_POSITION: + description: Liquidator / Receiver / Judicial Manager ID + example: S1676216D + LIQ_NAME : type: string + description: Liquidator / Receiver / Judicial Manager Name + example: ABUTHAHIR ABDUL GAFOOR LIQ_COMP: type: string + description: Liquidator / Receiver / Judicial Manager Company Name + example: EL TICI FINANCIAL ADVISORY SERVICES PTE. LTD. LIQ_ADDRESS1: type: string + description: Liquidator / Receiver / Judicial Manager Address 1 + example: 1 RAFFLES PLACE LIQ_ADDRESS2: - type: string + type: string + description: Liquidator / Receiver / Judicial Manager Address 2 + example: #20-01 LIQ_ADDRESS3: type: string + description: Liquidator / Receiver / Judicial Manager Address 3 + example: OUB CENTRE LIQ_ADDRESS4: type: string + description: Liquidator / Receiver / Judicial Manager Address 4 + example: SINGAPORE 048616 LIQ_APPOINTMENT_DATE: - type: string + type: string + description: Liquidator / Receiver / Judicial Manager Appointment Date + example: 30/03/2009 LIST_WINDING_UP : type: array + description: |+ + List of Winding Up with following children: + [WINDING_UP] + example: |+ + + + + + + + + + + + + + + + + + + + + items: properties: WINDING_UP : type: object + description: |+ + Winding Up details with following children: + CASE_CODE + CASE_YEAR + PLAINTIFF + PLA_SOLICITOR_ID + PLA_FILE_REF + PLA_LAW_FIRM + SUBJECT_NAME + COURT_CODE + CASE_TYPE + CURRENCY1 + AMOUNT1 + CURRENCY2 + AMOUNT2 + CURRENCY3 + AMOUNT3 + ACTION_DATE + BANKRUPTCY_ACT + HEARING_DATE + PLA_SOLICITOR + example: |+ + + + + + + + + + + + + + + + + + + + properties: CASE_CODE : type: string + description: Case Code + example: 40000 CASE_YEAR : type: string + description: Case Year + example: 1999 PLAINTIFF : type: string + description: Plaintiff Name + example: PLA_SOLICITOR_ID : type: string + description: Pla. Solicitor ID + example: PLA_FILE_REF : type: string + description: Pla. File Ref. + example: + PLA_LAW_FIRM : + type: string + description: Pla. Law Firm + example: NAME2 + SUBJECT_NAME : + type: string + description: Subject Name + example: PROACTIVE BUILDERS COURT_CODE : - type: string + type: string + description: Court Code + example: CWU CASE_TYPE : type: string + description: Case Type + example: COMPANY WINDING UP PETITION CURRENCY1 : type: string + description: Currency 1 + example: SGD + AMOUNT1 : + type: string + description: Amount 1 + example: 41,424.52 CURRENCY2 : - type: string + type: string + description: Currency 2 + example: MYR AMOUNT2 : type: string + description: Amount 2 + example: 0.00 CURRENCY3 : type: string + description: Currency 3 + example: AMOUNT3 : type: string + description: Amount 3 + example: 0.00 + ACTION_DATE : + type: string + description: Action Date + example: 11/05/2007 BANKRUPTCY_ACT : type: string + description: Act of Bankruptcy + example: Petition for Winding Up HEARING_DATE : type: string - ACTION_DATE : - type: string - SUBJECT_NAME : - type: string - PLA_SOLICITOR : + description: Hearing Date + example: 15/12/2007 + PLA_SOLICITOR : type: string - PLA_LAW_FIRM : - type: string + description: Pla. Solicitor + example: LIST_LITIGATION : type: array + description: |+ + List of Winding Up with following children: + [LITIGATION] + example: |+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + items: properties: LITIGATION : type: object + description: |+ + List of Winding Up with following children: + SUBJECT_NAME + NATURE_OF_CLAIM + STATUS_DATE + CASE_NO + DOC_REMARK + CURRENCY1 + CURRENCY2 + CURRENCY3 + CURRENCY4 + CURRENCY5 + DEF_SOLICITOR + DEF_SOLICITOR_ID + DEF_LAW_FIRM + DEF_FILE_REF + DATE_OF_WRIT + STATUS + AMOUNT1 + AMOUNT2 + AMOUNT3 + AMOUNT4 + AMOUNT5 + PLAINTIFF + PLA_SOLICITOR + PLA_SOLICITOR_ID + PLA_LAW_FIRM + PLA_FILE_REF + PLA_ID + PLA_STATUS + PLA_STATUS_DATE + example: |+ + + + + + + + + + + + + + + + + + + + + + + + + + + + properties: SUBJECT_NAME : type: string + description: Subject Name + example: "SOON SOON SEAFOOD" NATURE_OF_CLAIM : type: string + example: "CONTRACT 3" + description: Nature of Claim STATUS_DATE : type: string + example: "01/05/2008" + description: Status Date CASE_NO : type: string + example: "MC 40001 / 1999" + description: Case No DOC_REMARKS : type: string + example: "NOTICE OF DISCONTINUANCE/WITHDRAWAL 3" + description: Document Remark CURRENCY1 : - type: string + type: string + example: "SGD" + description: Currency 1 CURRENCY2 : type: string + example: "MYR" + description: Currency 2 CURRENCY3 : type: string + example: "USD" + description: Currency 3 CURRENCY4 : type: string + example: "-" + description: Currency 4 CURRENCY5 : type: string + example: "-" + description: Currency 5 DEF_SOLICITOR : type: string + example: "SOL2" + description: Def. Solicitor DEF_SOLICITOR_ID : type: string + example: "20000000" + description: Def. Solicitor ID DEF_LAW_FIRM : type: string + example: "NAME2" + description: Def. Law Firm DEF_FILE_REF : type: string + example: "FILE2" + description: Def. File Ref. DATE_OF_WRIT : - type: string + type: string + example: "01/01/2008" + description: Date Writ STATUS : type: string + example: "CONCLUDED 3" + description: Status AMOUNT1 : type: string + example: "100.00" + description: Amount 1 AMOUNT2 : - type: string + type: string + example: "200.00" + description: Amount 2 AMOUNT3 : type: string + example: "0.00" + description: Amount 3 AMOUNT4 : - type: string + type: string + example: "400.00" + description: Amount 4 AMOUNT5 : type: string + example: "0.00" + description: Amount 5 PLAINTIFF : type: string + example: "MC 40001" + description: Plaintiff Name PLA_SOLICITOR: type: string + example: "SOL2" + description: plantiff Solicitor PLA_SOLICITOR_ID: type: string + example: "20000000" + description: plantiff Solicitor ID PLA_LAW_FIRM : type: string + example: "NAME2" + description: Pla. Law Firm PLA_FILE_REF : - type: string + type: string + example: "FILE2" + description: Pla. File Ref. PLA_ID: type: string + example: "S0739038F" + description: Plaintiff ID PLA_STATUS: type: string + example: "SETTLED - BEFORE SET DOWN" + description: Plaintiff Status PLA_STATUS_DATE : - type: string + type: string + example: "17/10/2016" + description: Plaintiff Status Date LIST_SHARE_INTEREST_COMP : type: array + description: |+ + List of Share Interest In Companies with following children: + [SHARE_INTEREST_COMP] + example: |+ + + + + + + + + items: properties: - SHARE_INTEREST_COMP: + SHARE_INTEREST_COMP : type: object + description: |+ + Share Interest In Companies details with following children: + COMP_NAME + SHARE_OWNED_UNIT + SHARE_OWNED_PERCENT + STATUS + example: |+ + + + + + + properties: - COMP_NAME: + COMP_NAME : type: string - SHARE_OWNED_UNIT: + description: Company Name + example: ORCHID (HOLDINGS) PTE. LTD. + SHARE_OWNED_UNIT : type: string - SHARE_OWNED_PERCENT: + description: Shares Owned Unit + example: 500000 + SHARE_OWNED_PERCENT : type: string - STATUS: + description: Shares Owned Value (%) + example: 100.00 + STATUS : type: string - LIST_NAME_CHANGE: + description: Status + example: DISSOLVED - MEMBERS' VOLUNTARY WINDING UP + LIST_NAME_CHANGE : type: array + description: |+ + List of Change of Company/Business Name(s) with following children: + [NAME_CHANGE] + example: |+ + + + + + + items: properties: - NAME_CHANGE: + NAME_CHANGE : type: object + description: |+ + Change of Company/Business Name(s) with following children: + PREV_NAME + EFFECT_DATE + example: |+ + + + + properties: - PREV_NAME: + PREV_NAME : type: string - EFFECT_DATE: + description: Previous Name + example: HUA XI EATING HOUSE + EFFECT_DATE : type: string - LIST_SHAREHOLDER: + description: Effective Date + example: 25/10/1997 00:00:00 + LIST_SHAREHOLDER : type: array + description: |+ + List of Shareholders with following children: + [SHAREHOLDER] + example: |+ + + +
+ + + + + + + + + items: properties: - SHAREHOLDER: + SHAREHOLDER : type: object + description: |+ + Shareholders details with following children: + ADDRESS + COMP_ID + NO_OF_SHARE + CURRENCY + SHAREHOLDER_TYPE + SHARE_TYPE + SHAREHOLDER_NAME + CHANGE_ADDR_DATE + ADDR_TYPE + NATIONALITY + example: |+ + +
+ + + + + + + + + + properties: - ADDRESS: + ADDRESS : type: string - COMP_ID: - type: string - NO_OF_SHARE: + description: Address + example: 1 HARBOURFRONT AVENUE , 18 – 01; KEPPEL BAY TOWER; 098632, SINGAPORE + COMP_ID : type: string - CURRENCY: - type: string - SHAREHOLDER_TYPE: + description: Company/ Identity No. + example: 198200406H + NO_OF_SHARE : type: string - SHARE_TYPE: - type: string - SHAREHOLDER_NAME: + description: No. of Shares + example: 657 + CURRENCY : type: string - CHANGE_ADDR_DATE: + description: Currency + example: UNITED STATES OF AMERICA, DOLLARS + SHAREHOLDER_TYPE : type: string - ADDR_TYPE: - type: string - NATIONALITY: - type: string - LIST_CAPITAL: + description: Indicator for Shareholder type + example: 2 + SHARE_TYPE : + type: string + description: Share Type + example: Preference + SHAREHOLDER_NAME : + type: string + description: Shareholder Name + example: KEPPEL COMMUNICATIONS PTE LTD + CHANGE_ADDR_DATE : + type: string + description: Change Address Date + example: 09/05/2003 + ADDR_TYPE : + type: string + description: Address Type, indicates if it is Singapore or foreign address. + example: + NATIONALITY : + type: string + description: Nationality + example: SINGAPORE + LIST_CAPITAL : type: array + description: |+ + List of Capital details with following children: + [CAPITAL] + example: |+ + + + + + + + + + items: properties: - CAPITAL: + CAPITAL : type: object + description: |+ + Capital details with following children: + CAPITAL_CATEGORY + CAPITAL_TYPE + CURRENCY + CAPITAL_AMT + NO_OF_SHARES + example: |+ + + + + + + + properties: - CAPITAL_CATEGORY: + CAPITAL_CATEGORY : type: string - CAPITAL_TYPE: - type: string - CURRENCY: + description: Capital Category + example: Issued + CAPITAL_TYPE : type: string + description: Capital Type + example: Ordinary + CURRENCY : + type: string + description: Currency + example: SINGAPORE, DOLLARS CAPITAL_AMT : - type: string + type: string + description: Capital Amount + example: 100,000.00 NO_OF_SHARES : type: string + description: Nos. of Shares + example: 100,000 LIST_OFFICER_OWNER : type: array + description: |+ + List of Officer(s) / Owner(s) with following children: + [OFFICER_OWNER] + example: |+ + + +
+ + + + + + + items: properties: - OFFICER_OWNER: + OFFICER_OWNER : type: object + description: |+ + Officer(s) / Owner(s) details with following children: + ADDRESS + IDENTITY_ID + PA_REG_NO + POSITION + ADDR_TYPE + CESSATION_DATE + OFFICER_NAME + CHANGE_ADDR_DATE + APPMT_DATE + NATIONALITY + example: |+ + +
+ + + + + + + + + properties: ADDRESS : type: string + description: Address + example: 50A TOH TUCK ROAD, 04 - 08 ; SIGNATURE PARK; 596742, SINGAPORE IDENTITY_ID : - type: string + type: string + description: Identity No. + example: S1674174D + PA_REG_NO : + type: string + description: Public Accountant Registration No. + example: 00091 POSITION : type: string - ADDR_TYPE: - type: string + description: Position + example: DIRECTOR + ADDR_TYPE : + type: string + description: Address Type, indicates if it is Singapore or foreign address. + example: S CESSATION_DATE : - type: string - OFFICER_NAME : - type: string + type: string + description: Cessation Date + example: 30/10/2003 + OFFICER_NAME : + type: string + description: Officer Name + example: HENRY GOH CHANGE_ADDR_DATE : type: string - APPMT_DATE: - type: string + description: Change Address Date + example: 30/10/2003 + APPMT_DATE : + type: string + description: Appointment Date + example: 30/10/2003 NATIONALITY : - type: string + type: string + description: Nationality + example: SINGAPORE P.R. LIST_SALES_REVENUE_AMOUNT : type: array + description: |+ + List of Sales Revenue Amount with following children: + [SALES_REVENUE_AMOUNT] + example: |+ + + + 30000.00 + + items: properties: - SALES_REVENUE_AMOUNT: + SALES_REVENUE_AMOUNT : type: object + description: |+ + Sales Revenue Amount details with following children: + ELEMENTS + YEAR + CURRENCY + AMOUNT + example: |+ + + + + + 30000.00 + properties: ELEMENTS : type: string + description: Description + example: Sales Revenue Amount YEAR : - type: string + type: string + description: Year + example: 2008 CURRENCY : type: string - AMOUNT: - type: number - CESSATION_DATE : - type: string + description: Currency + example: SGD + AMOUNT : + type: string + description: Amount + example: 30000.00 + LIST_Ddrptcount : + type: array + description: |+ + List of Search By Financial Sectors and Search By Non- Financial Sectors with following children: + [Ddrptcount] + example: + items: + properties: + Ddrptcount : + type: object + description: |+ + 6 XML tags (open then close) displays + Search By Financial Sectors (counts for 3 recent years) + Search By Non- Financial Sectors (counts for 3 recent years) + Following children are: + Rcyear + RcFlag (only respond for the year exists) + Rcjan + Rcfeb + Rcmar + Rcapr + Rcmay + Rcjun + Rcjul + Rcaug + Rcsep + Rcoct + Rcnov + Rcdec + Rcid (only respond for the year exists) Rcreg (only respond for the year exists) Rcrptyid (only respond for the year exists) + Rcsecflag + LastUpdateDate (only respond for the year exists) + example: + properties: + Rcyear : + type: string + description: To show the year + example: 2017 + RcFlag : + type: string + description: Internal database value + example: N/A + Rcjan : + type: string + description: Count for January + example: 1 + Rcfeb : + type: string + description: Count for February + example: 1 + Rcmar : + type: string + description: Count for March + example: 1 + Rcapr : + type: string + description: Count for April + example: 1 + Rcmay : + type: string + description: Count for May + example: 1 + Rcjun : + type: string + description: Count for June + example: 1 + Rcjul : + type: string + description: Count for July + example: 1 + Rcaug : + type: string + description: Count for August + example: 1 + Rcsep : + type: string + description: Count for September + example: 1 + Rcoct : + type: string + description: Count for October + example: + Rcnov : + type: string + description: Count for November + example: 1 + Rcdec : + type: string + description: Count for December + example: 1 + Rcid : + type: string + description: Internal database value + example: + Rcreg : + type: string + description: Company Registration Number + example: + Rcrptyid : + type: string + description: Product Type + example: + Rcsecflag : + type: string + description: Differentiate Search By Financial Sectors and Search By Non- Financial Sectors + example: 1 + LastUpdateDate : + type: string + description: Last update date + example: unauthorized: - type: array - items: - properties: - message: - type: string - example: Missing Authentication Token - status: - type: string - example: Failure + type: object + properties: + message: + type: string + example: Missing Authentication Token + status: + type: string + example: Failure forbidden: - type: array - items: - properties: - message: - type: string - example: Access Denied Unauthorized User - status: - type: string - example: Failure + type: object + properties: + message: + type: string + example: Access Denied Unauthorized User + status: + type: string + example: Failure paymentrequired: - type: array - items: - properties: - message: - type: string - example: Insufficient Credits Kindly Top Up - status: - type: string - example: Failure + type: object + properties: + message: + type: string + example: Insufficient Credits Kindly Top Up + status: + type: string + example: Failure notfound: - type: array - items: - properties: - message: - type: string - example: Invalid Request URL - status: - type: string - example: Failure + type: object + properties: + message: + type: string + example: Invalid Request URL + status: + type: string + example: Failure servererror: - type: array - items: - properties: - message: - type: string - example: Internal Server Error - status: - type: string - example: Failure + type: object + properties: + message: + type: string + example: Internal Server Error + status: + type: string + example: Failure gatewaytimeout: type: object properties: @@ -527,9 +1621,45 @@ components: status: type: string example: Failure + REQUEST: + type: object + properties: + TOT_ITEMS: + type: number + example: 1 + description: Number of subjects being enquired relating to the Run + default: false + ENQUIRY: + type: object + example: |+ + 197601887ETRANSTAR TRAVEL PTE LTD + description: Contains information of each request details + default: true + properties: + SUBJECT_IDNO: + type: string + example: 199707714C + description: "Subject’s ID Number (individual) or Registration Number (company/business) as captured in DDP" + default: true + SUBJECT_NAME: + type: string + example: GPS INDUSTRIES PTE LTD + description: Subjects Name as captured in DDP + default: false + versions: + type: object + properties: + v0.1: + type: array + items: + oneOf: + - type: string + example: Published Date - Jul 23, 2019 + description: Initial version release securitySchemes: APIAuthorizer: type: apiKey name: x-api-key in: header - x-amazon-apigateway-authtype: custom \ No newline at end of file + x-amazon-apigateway-authtype: custom + description: Authentication is done using the x-api-key in the request header diff --git a/yaml/asr_with_vad_eng_sg.yaml b/yaml/asr_with_vad_eng_sg.yaml index 54728faf7..77ace0fef 100644 --- a/yaml/asr_with_vad_eng_sg.yaml +++ b/yaml/asr_with_vad_eng_sg.yaml @@ -194,17 +194,17 @@ components: 1. news_parliament - 16 kHz, mono channel, .wav format. Trained on Singapore news and parliament corpus. 2. nsc_parliament - 16 kHz, mono channel, .wav format. Trained on National Speech Corpus and parliament corpus. 3. nscfull_8k - 8 kHz, mono channel, .wav format. Trained on National Speech Corpus. Trained on Full National Speech Corpus corpus. - wav_base64: - x-name: wav_base64 + wav_url/wav_base64: + x-name: wav_url/wav_base64 type: string default: true - example: UklGRpxNHQBXQVZFZm10IBAAAAABAAEAgD4AAAB9AAACABAAT ... + example: https://api.sentient.io/test2.wav or UklGRpxNHQBXQVZFZm10IBAAAAABAAEAgD4AAAB9AAACABAAT ... description: |+ - Input audio wav file in base64 format. Mono channel, 8kHz / 16kHz sampling rate. + The public URL link to the wave file or Input audio wav file in base64 format. Mono channel, 8kHz / 16kHz sampling rate. file_type: x-name: file_type type: string - default: true + default: false example: wav description: |+ Input file extension. Only “wav” is supported at the moment. @@ -212,7 +212,7 @@ components: x-name: vad_threshold type: number format: float - default: true + default: false example: 0.4 description: |+ 0.0 to 1.0. Lower will result in more sentence splits. Recommended value is 0.25. diff --git a/yaml/automatic_speech_recognition_chi_sg.yaml b/yaml/automatic_speech_recognition_chi_sg.yaml index 41af29144..00cf3e134 100644 --- a/yaml/automatic_speech_recognition_chi_sg.yaml +++ b/yaml/automatic_speech_recognition_chi_sg.yaml @@ -180,14 +180,6 @@ components: description: |+ Input file in base64 format and needs to be prefixed by the data type and encoding data:audio/wav;base64, - language: - x-name: language - type: string - default: true - example: 1 - description: |+ - Language setting: - 1 Mandarin versions: type: object properties: diff --git a/yaml/automatic_speech_recognition_eng_sg.yaml b/yaml/automatic_speech_recognition_eng_sg.yaml index 21f786104..efa8277ee 100644 --- a/yaml/automatic_speech_recognition_eng_sg.yaml +++ b/yaml/automatic_speech_recognition_eng_sg.yaml @@ -201,11 +201,9 @@ components: default: true example: nsc_parliament description: |+ - Model selection. For best performance, select the model which best matches the use-case: - - 1. news_parliament - 16 kHz, mono channel, .wav format. Trained on Singapore news and parliament corpus. - 2. nsc_parliament - 16 kHz, mono channel, .wav format. Trained on National Speech Corpus and parliament corpus. - 3. nscfull_8k - 8 kHz, mono channel, .wav format. Trained on National Speech Corpus. Trained on Full National Speech Corpus corpus. + Model name: + 1. news_parliament. 16 kHz, mono channel. wav format. “news_parliament” is trained on Singapore news and parliament corpus. + 2. nsc_parliament. 16 kHz, mono channel. wav format. “nsc_parliament” is trained on National Speech Corpus and parliament corpus. wav_base64: x-name: wav_base64 type: string diff --git a/yaml/carpark_hdb_sg.yaml b/yaml/carpark_hdb_sg.yaml index 5b25479a8..d51736462 100644 --- a/yaml/carpark_hdb_sg.yaml +++ b/yaml/carpark_hdb_sg.yaml @@ -185,8 +185,8 @@ paths: _source: cpk_no: BE37 block: BLK 282 - street: BISHAN STREET 22 - address: BLK 282 BISHAN STREET 22 + street: BE37 BISHAN STREET 22 + address: BLK 282 BE37 BISHAN STREET 22 source: hdb xcoord: '29235.553' ycoord: '37787.1371' diff --git a/yaml/named-entity_recognition_eng.yaml b/yaml/named-entity_recognition_eng.yaml index 260332ae5..285777746 100644 --- a/yaml/named-entity_recognition_eng.yaml +++ b/yaml/named-entity_recognition_eng.yaml @@ -202,6 +202,13 @@ components: versions: type: object properties: + v1.0: + type: array + items: + oneOf: + - type: string + example: Published Date - Nov 25,2019 + description: Updated version release v1.0 v0.1: type: array items: diff --git a/yaml/named-entity_recognition_eng_v1.0.yaml b/yaml/named-entity_recognition_eng_v1.0.yaml new file mode 100644 index 000000000..e109f5a37 --- /dev/null +++ b/yaml/named-entity_recognition_eng_v1.0.yaml @@ -0,0 +1,237 @@ +openapi: 3.0.1 +info: + title: Named-Entity Recognition ENG Updated + description: |+ + This NLP microservice locates and classifies the named-entities classes from input unstructured English text. + + The named-entity classes extracted are persons, locations, organisations and miscellaneous. + + This microservice automatically extracts structured information from unstructured text data such as chatlogs, emails, news articles, etc. + version: '1.0' +servers: + - url: 'https://apis.sentient.io' +tags: +- name: "v1.0" + description: "Published Date - Sep 30, 2020" +paths: + /microservices/nlp/namedentityrecognition/v1.0/getpredictions: + post: + tags: + - v1.0 + responses: + '200': + description: success response + content: + application/json: + schema: + $ref: '#/components/schemas/success' + example: {"message":"SuccessfullyProcessed","results":{"loc":["Hubei","Singapore","SINGAPORE","China","Immigration"],"misc":["ICA.They"],"org":["ImmigrationandCheckpointsAuthority","ICA","LOA"]},"status":"Success"} + '401': + description: Unauthorized + content: + application/json: + schema: + $ref: '#/components/schemas/unauthorized' + '402': + description: Payment Required + content: + application/json: + schema: + $ref: '#/components/schemas/paymentrequired' + '403': + description: Forbidden + content: + application/json: + schema: + $ref: '#/components/schemas/forbidden' + '404': + description: Not Found + content: + application/json: + schema: + $ref: '#/components/schemas/notfound' + '419': + description: Input Field Missing + content: + application/json: + schema: + $ref: '#/components/schemas/inputfieldmissing' + '420': + description: Input Limit Exceeded + content: + application/json: + schema: + $ref: '#/components/schemas/inputlimitexceeded' + '500': + description: Internal Server Error + content: + application/json: + schema: + $ref: '#/components/schemas/servererror' + '504': + description: Gateway Timeout + content: + application/json: + schema: + $ref: '#/components/schemas/gatewaytimeout' + security: + - APIAuthorizer: [] + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/input' + required: true +components: + schemas: + success: + type: object + properties: + results: + type: object + example: { "" } + description: Json Object of returned results + properties: + loc: + type: array + items: + type: string + example: + - Hubei + - Singapore + - Hubei + - Hubei + - Immigration + description: "name of location found in the text string" + misc: + type: array + items: + type: string + example: + - ICA.They + description: "name of miscellaneous names found in the text string" + org: + type: array + items: + type: string + example: + - Immigration and Checkpoints Authority + - ICA + - LOA + description: "name of organizations names found in the text string" + message: + type: string + example: Successfully Processed + description: Detail description on the API status + status: + type: string + example: Success + description: The status of the API call success/failure + unauthorized: + type: object + properties: + message: + type: string + example: Missing Authentication Token + status: + type: string + example: Failure + forbidden: + type: object + properties: + message: + type: string + example: Access Denied Unauthorized User + status: + type: string + example: Failure + paymentrequired: + type: object + properties: + message: + type: string + example: Insufficient Credits Kindly Top Up + status: + type: string + example: Failure + notfound: + type: object + properties: + message: + type: string + example: Invalid Request URL + status: + type: string + example: Failure + servererror: + type: object + properties: + message: + type: string + example: Internal Server Error + status: + type: string + example: Failure + gatewaytimeout: + type: object + properties: + message: + type: string + example: Request Timeout + status: + type: string + example: Failure + inputfieldmissing: + type: object + properties: + message: + type: string + example: Input Field Missing + status: + type: string + example: Failure + inputlimitexceeded: + type: object + properties: + message: + type: string + example: Input Limit Exceeded + status: + type: string + example: Failure + versions: + type: object + properties: + v1.0: + type: array + items: + oneOf: + - type: string + example: Published Date - Sep 30, 2020 + description: Updated version release v1.0 + v0.1: + type: array + items: + oneOf: + - type: string + example: Published Date - Nov 25,2019 + description: Initial version release + input: + type: object + required: + - text + properties: + text: + x-name: text + type: string + default: true + example: SINGAPORE - Immigration officers have issued 77 stay-home notices as of noon on Wednesday (Feb 19), 12 hours after the scheme kicked in.These notices were issued to Singapore residents, long-term pass holders and foreign workers who have travelled to mainland China in the last 14 days, said the Immigration and Checkpoints Authority (ICA) in response to queries on Thursday.Travellers from Hubei province are excluded from this scheme, as they are quarantined.Those who are issued the new notices, which took effect at 11.59pm on Tuesday, cannot leave their homes for 14 days./n This is stricter than the leave of absence (LOA), which allowed people to briefly leave their homes for necessities. LOA will no longer be issued.Those who do not observe the stay-home period can be prosecuted under the Infectious Diseases Act, warned the ICA.They could be fined up to $10,000 or jailed for up to six month, or both, for the first offence. For subsequent offences, this could go up to a maximum of $20,000 and up to a year. + description: |+ + Input text + securitySchemes: + APIAuthorizer: + type: apiKey + name: x-api-key + in: header + x-amazon-apigateway-authtype: custom + description: Authentication is done using the x-api-key in the request header diff --git a/yaml/named-entity_recognition_jap.yaml b/yaml/named-entity_recognition_jap.yaml index 51006eeec..129c98a1a 100644 --- a/yaml/named-entity_recognition_jap.yaml +++ b/yaml/named-entity_recognition_jap.yaml @@ -197,6 +197,13 @@ components: versions: type: object properties: + v1.0: + type: array + items: + oneOf: + - type: string + example: Published Date - May 19,2020 + description: Updated version release v1.0 v0.1: type: array items: diff --git a/yaml/named-entity_recognition_jap_v1.0.yaml b/yaml/named-entity_recognition_jap_v1.0.yaml new file mode 100644 index 000000000..8762caa31 --- /dev/null +++ b/yaml/named-entity_recognition_jap_v1.0.yaml @@ -0,0 +1,304 @@ +openapi: 3.0.1 +info: + title: Named-Entity Recognition JAP Updated + description: |+ + This NLP microservice locates and classifies the named-entities classes from input unstructured Japanese text. + + The named-entity classes extracted are persons, locations, organisations and miscellaneous. + + This microservice automatically extracts structured information from unstructured text data such as chatlogs, emails, news articles, etc. + version: '1.0' +servers: + - url: 'https://apis.sentient.io' +tags: +- name: "v1.0" + description: "Published Date - Sep 30, 2020" +paths: + /microservices/nlp/japanesener/v1.0/getpredictions: + post: + tags: + - v1.0 + responses: + '200': + description: success response + content: + application/json: + schema: + $ref: '#/components/schemas/success' + example: + message: Successfully Processed + results: + age: + - '56' + countx_other: + - 2稿 + - 8口 + doctrine_method_other: + - 険所コホ特室りょ + n_event: + - 受1 + numex_other: + - 百経 + ordinal_number: + - 30弾 + person: + - くぼ + - 壮 + - 琢紫 + - ナユ + product_other: + - 都合ヘラアニ限 + - 議帳 + show_organization: + - 左成相態 + status: Success + '401': + description: Unauthorized + content: + application/json: + schema: + $ref: '#/components/schemas/unauthorized' + '402': + description: Payment Required + content: + application/json: + schema: + $ref: '#/components/schemas/paymentrequired' + '403': + description: Forbidden + content: + application/json: + schema: + $ref: '#/components/schemas/forbidden' + '404': + description: Not Found + content: + application/json: + schema: + $ref: '#/components/schemas/notfound' + '419': + description: Input Field Missing + content: + application/json: + schema: + $ref: '#/components/schemas/inputfieldmissing' + '420': + description: Input Limit Exceeded + content: + application/json: + schema: + $ref: '#/components/schemas/inputlimitexceeded' + '500': + description: Internal Server Error + content: + application/json: + schema: + $ref: '#/components/schemas/servererror' + '504': + description: Gateway Timeout + content: + application/json: + schema: + $ref: '#/components/schemas/gatewaytimeout' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/input' + required: true + security: + - APIAuthorizer: [] +components: + schemas: + success: + type: object + properties: + results: + type: object + example: { "" } + description: Json Object of returned results + properties: + age: + type: array + items: + type: string + example: + - 56 + description: "age details found in the text string" + countx_other: + type: array + items: + type: string + example: + - 2稿 + - 8口 + description: "countx other details found in the text string" + doctrine_method_other: + type: array + items: + type: string + example: + - 険所コホ特室りょ + description: "doctrine method in the text string" + n_event: + type: array + items: + type: string + example: + - 受1 + description: "n_event in the text string" + numex_other: + type: array + items: + type: string + example: + - 受1 + description: "numex_other details found in the text string" + ordinal_number: + type: array + items: + type: string + example: + -30弾 + description: "ordinal_number details in the text string" + person: + type: array + items: + type: string + example: + - person + - 壮 + - 琢紫 + - ナユ + description: "person details found in the text string" + product_other: + type: array + items: + type: string + example: + - 都合ヘラアニ限 + - 議帳 + description: "product found in the text string" + show_organization: + type: array + items: + type: string + example: + - 左成相態 + description: "organization details found in the text string" + message: + type: string + example: Successfully Processed + description: Detail description on the API status + status: + type: string + example: Success + description: The status of the API call success/failure + unauthorized: + type: object + properties: + message: + type: string + example: Missing Authentication Token + status: + type: string + example: Failure + forbidden: + type: object + properties: + message: + type: string + example: Access Denied Unauthorized User + status: + type: string + example: Failure + paymentrequired: + type: object + properties: + message: + type: string + example: Insufficient Credits Kindly Top Up + status: + type: string + example: Failure + notfound: + type: object + properties: + message: + type: string + example: Invalid Request URL + status: + type: string + example: Failure + servererror: + type: object + properties: + message: + type: string + example: Internal Server Error + status: + type: string + example: Failure + gatewaytimeout: + type: object + properties: + message: + type: string + example: Request Timeout + status: + type: string + example: Failure + inputfieldmissing: + type: object + properties: + message: + type: string + example: Input Field Missing + status: + type: string + example: Failure + inputlimitexceeded: + type: object + properties: + message: + type: string + example: Input Limit Exceeded + status: + type: string + example: Failure + versions: + type: object + properties: + v1.0: + type: array + items: + oneOf: + - type: string + example: Published Date - Sep 30,2020 + description: Updated version release v1.0 + v0.1: + type: array + items: + oneOf: + - type: string + example: Published Date - May 19,2020 + description: Initial version release + input: + type: object + required: + - text + properties: + text: + x-name: text + type: string + default: true + example: 30弾ソイキ昇機マ了映だ店原いひ険所コホ特室りょくぼ都合ヘラアニ限2稿タチケア迷芸歌セ利講ルねひ詳績めかをぶ観提メエ府木ホフタ分不写ひフ妹検らし器増壮憶クわ。8口アユ琢紫ヨ理特ゆほス見百経イス図退ナユ介精しぜ議帳モテ受1中コハ載北早ぎのりや載裁風力壌ひろふ。運56済ぞ下写報スや来際おっはの学要ヘ手米真社つみよや非央で野館き肉待づぜフ次睡ルをが左成相態万えやろ。 + description: |+ + Input text + securitySchemes: + APIAuthorizer: + type: apiKey + name: x-api-key + in: header + x-amazon-apigateway-authtype: custom + description: Authentication is done using the x-api-key in the request header diff --git a/yaml/named-entity_recognition_thai.yaml b/yaml/named-entity_recognition_thai.yaml index b8e738ccd..a520675c1 100644 --- a/yaml/named-entity_recognition_thai.yaml +++ b/yaml/named-entity_recognition_thai.yaml @@ -179,6 +179,13 @@ components: versions: type: object properties: + v1.0: + type: array + items: + oneOf: + - type: string + example: Published Date - Aug 28,2020 + description: Updated version release v1.0 v0.1: type: array items: diff --git a/yaml/named-entity_recognition_thai_v1.0.yaml b/yaml/named-entity_recognition_thai_v1.0.yaml new file mode 100644 index 000000000..3a4a4acae --- /dev/null +++ b/yaml/named-entity_recognition_thai_v1.0.yaml @@ -0,0 +1,304 @@ +openapi: 3.0.1 +info: + title: Named-Entity Recognition THAI Updated + description: |+ + This NLP microservice locates and classifies the named-entities classes from input unstructured Thai text. + + The named-entity classes extracted are persons, locations, organisations and miscellaneous. + + This microservice automatically extracts structured information from unstructured text data such as chatlogs, emails, news articles, etc. + version: '1.0' +servers: + - url: 'https://apis.sentient.io' +tags: +- name: "v1.0" + description: "Published Date - Sep 30, 2020" +paths: + /microservices/nlp/thainer/v1.0/getpredictions: + post: + tags: + - v1.0 + responses: + '200': + description: success response + content: + application/json: + schema: + $ref: '#/components/schemas/success' + example: + message: Successfully Processed + results: + law: + - รัฐธรรมนูญ + location: + - ประเทศไทย + - มาเลเซีย + - ทะเลอันดามัน + - กรุงเทพมหานคร + - อินโดนีเซีย + - ราชอาณาจักรไทย + - อินเดียทางทะเลอันดามันทางตะวันตกเฉียงใต้ + - ลาวทางทิศตะวันออกติดกับลาว + - เอเชียตะวันออกเฉียงใต้ + - เวียดนาม + - ประเทศพม่า + - กัมพูชาทางทิศใต้ติดกับอ่าวไทย + organization: + - รัฐสภา + status: Success + '401': + description: Unauthorized + content: + application/json: + schema: + $ref: '#/components/schemas/unauthorized' + '402': + description: Payment Required + content: + application/json: + schema: + $ref: '#/components/schemas/paymentrequired' + '403': + description: Forbidden + content: + application/json: + schema: + $ref: '#/components/schemas/forbidden' + '404': + description: Not Found + content: + application/json: + schema: + $ref: '#/components/schemas/notfound' + '419': + description: Input Field Missing + content: + application/json: + schema: + $ref: '#/components/schemas/inputfieldmissing' + '420': + description: Input Limit Exceeded + content: + application/json: + schema: + $ref: '#/components/schemas/inputlimitexceeded' + '500': + description: Internal Server Error + content: + application/json: + schema: + $ref: '#/components/schemas/servererror' + '504': + description: Gateway Timeout + content: + application/json: + schema: + $ref: '#/components/schemas/gatewaytimeout' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/input' + required: true + security: + - APIAuthorizer: [] +components: + schemas: + success: + type: object + properties: + results: + type: object + example: { "" } + description: Json Object of returned results + properties: + law: + x-name: law + type: array + example: [พ.ร.บ.โรคระบาด พ.ศ.2499, รัฐธรรมนูญ] + description: "law details found in the text string" + location: + x-name: location + type: array + example: + - ประเทศไทย + - มาเลเซีย + - ทะเลอันดามัน + - กรุงเทพมหานคร + - อินโดนีเซีย + - ราชอาณาจักรไทย + - อินเดียทางทะเลอันดามันทางตะวันตกเฉียงใต้ + - ลาวทางทิศตะวันออกติดกับลาว + - เอเชียตะวันออกเฉียงใต้ + - เวียดนาม + - ประเทศพม่า + - กัมพูชาทางทิศใต้ติดกับอ่าวไทย + description: "location found in the text string" + organization: + x-name: organization + type: array + example: + - รัฐสภา + description: "organization found in the text string" + date: + x-name: date + type: array + example: [2/21/2004, 16 ก.พ., จันทร์] + description: "date found in the text string" + money: + x-name: money + type: array + example: [2.7 ล้านบาท, 2,000 บาท] + description: "amount of currency found in the text string" + time: + x-name: time + type: array + example: [16.30 น., 5 วัน, 1-3 ปี] + description: "time found in the text string" + email: + x-name: email + type: array + example: [info@nrpsc.ac.th] + description: "email id found in the text string" + len: + x-name: len + type: array + example: [30 กิโลเมตร, 5 กม.] + description: "distance in km found in the text string" + person: + x-name: person + type: array + example: [น.พ.จรัล, นางประนอม ทองจันทร์] + description: "name of person found in the text string" + phone: + x-name: phone + type: array + example: [0 2670 8888] + description: "date found in the text string" + url: + x-name: url + type: array + example: [http://www.bangkokhealth.com/] + description: "url in the text string" + zip: + x-name: zip + type: array + example: [10400] + description: "zipcode found in the text string" + + message: + type: string + example: Successfully Processed + description: Detail description on the API status + status: + type: string + example: Success + description: The status of the API call success/failure + unauthorized: + type: object + properties: + message: + type: string + example: Missing Authentication Token + status: + type: string + example: Failure + forbidden: + type: object + properties: + message: + type: string + example: Access Denied Unauthorized User + status: + type: string + example: Failure + paymentrequired: + type: object + properties: + message: + type: string + example: Insufficient Credits Kindly Top Up + status: + type: string + example: Failure + notfound: + type: object + properties: + message: + type: string + example: Invalid Request URL + status: + type: string + example: Failure + servererror: + type: object + properties: + message: + type: string + example: Internal Server Error + status: + type: string + example: Failure + gatewaytimeout: + type: object + properties: + message: + type: string + example: Request Timeout + status: + type: string + example: Failure + inputfieldmissing: + type: object + properties: + message: + type: string + example: Input Field Missing + status: + type: string + example: Failure + inputlimitexceeded: + type: object + properties: + message: + type: string + example: Input Limit Exceeded + status: + type: string + example: Failure + versions: + type: object + properties: + v1.0: + type: array + items: + oneOf: + - type: string + example: Published Date - Sep 30,2020 + description: Updated version release v1.0 + v0.1: + type: array + items: + oneOf: + - type: string + example: Published Date - Aug 28,2020 + description: Initial version release + input: + type: object + required: + - text + properties: + text: + x-name: text + type: string + default: true + example: ประเทศไทย [a] ราชอาณาจักรไทยอย่างเป็นทางการและมีชื่อเดิมว่าสยาม [b] เป็นประเทศในเอเชียตะวันออกเฉียงใต้ ตั้งอยู่ที่ใจกลางคาบสมุทรอินโดจีนประกอบด้วย 76 จังหวัดและครอบคลุมพื้นที่ 513,120 ตารางกิโลเมตร (198,120 ตารางไมล์) และมีประชากรมากกว่า 66 ล้านคน [4] ประเทศไทยเป็นประเทศที่มีพื้นที่ทางบกมากเป็นอันดับที่ 50ของโลกและเป็นประเทศที่มีประชากรมากที่สุดเป็นอันดับที่ 22 ของโลก เมืองหลวงและเมืองที่ใหญ่ที่สุดคือกรุงเทพมหานครซึ่งเป็นเขตปกครองพิเศษ ประเทศไทยมีพรมแดนติดทางทิศเหนือติดกับเมียนมาร์และลาวทางทิศตะวันออกติดกับลาวและกัมพูชาทางทิศใต้ติดกับอ่าวไทยและมาเลเซียและทางทิศตะวันตกติดกับทะเลอันดามันและทางตอนใต้ของประเทศพม่า พรมแดนทางทะเล ได้แก่ เวียดนามในอ่าวไทยทางตะวันออกเฉียงใต้และอินโดนีเซียและอินเดียทางทะเลอันดามันทางตะวันตกเฉียงใต้ ประเทศไทยเป็นระบอบรัฐธรรมนูญและประชาธิปไตยแบบรัฐสภา อย่างไรก็ตามในประวัติศาสตร์ที่ผ่านมารัฐบาลของตนต้องเผชิญกับการรัฐประหารหลายครั้งและช่วงเวลาแห่งการปกครองแบบเผด็จการทหารย เวลา + description: |+ + Input text + securitySchemes: + APIAuthorizer: + type: apiKey + name: x-api-key + in: header + x-amazon-apigateway-authtype: custom + description: Authentication is done using the x-api-key in the request header diff --git a/yaml/newspaper_article_scraper.yaml b/yaml/newspaper_article_scraper.yaml index 895356ff2..058fc1679 100644 --- a/yaml/newspaper_article_scraper.yaml +++ b/yaml/newspaper_article_scraper.yaml @@ -41,7 +41,7 @@ paths: - worlds language: en link: https://www.bangkokpost.com/learning/news/1272315/study-and-work-in-australia-%E2%80%93-many-opportunities-ahead- - publish_date: [] + publish_date: 2020-09-30T07:11:15 summary: |- Australia is a country welcoming international students to study at all levels of education with its quality and the part-time work rights given. Moreover, there are opportunities to work full-time and to migrate and hold Australian citizenship after graduation from Australia. @@ -168,7 +168,7 @@ components: description: Main article link url. publish_date: type: string - example: [] + example: 2020-09-30T07:11:15 description: Published date of news article. summary: type: string @@ -292,7 +292,7 @@ components: type: string example: https://www.bangkokpost.com/learning/news/1272315/study-and-work-in-australia-%E2%80%93-many-opportunities-ahead default: true - description: News article web URL. + description: The absolute input url, i.e exact, full address (URL) to the page securitySchemes: APIAuthorizer: type: apiKey diff --git a/yaml/page_profiler_eng.yaml b/yaml/page_profiler_eng.yaml index af0754cce..92acd5cec 100644 --- a/yaml/page_profiler_eng.yaml +++ b/yaml/page_profiler_eng.yaml @@ -176,7 +176,16 @@ status: type: string example: Failure - + versions: + type: object + properties: + v1.0: + type: array + items: + oneOf: + - type: string + example: Published Date - Apr 11, 2018 + description: Initial version release input: type: object required: @@ -188,7 +197,7 @@ default: true example: https://www.sentient.io/en/ description: |+ - Input url + The absolute input url, i.e exact, full address (URL) to the page securitySchemes: APIAuthorizer: diff --git a/yaml/page_profiler_eng_v2.0.yaml b/yaml/page_profiler_eng_v2.0.yaml new file mode 100644 index 000000000..0cadd52d6 --- /dev/null +++ b/yaml/page_profiler_eng_v2.0.yaml @@ -0,0 +1,227 @@ + openapi: 3.0.1 + info: + title: Page Profiler ENG + description: |+ + This NLP microservice retrieves web content in English from the input URL. + + From the web content, the microservice then applies natural language processing to extracts named-entities and returns the output. + + The named-entity classes extracted are persons, locations, organisations and miscellaneous.

This microservice automatically extracts structured information from unstructured text data such as chatlogs, emails, news articles, etc. + version: '2.0' + servers: + - url: 'https://apis.sentient.io' + tags: + - name: "v2.0" + description: "Published Date - Sep 30, 2020" + paths: + /microservices/nlp/pageprofiler/v2.0/getpredictions: + post: + tags: + - v2.0 + responses: + '200': + description: success response + content: + application/json: + schema: + $ref: '#/components/schemas/success' + example: {"message":"SuccessfullyProcessed","results":{"loc":["Hubei","Singapore","SINGAPORE","China","Immigration"],"misc":["ICA.They"],"org":["ImmigrationandCheckpointsAuthority","ICA","LOA"]},"status":"Success"} + '401': + description: Unauthorized + content: + application/json: + schema: + $ref: '#/components/schemas/unauthorized' + '402': + description: Payment Required + content: + application/json: + schema: + $ref: '#/components/schemas/paymentrequired' + '403': + description: Forbidden + content: + application/json: + schema: + $ref: '#/components/schemas/forbidden' + '404': + description: Not Found + content: + application/json: + schema: + $ref: '#/components/schemas/notfound' + '419': + description: Not Found + content: + application/json: + schema: + $ref: '#/components/schemas/inputfieldmissing' + '420': + description: Not Found + content: + application/json: + schema: + $ref: '#/components/schemas/inputlimitexceeded' + '500': + description: Internal Server Error + content: + application/json: + schema: + $ref: '#/components/schemas/servererror' + '504': + description: Gateway Timeout + content: + application/json: + schema: + $ref: '#/components/schemas/gatewaytimeout' + security: + - APIAuthorizer: [] + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/input' + required: true + components: + schemas: + success: + type: object + properties: + results: + type: object + example: { "" } + description: Json Object of returned results + properties: + loc: + type: array + example: ["Nat","Sentient.io","Home","Inte","CONTACT","Join"] + description: "name of location found in the text string" + misc: + type: array + example: ["Sentient.io","English"] + description: "name of misc found in the text string" + org: + type: array + example: ["Our Clients","AI","APIs","Sentient.io","Our Technology Partners","Named Entity Recognition","Our Investors"] + description: "name of org found in the text string" + per: + type: array + example: ["Sentient.io","Speech","LinkedIn"] + description: "name of persons found in the text string" + message: + type: string + example: Successfully Processed + description: Detail description on the API status + status: + type: string + example: Success + description: The status of the API call success/failure + unauthorized: + type: object + properties: + message: + type: string + example: Missing Authentication Token + status: + type: string + example: Failure + forbidden: + type: object + properties: + message: + type: string + example: Access Denied Unauthorized User + status: + type: string + example: Failure + paymentrequired: + type: object + properties: + message: + type: string + example: Insufficient Credits Kindly Top Up + status: + type: string + example: Failure + notfound: + type: object + properties: + message: + type: string + example: Invalid Request URL + status: + type: string + example: Failure + servererror: + type: object + properties: + message: + type: string + example: Internal Server Error + status: + type: string + example: Failure + gatewaytimeout: + type: object + properties: + message: + type: string + example: Request Timeout + status: + type: string + example: Failure + inputfieldmissing: + type: object + properties: + message: + type: string + example: Input Field Missing + status: + type: string + example: Failure + inputlimitexceeded: + type: object + properties: + message: + type: string + example: Input Limit Exceeded + status: + type: string + example: Failure + versions: + type: object + properties: + v2.0: + type: array + items: + oneOf: + - type: string + example: Published Date - Sep 30, 2020 + description: Updated version release + v1.0: + type: array + items: + oneOf: + - type: string + example: Published Date - Apr 11, 2018 + description: Initial version release + input: + type: object + required: + - url + properties: + url: + x-name: url + type: string + default: true + example: https://www.sentient.io/en/ + description: |+ + The absolute input url, i.e exact, full address (URL) to the page + + securitySchemes: + APIAuthorizer: + type: apiKey + name: x-api-key + in: header + x-amazon-apigateway-authtype: custom + description: Authentication is done using the x-api-key in the request header diff --git a/yaml/page_profiler_jp.yaml b/yaml/page_profiler_jp.yaml new file mode 100644 index 000000000..876e8df39 --- /dev/null +++ b/yaml/page_profiler_jp.yaml @@ -0,0 +1,242 @@ + openapi: 3.0.1 + info: + title: Page Profiler JAP + description: |+ + This NLP microservice retrieves web content in Japanese from the input URL. From the web content, the microservice then applies natural language processing to extracts named-entities and returns the output. + + The named-entity classes extracted are persons, locations, organisations and miscellaneous. + + This microservice automatically extracts structured information from unstructured text data such as chatlogs, emails, news articles, etc. + version: '0.1' + servers: + - url: 'https://apis.sentient.io' + tags: + - name: "v0.1" + description: "Published Date - Sep 30, 2020" + paths: + /microservices/nlp/pageprofilerjp/v0.1/getpredictions: + post: + tags: + - v0.1 + responses: + '200': + description: success response + content: + application/json: + schema: + $ref: '#/components/schemas/success' + example: + message: Successfully Processed + results: + company: + - 和歌山製鉄所 + date: + - 7日,2023年9月 + - 22年9月 + domestic_region: + - 呉製鉄所 + material: + - 鉄鋼最大手 + n_product: + - 高炉2基 + - 2基","1基 + province: + - 広島県呉市 + - 和歌山市 + status: Success + '401': + description: Unauthorized + content: + application/json: + schema: + $ref: '#/components/schemas/unauthorized' + '402': + description: Payment Required + content: + application/json: + schema: + $ref: '#/components/schemas/paymentrequired' + '403': + description: Forbidden + content: + application/json: + schema: + $ref: '#/components/schemas/forbidden' + '404': + description: Not Found + content: + application/json: + schema: + $ref: '#/components/schemas/notfound' + '419': + description: Not Found + content: + application/json: + schema: + $ref: '#/components/schemas/inputfieldmissing' + '420': + description: Not Found + content: + application/json: + schema: + $ref: '#/components/schemas/inputlimitexceeded' + '500': + description: Internal Server Error + content: + application/json: + schema: + $ref: '#/components/schemas/servererror' + '504': + description: Gateway Timeout + content: + application/json: + schema: + $ref: '#/components/schemas/gatewaytimeout' + security: + - APIAuthorizer: [] + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/input' + required: true + components: + schemas: + success: + type: object + properties: + results: + type: object + example: { "" } + description: Json Object of returned results + properties: + Company: + x-name: Company + type: array + example: [ 和歌山製鉄所 ] + description: name of Company found in the text string + Date: + x-name: Date + type: array + example: [ 7日,2023年9月,22年9月 ] + description: name of Date found in the text string + Domestic_Region: + x-name: Domestic_Region + type: array + example: [ 呉製鉄所 ] + description: name of Domestic_Region found in the text string + Material: + x-name: Material + type: array + example: [ 鉄鋼最大手 ] + description: name of Material found in the text string + message: + type: string + example: Successfully Processed + description: Detail description on the API status + status: + type: string + example: Success + description: The status of the API call success/failure + + unauthorized: + type: object + properties: + message: + type: string + example: Missing Authentication Token + status: + type: string + example: Failure + forbidden: + type: object + properties: + message: + type: string + example: Access Denied Unauthorized User + status: + type: string + example: Failure + paymentrequired: + type: object + properties: + message: + type: string + example: Insufficient Credits Kindly Top Up + status: + type: string + example: Failure + notfound: + type: object + properties: + message: + type: string + example: Invalid Request URL + status: + type: string + example: Failure + servererror: + type: object + properties: + message: + type: string + example: Internal Server Error + status: + type: string + example: Failure + gatewaytimeout: + type: object + properties: + message: + type: string + example: Request Timeout + status: + type: string + example: Failure + inputfieldmissing: + type: object + properties: + message: + type: string + example: Input Field Missing + status: + type: string + example: Failure + inputlimitexceeded: + type: object + properties: + message: + type: string + example: Input Limit Exceeded + status: + type: string + example: Failure + versions: + type: object + properties: + v0.1: + type: array + items: + oneOf: + - type: string + example: Published Date - Sep 30, 2020 + description: Initial version release + input: + type: object + required: + - url + properties: + url: + x-name: url + type: string + default: true + example: https://www.bbc.com/japanese + description: |+ + The absolute input url, i.e exact, full address (URL) to the page + securitySchemes: + APIAuthorizer: + type: apiKey + name: x-api-key + in: header + x-amazon-apigateway-authtype: custom + description: Authentication is done using the x-api-key in the request header diff --git a/yaml/page_profiler_thai.yaml b/yaml/page_profiler_thai.yaml new file mode 100644 index 000000000..cb0fb7bb6 --- /dev/null +++ b/yaml/page_profiler_thai.yaml @@ -0,0 +1,255 @@ + openapi: 3.0.1 + info: + title: Page Profiler THAI + description: |+ + This NLP microservice retrieves web content in Thai from the input URL. From the web content, the microservice then applies natural language processing to extracts named-entities and returns the output. + + The named-entity classes extracted are persons, locations, organisations and miscellaneous. + + This microservice automatically extracts structured information from unstructured text data such as chatlogs, emails, news articles, etc. + version: '1.0' + servers: + - url: 'https://apis.sentient.io' + tags: + - name: "v0.1" + description: "Published Date - Sep 30, 2020" + paths: + /microservices/nlp/pageprofilerthai/v0.1/getpredictions: + post: + tags: + - v0.1 + responses: + '200': + description: success response + content: + application/json: + schema: + $ref: '#/components/schemas/success' + example: + message: Successfully Processed + results: + law: + - รุ้ง" จัดกิจกรรม"ตามหานาย" หน้ากองพันทหารม้าที่ 4 กองพล 1 รอ.ทวงถามความรับผิดชอบ + 28 กันยายน 2563 + ติดต่อโฆษณาออนไลน์ Worarak + location: + - กทม. + - เมียนมา + - อินเดีย + - ไทย + money: + - 7หมื่นชิ้น + - 33 ล้าน + organization: + - ทัพเพื่อไทย + - กรมอุตุฯ + - รฟม. + - มหาดไทย + - ปธ.อำนวยการ + person: + - น้องวีจิ + - สักงูเขียว รับผิดขอโทษ + - บิ๊กตู่ + - มาดามเดียร์"ติงนโยบายยกเว้นภาษี เปิดช่องรร.ทำกำไร + - ชูศักดิ์ + - รร.สารสาสน์ + - บิ๊กบราเธอร์" + - ครูจุ๋ม' + - ครูจุ๋ม" + status: Success + + '401': + description: Unauthorized + content: + application/json: + schema: + $ref: '#/components/schemas/unauthorized' + '402': + description: Payment Required + content: + application/json: + schema: + $ref: '#/components/schemas/paymentrequired' + '403': + description: Forbidden + content: + application/json: + schema: + $ref: '#/components/schemas/forbidden' + '404': + description: Not Found + content: + application/json: + schema: + $ref: '#/components/schemas/notfound' + '419': + description: Not Found + content: + application/json: + schema: + $ref: '#/components/schemas/inputfieldmissing' + '420': + description: Not Found + content: + application/json: + schema: + $ref: '#/components/schemas/inputlimitexceeded' + '500': + description: Internal Server Error + content: + application/json: + schema: + $ref: '#/components/schemas/servererror' + '504': + description: Gateway Timeout + content: + application/json: + schema: + $ref: '#/components/schemas/gatewaytimeout' + security: + - APIAuthorizer: [] + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/input' + required: true + components: + schemas: + success: + type: object + properties: + results: + type: object + example: { "" } + description: Json Object of returned results + properties: + location: + x-name: location + type: array + example: [ สหรัฐอเมริ ] + description: name of location found in the text string + + person: + x-name: person + type: array + example: [ ประธานาธิบดีทร ] + description: name of person found in the text string + message: + type: string + example: Successfully Processed + description: Detail description on the API status + status: + type: string + example: Success + description: The status of the API call success/failure + message: + type: string + example: Successfully Processed + description: Detail description on the API status + status: + type: string + example: Success + description: The status of the API call success/failure + unauthorized: + type: object + properties: + message: + type: string + example: Missing Authentication Token + status: + type: string + example: Failure + forbidden: + type: object + properties: + message: + type: string + example: Access Denied Unauthorized User + status: + type: string + example: Failure + paymentrequired: + type: object + properties: + message: + type: string + example: Insufficient Credits Kindly Top Up + status: + type: string + example: Failure + notfound: + type: object + properties: + message: + type: string + example: Invalid Request URL + status: + type: string + example: Failure + servererror: + type: object + properties: + message: + type: string + example: Internal Server Error + status: + type: string + example: Failure + gatewaytimeout: + type: object + properties: + message: + type: string + example: Request Timeout + status: + type: string + example: Failure + inputfieldmissing: + type: object + properties: + message: + type: string + example: Input Field Missing + status: + type: string + example: Failure + inputlimitexceeded: + type: object + properties: + message: + type: string + example: Input Limit Exceeded + status: + type: string + example: Failure + versions: + type: object + properties: + v0.1: + type: array + items: + oneOf: + - type: string + example: Published Date - Sep 30, 2020 + description: Initial version release + input: + type: object + required: + - url + properties: + url: + x-name: url + type: string + default: true + example: https://www.komchadluek.net/ + description: |+ + The absolute input url, i.e exact, full address (URL) to the page + + securitySchemes: + APIAuthorizer: + type: apiKey + name: x-api-key + in: header + x-amazon-apigateway-authtype: custom + description: Authentication is done using the x-api-key in the request header diff --git a/yaml/spacy_named-entity_recognition_eng.yaml b/yaml/spacy_named-entity_recognition_eng.yaml new file mode 100644 index 000000000..50fc2fbd1 --- /dev/null +++ b/yaml/spacy_named-entity_recognition_eng.yaml @@ -0,0 +1,298 @@ +openapi: 3.0.1 +info: + title: spaCy NER + description: |+ + This NLP microservice locates and classifies the named-entities classes from input unstructured English text. + + The named-entity classes extracted are + person, norp, fac, org, gpe, loc, product, event, work_of_art, law, language, date, time, percent, money, quantity, ordinal, cardinal + + This microservice automatically extracts structured information from unstructured text data such as chatlogs, emails, news articles, etc. + version: '0.1' +servers: + - url: 'https://apis.sentient.io' +tags: +- name: "v0.1" + description: "Published Date - Sep 30, 2020" +paths: + /microservices/nlp/spacyner/v0.1/getpredictions: + post: + tags: + - v0.1 + responses: + '200': + description: success response + content: + application/json: + schema: + $ref: '#/components/schemas/success' + example: {"message": "Successfully Processed","results": {"fac": ["Changi Airport","the first Airport"],"gpe": ["Changi","Singapore"],"loc": ["Marina Bay","Asia"],"org": ["WSSS","BOC Aviation","Jetstar Asia Airways","Changi Airport Group","FAA","Skytrax","ICAO","the World's Best Airport"],"quantity": ["5.0 sq mi","approximately 20 km"]},"status": "Success"} + '401': + description: Unauthorized + content: + application/json: + schema: + $ref: '#/components/schemas/unauthorized' + '402': + description: Payment Required + content: + application/json: + schema: + $ref: '#/components/schemas/paymentrequired' + '403': + description: Forbidden + content: + application/json: + schema: + $ref: '#/components/schemas/forbidden' + '404': + description: Not Found + content: + application/json: + schema: + $ref: '#/components/schemas/notfound' + '419': + description: Input Field Missing + content: + application/json: + schema: + $ref: '#/components/schemas/inputfieldmissing' + '420': + description: Input Limit Exceeded + content: + application/json: + schema: + $ref: '#/components/schemas/inputlimitexceeded' + '500': + description: Internal Server Error + content: + application/json: + schema: + $ref: '#/components/schemas/servererror' + '504': + description: Gateway Timeout + content: + application/json: + schema: + $ref: '#/components/schemas/gatewaytimeout' + security: + - APIAuthorizer: [] + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/input' + required: true +components: + schemas: + success: + type: object + properties: + results: + type: object + example: { "" } + description: Json Object of returned results + properties: + person: + x-name: person + type: array + example: [DONALD TRUMP,Mike Pompeo] + description: People, including fictional. + norp: + x-name: norp + type: array + example: [Chinese,Singaporean,Malay] + description: Nationalities or religious or political groups. + fac: + x-name: fac + type: array + example: [Changi Airport, the first Airport] + description: Buildings, airports, highways, bridges, etc. + org: + x-name: org + type: array + example: [WSSS,BOC Aviation] + description: Companies, agencies, institutions, etc. + gpe: + x-name: gpe + type: array + example: [Changi,Singapore] + description: Countries, cities, states. + loc: + x-name: loc + type: array + example: [Marina Bay, Asia] + description: Non-GPE locations, mountain ranges, bodies of water. + product: + x-name: product + type: array + example: [Formula 1,Motorrad] + description: Objects, vehicles, foods, etc. (Not services.) + event: + x-name: event + type: array + example: [the Second World War] + description: Named hurricanes, battles, wars, sports events, etc. + work_of_art: + x-name: work_of_art + type: array + example: [Wizardry] + description: Titles of books, songs, etc. + law: + x-name: law + type: array + example: [the Penal Code,the Internal Security Act,the Constitution of the Republic of Singapore",the Evidence Act,the Societies Act] + description: Named documents made into laws. + language: + x-name: language + type: array + example: [English] + description: Any named language. + date: + x-name: date + type: array + example: [Tuesday] + description: Absolute or relative dates or periods. + time: + x-name: time + type: array + example: [twenty-four hours] + description: Times smaller than a day. + percent: + x-name: percent + type: array + example: [91%,25%,61%] + description: Percentage, including ”%“. + money: + x-name: money + type: array + example: [up to $1000] + description: Monetary values, including unit. + quantity: + x-name: quantity + type: array + example: [about one degree,85 miles,137 kilometres] + description: Measurements, as of weight or distance. + ordinal: + x-name: ordinal + type: array + example: [ninth,seventh,second] + description: “first”, “second”, etc. + cardinal: + x-name: cardinal + type: array + example: [four] + description: Numerals that do not fall under another type. + message: + x-name: message + type: string + example: Successfully Processed + description: Detail description on the API status + + status: + x-name: status + type: string + example: Success + description: The status of the API call success/failure + + unauthorized: + type: object + properties: + message: + type: string + example: Missing Authentication Token + status: + type: string + example: Failure + forbidden: + type: object + properties: + message: + type: string + example: Access Denied Unauthorized User + status: + type: string + example: Failure + paymentrequired: + type: object + properties: + message: + type: string + example: Insufficient Credits Kindly Top Up + status: + type: string + example: Failure + notfound: + type: object + properties: + message: + type: string + example: Invalid Request URL + status: + type: string + example: Failure + servererror: + type: object + properties: + message: + type: string + example: Internal Server Error + status: + type: string + example: Failure + gatewaytimeout: + type: object + properties: + message: + type: string + example: Request Timeout + status: + type: string + example: Failure + inputfieldmissing: + type: object + properties: + message: + type: string + example: Input Field Missing + status: + type: string + example: Failure + inputlimitexceeded: + type: object + properties: + message: + type: string + example: Input Limit Exceeded + status: + type: string + example: Failure + versions: + type: object + properties: + v0.1: + type: array + items: + oneOf: + - type: string + example: Published Date - Sep 30, 2020 + description: Initial version release + input: + type: object + required: + - text + properties: + text: + x-name: text + type: string + default: true + example: "Singapore Changi Airport, commonly known as Changi Airport (IATA: SIN, ICAO: WSSS, FAA LID: SIN), is a major civilian airport that serves Singapore, and is one of the largest transportation hubs in Asia. As one of the world's busiest airports by international passenger and cargo traffic, it is currently rated the World's Best Airport by Skytrax, the first Airport in the world to do so for eight consecutive years.[10][11] It has also been rated as the one of the world's cleanest airports and highly rated international transit airports.[12][13]The airport is located in Changi, at the eastern end of Singapore, approximately 20 km (12 mi)[14] from Marina Bay (Singapore's Downtown Core), on a 13-square-kilometre (5.0 sq mi) site. The airport is operated by Changi Airport Group and it is the home base of Singapore Airlines,[15] Singapore Airlines Cargo,[15] SilkAir,[15] Scoot, Jetstar Asia Airways and BOC Aviation." + description: |+ + Input text + securitySchemes: + APIAuthorizer: + type: apiKey + name: x-api-key + in: header + x-amazon-apigateway-authtype: custom + description: Authentication is done using the x-api-key in the request header diff --git a/yaml/web_scraper.yaml b/yaml/web_scraper.yaml index 0a82c02db..8bf412b25 100644 --- a/yaml/web_scraper.yaml +++ b/yaml/web_scraper.yaml @@ -302,7 +302,7 @@ components: type: string default: true example: https://www.bbc.co.uk - description: Web page URL + description: The absolute input url, i.e exact, full address (URL) to the page queryList: type: array default: false From 61c69062eb3e5b9712ae661e42714b71d7b86366 Mon Sep 17 00:00:00 2001 From: Priyadharshini <57977344+priyadharshini-sent@users.noreply.github.com> Date: Wed, 30 Sep 2020 14:43:01 +0530 Subject: [PATCH 019/792] Update index.yaml --- yaml/index.yaml | 33 +++++++++++++++++++++++++++++++++ 1 file changed, 33 insertions(+) diff --git a/yaml/index.yaml b/yaml/index.yaml index 9679e18a1..1bc3d6114 100644 --- a/yaml/index.yaml +++ b/yaml/index.yaml @@ -39,11 +39,25 @@ NLP: Named-Entity Recognition ENG: title: Named-Entity Recognition ENG versions: + v1.0: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/named-entity_recognition_eng_v1.0.yaml" v0.1: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/named-entity_recognition_eng.yaml" + spaCy NER: + title: spaCy NER + versions: + v0.1: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/spacy_named-entity_recognition_eng.yaml" Page Profiler ENG: title: Page Profiler ENG versions: + v2.0: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/page_profiler_eng_v2.0.yaml" v1.0: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/page_profiler_eng.yaml" + Page Profiler JAP: + title: Page Profiler JAP + versions: + v0.1: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/page_profiler_jp.yaml" + Page Profiler THAI: + title: Page Profiler THAI + versions: + v0.1: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/page_profiler_thai.yaml" Taxonomy Matcher ENG: title: Taxonomy Matcher ENG versions: @@ -55,10 +69,12 @@ NLP: Named-Entity Recognition JAP: title: Named-Entity Recognition JAP versions: + v1.0: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/named-entity_recognition_jap_v1.0.yaml" v0.1: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/named-entity_recognition_jap.yaml" Named Entity Recognition THAI: title: Named Entity Recognition THAI versions: + v1.0: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/named-entity_recognition_thai_v1.0.yaml" v0.1: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/named-entity_recognition_thai.yaml" Script Alignment: title: Script Alignment @@ -195,8 +211,25 @@ Data: title: HDB Shelters Locations (SG) versions: v0.1: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/amenities_shelters_hdb_sg.yaml" + Business Check Plus Dun & Bradstreet (SG): + title: Business Check Plus Dun & Bradstreet (SG) + versions: + v0.1: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/BusinessCheckPlusDun&Bradstreet(SG).yaml" + Basic Individual Search Dun & Bradstreet (SG): + title: Basic Individual Search Dun & Bradstreet (SG) + versions: + v0.1: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/BasicIndividualSearchDun&Bradstreet(SG).yaml" + Business Check Dun & Bradstreet (SG): + title: Business Check Dun & Bradstreet (SG) + versions: + v0.1: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/BusinessCheckDun&Bradstreet(SG).yaml" + Brief Financial Extraction Dun & Bradstreet (SG): + title: Brief Financial Extraction Dun & Bradstreet (SG) + versions: + v0.1: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/BriefFinancialExtractionDun&Bradstreet(SG).yaml" Data Alliance: Download Dataset API: title: Download Dataset API + urlkey: download_dataset_api versions: v0.1: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/download_dataset.yaml" From 093e8e989afbf1a1fb71768b27920dbce1137fbb Mon Sep 17 00:00:00 2001 From: priyaPeristera Date: Wed, 30 Sep 2020 20:15:42 +1000 Subject: [PATCH 020/792] Update and rename named-entity_recognition_jap_v1.0.yaml to named-entity_recognition_jp_v1.0.yaml --- ...tion_jap_v1.0.yaml => named-entity_recognition_jp_v1.0.yaml} | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) rename yaml/{named-entity_recognition_jap_v1.0.yaml => named-entity_recognition_jp_v1.0.yaml} (99%) diff --git a/yaml/named-entity_recognition_jap_v1.0.yaml b/yaml/named-entity_recognition_jp_v1.0.yaml similarity index 99% rename from yaml/named-entity_recognition_jap_v1.0.yaml rename to yaml/named-entity_recognition_jp_v1.0.yaml index 8762caa31..ebc0de9db 100644 --- a/yaml/named-entity_recognition_jap_v1.0.yaml +++ b/yaml/named-entity_recognition_jp_v1.0.yaml @@ -1,6 +1,6 @@ openapi: 3.0.1 info: - title: Named-Entity Recognition JAP Updated + title: Named-Entity Recognition JP description: |+ This NLP microservice locates and classifies the named-entities classes from input unstructured Japanese text. From 99b9a31c8c42d93bdcd5c597851c5baa345cf8b5 Mon Sep 17 00:00:00 2001 From: priyaPeristera Date: Wed, 30 Sep 2020 20:16:19 +1000 Subject: [PATCH 021/792] Update and rename named-entity_recognition_jap.yaml to named-entity_recognition_jp.yaml --- ...ty_recognition_jap.yaml => named-entity_recognition_jp.yaml} | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) rename yaml/{named-entity_recognition_jap.yaml => named-entity_recognition_jp.yaml} (99%) diff --git a/yaml/named-entity_recognition_jap.yaml b/yaml/named-entity_recognition_jp.yaml similarity index 99% rename from yaml/named-entity_recognition_jap.yaml rename to yaml/named-entity_recognition_jp.yaml index 129c98a1a..d2b172041 100644 --- a/yaml/named-entity_recognition_jap.yaml +++ b/yaml/named-entity_recognition_jp.yaml @@ -1,6 +1,6 @@ openapi: 3.0.1 info: - title: Named-Entity Recognition JAP + title: Named-Entity Recognition JP description: |+ This NLP microservice locates and classifies the named-entities classes from input unstructured Japanese text. From 1dc88e63d8a338a49dbfb40696014192828405ea Mon Sep 17 00:00:00 2001 From: priyaPeristera Date: Wed, 30 Sep 2020 20:16:42 +1000 Subject: [PATCH 022/792] Update page_profiler_jp.yaml --- yaml/page_profiler_jp.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/yaml/page_profiler_jp.yaml b/yaml/page_profiler_jp.yaml index 876e8df39..e39af22af 100644 --- a/yaml/page_profiler_jp.yaml +++ b/yaml/page_profiler_jp.yaml @@ -1,6 +1,6 @@ openapi: 3.0.1 info: - title: Page Profiler JAP + title: Page Profiler JP description: |+ This NLP microservice retrieves web content in Japanese from the input URL. From the web content, the microservice then applies natural language processing to extracts named-entities and returns the output. From cc490b7679ff59a8525123ddf08581e6eb0600a5 Mon Sep 17 00:00:00 2001 From: priyaPeristera Date: Wed, 30 Sep 2020 20:17:18 +1000 Subject: [PATCH 023/792] Update index.yaml --- yaml/index.yaml | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/yaml/index.yaml b/yaml/index.yaml index 1bc3d6114..033e81460 100644 --- a/yaml/index.yaml +++ b/yaml/index.yaml @@ -50,8 +50,8 @@ NLP: versions: v2.0: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/page_profiler_eng_v2.0.yaml" v1.0: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/page_profiler_eng.yaml" - Page Profiler JAP: - title: Page Profiler JAP + Page Profiler JP: + title: Page Profiler JP versions: v0.1: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/page_profiler_jp.yaml" Page Profiler THAI: @@ -66,11 +66,11 @@ NLP: title: Word Sense Disambiguation ENG versions: v0.1: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/word_sense_disambiguation_eng.yaml" - Named-Entity Recognition JAP: + Named-Entity Recognition JP: title: Named-Entity Recognition JAP versions: - v1.0: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/named-entity_recognition_jap_v1.0.yaml" - v0.1: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/named-entity_recognition_jap.yaml" + v1.0: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/named-entity_recognition_jp_v1.0.yaml" + v0.1: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/named-entity_recognition_jp.yaml" Named Entity Recognition THAI: title: Named Entity Recognition THAI versions: From 9b6fd9df09ad029547ebd1ec9fc7062474cc1f47 Mon Sep 17 00:00:00 2001 From: priyaPeristera Date: Wed, 30 Sep 2020 20:18:18 +1000 Subject: [PATCH 024/792] Update index.yaml --- yaml/index.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/yaml/index.yaml b/yaml/index.yaml index 033e81460..c7387520e 100644 --- a/yaml/index.yaml +++ b/yaml/index.yaml @@ -67,7 +67,7 @@ NLP: versions: v0.1: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/word_sense_disambiguation_eng.yaml" Named-Entity Recognition JP: - title: Named-Entity Recognition JAP + title: Named-Entity Recognition JP versions: v1.0: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/named-entity_recognition_jp_v1.0.yaml" v0.1: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/named-entity_recognition_jp.yaml" From 7395c5b073fcd3cd4cd1a68f23365c0a0ccffe61 Mon Sep 17 00:00:00 2001 From: priyaPeristera Date: Wed, 30 Sep 2020 20:19:34 +1000 Subject: [PATCH 025/792] Update named-entity_recognition_thai_v1.0.yaml --- yaml/named-entity_recognition_thai_v1.0.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/yaml/named-entity_recognition_thai_v1.0.yaml b/yaml/named-entity_recognition_thai_v1.0.yaml index 3a4a4acae..af341de99 100644 --- a/yaml/named-entity_recognition_thai_v1.0.yaml +++ b/yaml/named-entity_recognition_thai_v1.0.yaml @@ -1,6 +1,6 @@ openapi: 3.0.1 info: - title: Named-Entity Recognition THAI Updated + title: Named-Entity Recognition THAI description: |+ This NLP microservice locates and classifies the named-entities classes from input unstructured Thai text. From df2f33a1d36b92be68cf62291694499782023db8 Mon Sep 17 00:00:00 2001 From: priyaPeristera Date: Wed, 30 Sep 2020 21:08:36 +1000 Subject: [PATCH 026/792] Update automatic_speech_recognition_eng_sg.yaml --- yaml/automatic_speech_recognition_eng_sg.yaml | 1 + 1 file changed, 1 insertion(+) diff --git a/yaml/automatic_speech_recognition_eng_sg.yaml b/yaml/automatic_speech_recognition_eng_sg.yaml index efa8277ee..31f06ea2f 100644 --- a/yaml/automatic_speech_recognition_eng_sg.yaml +++ b/yaml/automatic_speech_recognition_eng_sg.yaml @@ -204,6 +204,7 @@ components: Model name: 1. news_parliament. 16 kHz, mono channel. wav format. “news_parliament” is trained on Singapore news and parliament corpus. 2. nsc_parliament. 16 kHz, mono channel. wav format. “nsc_parliament” is trained on National Speech Corpus and parliament corpus. + 3. nscfull_8k - 8 kHz, mono channel, .wav format. Trained on National Speech Corpus. Trained on Full National Speech Corpus corpus. wav_base64: x-name: wav_base64 type: string From 3e1ed3ccd7bf9852fb89eb86680e410299c9647f Mon Sep 17 00:00:00 2001 From: priyaPeristera Date: Wed, 30 Sep 2020 21:12:22 +1000 Subject: [PATCH 027/792] Update carpark_hdb_sg.yaml --- yaml/carpark_hdb_sg.yaml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/yaml/carpark_hdb_sg.yaml b/yaml/carpark_hdb_sg.yaml index d51736462..5b25479a8 100644 --- a/yaml/carpark_hdb_sg.yaml +++ b/yaml/carpark_hdb_sg.yaml @@ -185,8 +185,8 @@ paths: _source: cpk_no: BE37 block: BLK 282 - street: BE37 BISHAN STREET 22 - address: BLK 282 BE37 BISHAN STREET 22 + street: BISHAN STREET 22 + address: BLK 282 BISHAN STREET 22 source: hdb xcoord: '29235.553' ycoord: '37787.1371' From 2864cbe2d711b39e1c1c6f77657d9df9e480e748 Mon Sep 17 00:00:00 2001 From: priyaPeristera Date: Wed, 30 Sep 2020 21:13:42 +1000 Subject: [PATCH 028/792] Update automatic_speech_recognition_chi_sg.yaml --- yaml/automatic_speech_recognition_chi_sg.yaml | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/yaml/automatic_speech_recognition_chi_sg.yaml b/yaml/automatic_speech_recognition_chi_sg.yaml index 00cf3e134..41af29144 100644 --- a/yaml/automatic_speech_recognition_chi_sg.yaml +++ b/yaml/automatic_speech_recognition_chi_sg.yaml @@ -180,6 +180,14 @@ components: description: |+ Input file in base64 format and needs to be prefixed by the data type and encoding data:audio/wav;base64, + language: + x-name: language + type: string + default: true + example: 1 + description: |+ + Language setting: + 1 Mandarin versions: type: object properties: From 9100a85f52daa573c92f9f5075ddbbb5eea7fd0f Mon Sep 17 00:00:00 2001 From: priyaPeristera Date: Wed, 30 Sep 2020 21:14:40 +1000 Subject: [PATCH 029/792] Update asr_with_vad_eng_sg.yaml --- yaml/asr_with_vad_eng_sg.yaml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/yaml/asr_with_vad_eng_sg.yaml b/yaml/asr_with_vad_eng_sg.yaml index 77ace0fef..28c0807fe 100644 --- a/yaml/asr_with_vad_eng_sg.yaml +++ b/yaml/asr_with_vad_eng_sg.yaml @@ -204,7 +204,7 @@ components: file_type: x-name: file_type type: string - default: false + default: true example: wav description: |+ Input file extension. Only “wav” is supported at the moment. @@ -212,7 +212,7 @@ components: x-name: vad_threshold type: number format: float - default: false + default: true example: 0.4 description: |+ 0.0 to 1.0. Lower will result in more sentence splits. Recommended value is 0.25. From a811607f9e8bab1a92b0bb16c421a55678a6f10a Mon Sep 17 00:00:00 2001 From: priyaPeristera Date: Wed, 30 Sep 2020 21:15:26 +1000 Subject: [PATCH 030/792] Delete Automatic-Speech-Recognition-CHI.yaml --- yaml/Automatic-Speech-Recognition-CHI.yaml | 182 --------------------- 1 file changed, 182 deletions(-) delete mode 100644 yaml/Automatic-Speech-Recognition-CHI.yaml diff --git a/yaml/Automatic-Speech-Recognition-CHI.yaml b/yaml/Automatic-Speech-Recognition-CHI.yaml deleted file mode 100644 index 4f0d859a2..000000000 --- a/yaml/Automatic-Speech-Recognition-CHI.yaml +++ /dev/null @@ -1,182 +0,0 @@ -openapi: 3.0.1 -info: - title: Automatic Speech Recognition CHI (SG) - description: >- - This Voice microservice takes in the input audio file (in WAV format at 16kHz) and transcribes Mandarin speech content within the input file into text.

This microservice works best for if the audio file consists of mostly speech with no long pauses in between."

This microservice works best for if the audio file consists of mostly speech with no long pauses in between. - version: '0.1' -servers: - - url: 'https://apis.sentient.io' -tags: -- name: "v0.1" - description: "Published Date - Jun 18, 2018" -paths: - /microservices/voice/asrsch/v0.1/getpredictions: - post: - tags: - - v0.1 - responses: - '200': - description: success response - content: - application/json: - schema: - $ref: '#/components/schemas/success' - headers: - Set-Cookie: - schema: - type: string - example: x-api-key=abcde12345; Path=/; - '401': - description: Unauthorized - content: - application/json: - schema: - $ref: '#/components/schemas/unauthorized' - '402': - description: Payment Required - content: - application/json: - schema: - $ref: '#/components/schemas/paymentrequired' - '403': - description: Forbidden - content: - application/json: - schema: - $ref: '#/components/schemas/forbidden' - '404': - description: Not Found - content: - application/json: - schema: - $ref: '#/components/schemas/notfound' - '419': - description: Input Field Missing - content: - application/json: - schema: - $ref: '#/components/schemas/inputfieldmissing' - '420': - description: Input Limit Exceeded - content: - application/json: - schema: - $ref: '#/components/schemas/inputlimitexceeded' - '500': - description: Internal Server Error - content: - application/json: - schema: - $ref: '#/components/schemas/servererror' - '504': - description: Gateway Timeout - content: - application/json: - schema: - $ref: '#/components/schemas/gatewaytimeout' - security: - - APIAuthorizer: [] - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/input' - required: true -components: - schemas: - success: - type: object - properties: - message: - type: string - example: 各位 同学 朋友 老师 教授 大家好 我叫 墓园 - description: Converted Text - status: - type: string - example: success - description: The status of the API call success/failure - unauthorized: - type: object - properties: - message: - type: string - example: Missing Authentication Token - status: - type: string - example: Failure - forbidden: - type: object - properties: - message: - type: string - example: Access Denied Unauthorized User - status: - type: string - example: Failure - paymentrequired: - type: object - properties: - message: - type: string - example: Insufficient Credits Kindly Top Up - status: - type: string - example: Failure - notfound: - type: object - properties: - message: - type: string - example: Invalid Request URL - status: - type: string - example: Failure - servererror: - type: object - properties: - message: - type: string - example: Internal Server Error - status: - type: string - example: Failure - gatewaytimeout: - type: object - properties: - message: - type: string - example: Request Timeout - status: - type: string - example: Failure - inputfieldmissing: - type: object - properties: - message: - type: string - example: Input Field Missing - status: - type: string - example: Failure - inputlimitexceeded: - type: object - properties: - message: - type: string - example: Input Limit Exceeded - status: - type: string - example: Failure - input: - type: object - properties: - audio: - type: string - example: data:audio/wav;base64,UklGRkbiBABXQVZFZm10IBAAAAABA... - securitySchemes: - APIAuthorizer: - type: apiKey - name: x-api-key - in: header - x-amazon-apigateway-authtype: custom - description: Authentication is done using the x-api-key in the request header. From c88a7dc4110ebfa88be7801581fcbb97388fe90d Mon Sep 17 00:00:00 2001 From: priyaPeristera Date: Wed, 30 Sep 2020 21:16:28 +1000 Subject: [PATCH 031/792] Update automatic_speech_recognition_eng_sg.yaml --- yaml/automatic_speech_recognition_eng_sg.yaml | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/yaml/automatic_speech_recognition_eng_sg.yaml b/yaml/automatic_speech_recognition_eng_sg.yaml index 31f06ea2f..21f786104 100644 --- a/yaml/automatic_speech_recognition_eng_sg.yaml +++ b/yaml/automatic_speech_recognition_eng_sg.yaml @@ -201,9 +201,10 @@ components: default: true example: nsc_parliament description: |+ - Model name: - 1. news_parliament. 16 kHz, mono channel. wav format. “news_parliament” is trained on Singapore news and parliament corpus. - 2. nsc_parliament. 16 kHz, mono channel. wav format. “nsc_parliament” is trained on National Speech Corpus and parliament corpus. + Model selection. For best performance, select the model which best matches the use-case: + + 1. news_parliament - 16 kHz, mono channel, .wav format. Trained on Singapore news and parliament corpus. + 2. nsc_parliament - 16 kHz, mono channel, .wav format. Trained on National Speech Corpus and parliament corpus. 3. nscfull_8k - 8 kHz, mono channel, .wav format. Trained on National Speech Corpus. Trained on Full National Speech Corpus corpus. wav_base64: x-name: wav_base64 From 09ae6dc96e19f9d94af2a6c42cc4579f72b9a97b Mon Sep 17 00:00:00 2001 From: priyaPeristera Date: Wed, 30 Sep 2020 21:23:12 +1000 Subject: [PATCH 032/792] Update page_profiler_eng.yaml --- yaml/page_profiler_eng.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/yaml/page_profiler_eng.yaml b/yaml/page_profiler_eng.yaml index 92acd5cec..34351f02b 100644 --- a/yaml/page_profiler_eng.yaml +++ b/yaml/page_profiler_eng.yaml @@ -197,7 +197,7 @@ default: true example: https://www.sentient.io/en/ description: |+ - The absolute input url, i.e exact, full address (URL) to the page + The URL of the page to be profile. Kindly note that the URL has to be spelt in full, including "https://www." securitySchemes: APIAuthorizer: From 4492383c63943366f08c1292fbe21d26987fc2d3 Mon Sep 17 00:00:00 2001 From: priyaPeristera Date: Wed, 30 Sep 2020 21:23:31 +1000 Subject: [PATCH 033/792] Update page_profiler_eng_v2.0.yaml --- yaml/page_profiler_eng_v2.0.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/yaml/page_profiler_eng_v2.0.yaml b/yaml/page_profiler_eng_v2.0.yaml index 0cadd52d6..633fb1c5b 100644 --- a/yaml/page_profiler_eng_v2.0.yaml +++ b/yaml/page_profiler_eng_v2.0.yaml @@ -216,7 +216,7 @@ default: true example: https://www.sentient.io/en/ description: |+ - The absolute input url, i.e exact, full address (URL) to the page + The URL of the page to be profile. Kindly note that the URL has to be spelt in full, including "https://www." securitySchemes: APIAuthorizer: From 50946fefd34fb224da8c4ac9dc66761661cfed37 Mon Sep 17 00:00:00 2001 From: priyaPeristera Date: Wed, 30 Sep 2020 21:24:14 +1000 Subject: [PATCH 034/792] Update page_profiler_jp.yaml --- yaml/page_profiler_jp.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/yaml/page_profiler_jp.yaml b/yaml/page_profiler_jp.yaml index e39af22af..7381a41cf 100644 --- a/yaml/page_profiler_jp.yaml +++ b/yaml/page_profiler_jp.yaml @@ -232,7 +232,7 @@ default: true example: https://www.bbc.com/japanese description: |+ - The absolute input url, i.e exact, full address (URL) to the page + The URL of the page to be profile. Kindly note that the URL has to be spelt in full, including "https://www." securitySchemes: APIAuthorizer: type: apiKey From 5b1010de1f1bfaeb24afb6367a50d9a09efa5ef4 Mon Sep 17 00:00:00 2001 From: priyaPeristera Date: Wed, 30 Sep 2020 21:24:37 +1000 Subject: [PATCH 035/792] Update page_profiler_thai.yaml --- yaml/page_profiler_thai.yaml | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/yaml/page_profiler_thai.yaml b/yaml/page_profiler_thai.yaml index cb0fb7bb6..53c83b499 100644 --- a/yaml/page_profiler_thai.yaml +++ b/yaml/page_profiler_thai.yaml @@ -244,8 +244,7 @@ default: true example: https://www.komchadluek.net/ description: |+ - The absolute input url, i.e exact, full address (URL) to the page - + The URL of the page to be profile. Kindly note that the URL has to be spelt in full, including "https://www." securitySchemes: APIAuthorizer: type: apiKey From 3a6f36c3e3f8af2ff9c4692521a76c793bced8cd Mon Sep 17 00:00:00 2001 From: Priyadharshini <57977344+priyadharshini-sent@users.noreply.github.com> Date: Wed, 30 Sep 2020 17:14:14 +0530 Subject: [PATCH 036/792] Update page_profiler_eng_v2.0.yaml --- yaml/page_profiler_eng_v2.0.yaml | 1 + 1 file changed, 1 insertion(+) diff --git a/yaml/page_profiler_eng_v2.0.yaml b/yaml/page_profiler_eng_v2.0.yaml index 633fb1c5b..2fc13f92b 100644 --- a/yaml/page_profiler_eng_v2.0.yaml +++ b/yaml/page_profiler_eng_v2.0.yaml @@ -7,6 +7,7 @@ From the web content, the microservice then applies natural language processing to extracts named-entities and returns the output. The named-entity classes extracted are persons, locations, organisations and miscellaneous.

This microservice automatically extracts structured information from unstructured text data such as chatlogs, emails, news articles, etc. + x-subscribelink: page_profiler_eng version: '2.0' servers: - url: 'https://apis.sentient.io' From ac4b7c540d5fef0b44f40858ff02f5680ca9d1fb Mon Sep 17 00:00:00 2001 From: Priyadharshini <57977344+priyadharshini-sent@users.noreply.github.com> Date: Wed, 30 Sep 2020 17:14:34 +0530 Subject: [PATCH 037/792] Update page_profiler_eng.yaml --- yaml/page_profiler_eng.yaml | 1 + 1 file changed, 1 insertion(+) diff --git a/yaml/page_profiler_eng.yaml b/yaml/page_profiler_eng.yaml index 34351f02b..c2934f291 100644 --- a/yaml/page_profiler_eng.yaml +++ b/yaml/page_profiler_eng.yaml @@ -8,6 +8,7 @@ The named-entity classes extracted are persons, locations, organisations and miscellaneous.

This microservice automatically extracts structured information from unstructured text data such as chatlogs, emails, news articles, etc. version: '1.0' + x-subscribelink: page_profiler_eng servers: - url: 'https://apis.sentient.io' tags: From 37bed91103a3335648d24eebe4cba61e0c1eba0e Mon Sep 17 00:00:00 2001 From: priyaPeristera Date: Wed, 30 Sep 2020 23:08:21 +1000 Subject: [PATCH 038/792] Update index.yaml --- yaml/index.yaml | 16 ---------------- 1 file changed, 16 deletions(-) diff --git a/yaml/index.yaml b/yaml/index.yaml index c7387520e..6efef16e4 100644 --- a/yaml/index.yaml +++ b/yaml/index.yaml @@ -211,22 +211,6 @@ Data: title: HDB Shelters Locations (SG) versions: v0.1: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/amenities_shelters_hdb_sg.yaml" - Business Check Plus Dun & Bradstreet (SG): - title: Business Check Plus Dun & Bradstreet (SG) - versions: - v0.1: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/BusinessCheckPlusDun&Bradstreet(SG).yaml" - Basic Individual Search Dun & Bradstreet (SG): - title: Basic Individual Search Dun & Bradstreet (SG) - versions: - v0.1: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/BasicIndividualSearchDun&Bradstreet(SG).yaml" - Business Check Dun & Bradstreet (SG): - title: Business Check Dun & Bradstreet (SG) - versions: - v0.1: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/BusinessCheckDun&Bradstreet(SG).yaml" - Brief Financial Extraction Dun & Bradstreet (SG): - title: Brief Financial Extraction Dun & Bradstreet (SG) - versions: - v0.1: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/BriefFinancialExtractionDun&Bradstreet(SG).yaml" Data Alliance: Download Dataset API: title: Download Dataset API From d2cc67c861c846ee5ad113eb95e1b2cef68e4fff Mon Sep 17 00:00:00 2001 From: Priyadharshini <57977344+priyadharshini-sent@users.noreply.github.com> Date: Wed, 30 Sep 2020 18:50:43 +0530 Subject: [PATCH 039/792] Update automatic_speech_recognition_eng_sg.yaml --- yaml/automatic_speech_recognition_eng_sg.yaml | 1 + 1 file changed, 1 insertion(+) diff --git a/yaml/automatic_speech_recognition_eng_sg.yaml b/yaml/automatic_speech_recognition_eng_sg.yaml index 21f786104..e9640dfc8 100644 --- a/yaml/automatic_speech_recognition_eng_sg.yaml +++ b/yaml/automatic_speech_recognition_eng_sg.yaml @@ -6,6 +6,7 @@ info: This microservice performs well on Singaporean-accented English speech. For best performance, select the model which best matches the use-case: news_parliament, nsc_parliament and nscfull_8k. version: '0.1' + x-subscribelink: automatic_speech_recognition_eng_sg servers: - url: 'https://apis.sentient.io' tags: From a6e2fa0f8b09e96d4a56209a1163f6e16b637b4f Mon Sep 17 00:00:00 2001 From: Priyadharshini <57977344+priyadharshini-sent@users.noreply.github.com> Date: Wed, 30 Sep 2020 18:51:30 +0530 Subject: [PATCH 040/792] Update automatic_speech_recognition_chi_sg.yaml --- yaml/automatic_speech_recognition_chi_sg.yaml | 1 + 1 file changed, 1 insertion(+) diff --git a/yaml/automatic_speech_recognition_chi_sg.yaml b/yaml/automatic_speech_recognition_chi_sg.yaml index 41af29144..41cbac215 100644 --- a/yaml/automatic_speech_recognition_chi_sg.yaml +++ b/yaml/automatic_speech_recognition_chi_sg.yaml @@ -6,6 +6,7 @@ info: This microservice works best for if the audio file consists of mostly speech with no long pauses in between. version: '0.1' + x-subscribelink: automatic_speech_recognition_chi_sg servers: - url: 'https://apis.sentient.io' tags: From e6c71bc2d2442dccbd8d1c72909012bda4f4fba9 Mon Sep 17 00:00:00 2001 From: Priyadharshini <57977344+priyadharshini-sent@users.noreply.github.com> Date: Wed, 30 Sep 2020 18:52:15 +0530 Subject: [PATCH 041/792] Update text-to-speech_eng.yaml --- yaml/text-to-speech_eng.yaml | 1 + 1 file changed, 1 insertion(+) diff --git a/yaml/text-to-speech_eng.yaml b/yaml/text-to-speech_eng.yaml index 643f94929..cbac86510 100644 --- a/yaml/text-to-speech_eng.yaml +++ b/yaml/text-to-speech_eng.yaml @@ -6,6 +6,7 @@ info: The Text-to-Speech AI generated synthesized voice speaks with Singapore English accent. version: '0.1' + x-subscribelink: text-to-speech_eng servers: - url: 'https://apis.sentient.io' tags: From 108c2e71ba250d52b4acccb0749c20b819da13d2 Mon Sep 17 00:00:00 2001 From: Priyadharshini <57977344+priyadharshini-sent@users.noreply.github.com> Date: Wed, 30 Sep 2020 18:52:47 +0530 Subject: [PATCH 042/792] Update text-to-speech_chi.yaml --- yaml/text-to-speech_chi.yaml | 1 + 1 file changed, 1 insertion(+) diff --git a/yaml/text-to-speech_chi.yaml b/yaml/text-to-speech_chi.yaml index ce0e901f1..13ff270e0 100644 --- a/yaml/text-to-speech_chi.yaml +++ b/yaml/text-to-speech_chi.yaml @@ -6,6 +6,7 @@ info: The Text-to-Speech AI generated synthesized voice speaks with native Mandarin accent. version: '0.1' + x-subscribelink: text-to-speech_chi servers: - url: 'https://apis.sentient.io' tags: From 1b3dcaf86f944856e6d61c4e3cb31c34dad30067 Mon Sep 17 00:00:00 2001 From: Priyadharshini <57977344+priyadharshini-sent@users.noreply.github.com> Date: Wed, 30 Sep 2020 18:53:34 +0530 Subject: [PATCH 043/792] Update asr_with_vad_eng_sg.yaml --- yaml/asr_with_vad_eng_sg.yaml | 1 + 1 file changed, 1 insertion(+) diff --git a/yaml/asr_with_vad_eng_sg.yaml b/yaml/asr_with_vad_eng_sg.yaml index 28c0807fe..737dbc58e 100644 --- a/yaml/asr_with_vad_eng_sg.yaml +++ b/yaml/asr_with_vad_eng_sg.yaml @@ -6,6 +6,7 @@ info: This Voice microservice performs well on Singapore-accented English speech. For best performance, select the model which best matches the use-case: news_parliament, nsc_parliament, nscfull_8k version: '0.1' + x-subscribelink: asr_with_vad_eng_sg servers: - url: 'https://apis.sentient.io' tags: From 3a01e47b7607f5c0a9d085a4c35be661e4d7df72 Mon Sep 17 00:00:00 2001 From: Priyadharshini <57977344+priyadharshini-sent@users.noreply.github.com> Date: Wed, 30 Sep 2020 18:54:16 +0530 Subject: [PATCH 044/792] Update voice_activity_detection_eng.yaml --- yaml/voice_activity_detection_eng.yaml | 1 + 1 file changed, 1 insertion(+) diff --git a/yaml/voice_activity_detection_eng.yaml b/yaml/voice_activity_detection_eng.yaml index 8528d9370..75f463579 100644 --- a/yaml/voice_activity_detection_eng.yaml +++ b/yaml/voice_activity_detection_eng.yaml @@ -6,6 +6,7 @@ info: An utterance is the smallest unit of speech. It is a continuous piece of speech beginning and ending with a clear pause. version: '0.1' + x-subscribelink: voice_activity_detection_eng servers: - url: 'https://apis.sentient.io' tags: From a0e05860375beabbc2fcb48b15d6d4648b04ddab Mon Sep 17 00:00:00 2001 From: Priyadharshini <57977344+priyadharshini-sent@users.noreply.github.com> Date: Wed, 30 Sep 2020 18:57:09 +0530 Subject: [PATCH 045/792] Update inverse_text_normalisation_eng.yaml --- yaml/inverse_text_normalisation_eng.yaml | 1 + 1 file changed, 1 insertion(+) diff --git a/yaml/inverse_text_normalisation_eng.yaml b/yaml/inverse_text_normalisation_eng.yaml index 481567b22..6239e3bcc 100644 --- a/yaml/inverse_text_normalisation_eng.yaml +++ b/yaml/inverse_text_normalisation_eng.yaml @@ -6,6 +6,7 @@ info: It converts pre-defined abbreviations from lower case to upper case and also first letters of sentences to upper case. version: '0.1' + x-subscribelink: inverse_text_normalisation_eng servers: - url: 'https://apis.sentient.io' tags: From b6c19d584f1074a4684c1d67bac3fec53357da1e Mon Sep 17 00:00:00 2001 From: Priyadharshini <57977344+priyadharshini-sent@users.noreply.github.com> Date: Wed, 30 Sep 2020 19:07:12 +0530 Subject: [PATCH 046/792] Update named-entity_recognition_eng.yaml --- yaml/named-entity_recognition_eng.yaml | 1 + 1 file changed, 1 insertion(+) diff --git a/yaml/named-entity_recognition_eng.yaml b/yaml/named-entity_recognition_eng.yaml index 285777746..b0ead574d 100644 --- a/yaml/named-entity_recognition_eng.yaml +++ b/yaml/named-entity_recognition_eng.yaml @@ -8,6 +8,7 @@ info: This microservice automatically extracts structured information from unstructured text data such as chatlogs, emails, news articles, etc. version: '0.1' + x-subscribelink: named-entity_recognition_eng servers: - url: 'https://apis.sentient.io' tags: From acce9c82f57550658589b2fd57f18b7a94a16d82 Mon Sep 17 00:00:00 2001 From: Priyadharshini <57977344+priyadharshini-sent@users.noreply.github.com> Date: Wed, 30 Sep 2020 19:07:28 +0530 Subject: [PATCH 047/792] Update named-entity_recognition_eng_v1.0.yaml --- yaml/named-entity_recognition_eng_v1.0.yaml | 1 + 1 file changed, 1 insertion(+) diff --git a/yaml/named-entity_recognition_eng_v1.0.yaml b/yaml/named-entity_recognition_eng_v1.0.yaml index e109f5a37..bd5e55add 100644 --- a/yaml/named-entity_recognition_eng_v1.0.yaml +++ b/yaml/named-entity_recognition_eng_v1.0.yaml @@ -8,6 +8,7 @@ info: This microservice automatically extracts structured information from unstructured text data such as chatlogs, emails, news articles, etc. version: '1.0' + x-subscribelink: named-entity_recognition_eng servers: - url: 'https://apis.sentient.io' tags: From 9b78f7cc7b2e6b8f442c6791701996cc46c7481d Mon Sep 17 00:00:00 2001 From: Priyadharshini <57977344+priyadharshini-sent@users.noreply.github.com> Date: Wed, 30 Sep 2020 19:08:04 +0530 Subject: [PATCH 048/792] Update spacy_named-entity_recognition_eng.yaml --- yaml/spacy_named-entity_recognition_eng.yaml | 1 + 1 file changed, 1 insertion(+) diff --git a/yaml/spacy_named-entity_recognition_eng.yaml b/yaml/spacy_named-entity_recognition_eng.yaml index 50fc2fbd1..19cd324ca 100644 --- a/yaml/spacy_named-entity_recognition_eng.yaml +++ b/yaml/spacy_named-entity_recognition_eng.yaml @@ -9,6 +9,7 @@ info: This microservice automatically extracts structured information from unstructured text data such as chatlogs, emails, news articles, etc. version: '0.1' + x-subscribelink: spacy_ner servers: - url: 'https://apis.sentient.io' tags: From 22aed9152d45b470caf41d5026d3acf16ae95dee Mon Sep 17 00:00:00 2001 From: Priyadharshini <57977344+priyadharshini-sent@users.noreply.github.com> Date: Wed, 30 Sep 2020 19:09:20 +0530 Subject: [PATCH 049/792] Update page_profiler_jp.yaml --- yaml/page_profiler_jp.yaml | 1 + 1 file changed, 1 insertion(+) diff --git a/yaml/page_profiler_jp.yaml b/yaml/page_profiler_jp.yaml index 7381a41cf..642262c7d 100644 --- a/yaml/page_profiler_jp.yaml +++ b/yaml/page_profiler_jp.yaml @@ -8,6 +8,7 @@ This microservice automatically extracts structured information from unstructured text data such as chatlogs, emails, news articles, etc. version: '0.1' + x-subscribelink: page_profiler_jp servers: - url: 'https://apis.sentient.io' tags: From dde556f6b4b188a7a1dc2213aa688cfb58212e6f Mon Sep 17 00:00:00 2001 From: Priyadharshini <57977344+priyadharshini-sent@users.noreply.github.com> Date: Wed, 30 Sep 2020 19:09:52 +0530 Subject: [PATCH 050/792] Update page_profiler_thai.yaml --- yaml/page_profiler_thai.yaml | 1 + 1 file changed, 1 insertion(+) diff --git a/yaml/page_profiler_thai.yaml b/yaml/page_profiler_thai.yaml index 53c83b499..7203caf44 100644 --- a/yaml/page_profiler_thai.yaml +++ b/yaml/page_profiler_thai.yaml @@ -8,6 +8,7 @@ This microservice automatically extracts structured information from unstructured text data such as chatlogs, emails, news articles, etc. version: '1.0' + x-subscribelink: page_profiler_thai servers: - url: 'https://apis.sentient.io' tags: From 5d2b3ac34666ee9085adfebe61d13cb140b69c9a Mon Sep 17 00:00:00 2001 From: Priyadharshini <57977344+priyadharshini-sent@users.noreply.github.com> Date: Wed, 30 Sep 2020 19:10:21 +0530 Subject: [PATCH 051/792] Update taxonomy_matcher_eng.yaml --- yaml/taxonomy_matcher_eng.yaml | 1 + 1 file changed, 1 insertion(+) diff --git a/yaml/taxonomy_matcher_eng.yaml b/yaml/taxonomy_matcher_eng.yaml index 6a2931b91..fb11e1218 100644 --- a/yaml/taxonomy_matcher_eng.yaml +++ b/yaml/taxonomy_matcher_eng.yaml @@ -8,6 +8,7 @@ info: This microservice can help identify the types of concept that are frequently mentioned in an article. version: '0.1' + x-subscribelink: taxonomy_matcher_eng servers: - url: 'https://apis.sentient.io' tags: From a2aa7fe096eb8e4946c3d8506c85fd5f09e4e0f4 Mon Sep 17 00:00:00 2001 From: Priyadharshini <57977344+priyadharshini-sent@users.noreply.github.com> Date: Wed, 30 Sep 2020 19:10:54 +0530 Subject: [PATCH 052/792] Update word_sense_disambiguation_eng.yaml --- yaml/word_sense_disambiguation_eng.yaml | 1 + 1 file changed, 1 insertion(+) diff --git a/yaml/word_sense_disambiguation_eng.yaml b/yaml/word_sense_disambiguation_eng.yaml index 4ab185d58..f97f55e47 100644 --- a/yaml/word_sense_disambiguation_eng.yaml +++ b/yaml/word_sense_disambiguation_eng.yaml @@ -6,6 +6,7 @@ info: If the word is determined to be a noun within the sentence context, the microservice returns the potential hypernym, definition, and score. Otherwise, no result will be returned for that context. version: '0.1' + x-subscribelink: word_sense_disambiguation_eng servers: - url: 'https://apis.sentient.io' tags: From bf511e365601df2b4949ff885ece1b4ba38e4fbf Mon Sep 17 00:00:00 2001 From: Priyadharshini <57977344+priyadharshini-sent@users.noreply.github.com> Date: Wed, 30 Sep 2020 19:11:38 +0530 Subject: [PATCH 053/792] Update named-entity_recognition_jp.yaml --- yaml/named-entity_recognition_jp.yaml | 1 + 1 file changed, 1 insertion(+) diff --git a/yaml/named-entity_recognition_jp.yaml b/yaml/named-entity_recognition_jp.yaml index d2b172041..1955a651b 100644 --- a/yaml/named-entity_recognition_jp.yaml +++ b/yaml/named-entity_recognition_jp.yaml @@ -8,6 +8,7 @@ info: This microservice automatically extracts structured information from unstructured text data such as chatlogs, emails, news articles, etc. version: '0.1' + x-subscribelink: named-entity_recognition_jp servers: - url: 'https://apis.sentient.io' tags: From 7c348791b6afb71243cff5bf608c67e88dacf3cd Mon Sep 17 00:00:00 2001 From: Priyadharshini <57977344+priyadharshini-sent@users.noreply.github.com> Date: Wed, 30 Sep 2020 19:11:54 +0530 Subject: [PATCH 054/792] Update named-entity_recognition_jp_v1.0.yaml --- yaml/named-entity_recognition_jp_v1.0.yaml | 1 + 1 file changed, 1 insertion(+) diff --git a/yaml/named-entity_recognition_jp_v1.0.yaml b/yaml/named-entity_recognition_jp_v1.0.yaml index ebc0de9db..fa12fa81f 100644 --- a/yaml/named-entity_recognition_jp_v1.0.yaml +++ b/yaml/named-entity_recognition_jp_v1.0.yaml @@ -8,6 +8,7 @@ info: This microservice automatically extracts structured information from unstructured text data such as chatlogs, emails, news articles, etc. version: '1.0' + x-subscribelink: named-entity_recognition_jp servers: - url: 'https://apis.sentient.io' tags: From db899d1dcbb46282a7a5c36144be96a72d164da4 Mon Sep 17 00:00:00 2001 From: Priyadharshini <57977344+priyadharshini-sent@users.noreply.github.com> Date: Wed, 30 Sep 2020 19:12:32 +0530 Subject: [PATCH 055/792] Update named-entity_recognition_thai.yaml --- yaml/named-entity_recognition_thai.yaml | 1 + 1 file changed, 1 insertion(+) diff --git a/yaml/named-entity_recognition_thai.yaml b/yaml/named-entity_recognition_thai.yaml index a520675c1..ff1fc568a 100644 --- a/yaml/named-entity_recognition_thai.yaml +++ b/yaml/named-entity_recognition_thai.yaml @@ -8,6 +8,7 @@ info: This microservice automatically extracts structured information from unstructured text data such as chatlogs, emails, news articles, etc. version: '0.1' + x-subscribelink: named-entity_recognition_thai servers: - url: 'https://apis.sentient.io' tags: From b5e6d81ad22aaf38a8ce4c19533e8475fd75f786 Mon Sep 17 00:00:00 2001 From: Priyadharshini <57977344+priyadharshini-sent@users.noreply.github.com> Date: Wed, 30 Sep 2020 19:12:49 +0530 Subject: [PATCH 056/792] Update named-entity_recognition_thai_v1.0.yaml --- yaml/named-entity_recognition_thai_v1.0.yaml | 1 + 1 file changed, 1 insertion(+) diff --git a/yaml/named-entity_recognition_thai_v1.0.yaml b/yaml/named-entity_recognition_thai_v1.0.yaml index af341de99..a517d65af 100644 --- a/yaml/named-entity_recognition_thai_v1.0.yaml +++ b/yaml/named-entity_recognition_thai_v1.0.yaml @@ -8,6 +8,7 @@ info: This microservice automatically extracts structured information from unstructured text data such as chatlogs, emails, news articles, etc. version: '1.0' + x-subscribelink: named-entity_recognition_thai servers: - url: 'https://apis.sentient.io' tags: From 4b598cbf79905e262fcffb1c0594b2ffab2b1a71 Mon Sep 17 00:00:00 2001 From: Priyadharshini <57977344+priyadharshini-sent@users.noreply.github.com> Date: Wed, 30 Sep 2020 19:13:11 +0530 Subject: [PATCH 057/792] Update script_alignment.yaml --- yaml/script_alignment.yaml | 1 + 1 file changed, 1 insertion(+) diff --git a/yaml/script_alignment.yaml b/yaml/script_alignment.yaml index 5dfa38490..8a372a043 100644 --- a/yaml/script_alignment.yaml +++ b/yaml/script_alignment.yaml @@ -6,6 +6,7 @@ info: The output is the time-coded high-quality script. version: '0.1' + x-subscribelink: script_alignment servers: - url: 'https://apis.sentient.io' tags: From 52b5b00af112ec653866c7b208ac2a2a6dbe46b5 Mon Sep 17 00:00:00 2001 From: Priyadharshini <57977344+priyadharshini-sent@users.noreply.github.com> Date: Wed, 30 Sep 2020 19:13:38 +0530 Subject: [PATCH 058/792] Update object_detection.yaml --- yaml/object_detection.yaml | 1 + 1 file changed, 1 insertion(+) diff --git a/yaml/object_detection.yaml b/yaml/object_detection.yaml index caca64189..766987c6c 100644 --- a/yaml/object_detection.yaml +++ b/yaml/object_detection.yaml @@ -8,6 +8,7 @@ info: The classes are: person, bicycle, car, motorbike, aeroplane, bus, train, truck, boat, traffic light, fire hydrant, stop sign, parking meter, bench, bird, cat, dog, horse, sheep, cow, elephant, bear, zebra, giraffe, backpack, umbrella, handbag, tie, suitcase, frisbee, skis, snowboard, sports ball, kite, baseball bat, baseball glove, skateboard, surfboard, tennis racket, bottle, wine glass, cup, fork, knife, spoon, bowl, banana, apple, sandwich, orange, broccoli, carrot, hot dog, pizza, donut, cake, chair, sofa, pottedplant, bed, diningtable, toilet, tvmonitor, laptop, mouse, remote, keyboard, cell phone, microwave, oven, toaster, sink, refrigerator, book, clock, vase, scissors, teddy bear, hair drier, toothbrush version: '0.1' + x-subscribelink: object_detection servers: - url: 'https://apis.sentient.io' tags: From 96d2427a30f26bef452b0a7a434fec4190195c88 Mon Sep 17 00:00:00 2001 From: Priyadharshini <57977344+priyadharshini-sent@users.noreply.github.com> Date: Wed, 30 Sep 2020 19:14:01 +0530 Subject: [PATCH 059/792] Update face_recognition_politicians_sg.yaml --- yaml/face_recognition_politicians_sg.yaml | 1 + 1 file changed, 1 insertion(+) diff --git a/yaml/face_recognition_politicians_sg.yaml b/yaml/face_recognition_politicians_sg.yaml index 8e4e5998f..85643aec1 100644 --- a/yaml/face_recognition_politicians_sg.yaml +++ b/yaml/face_recognition_politicians_sg.yaml @@ -6,6 +6,7 @@ info: This microservice returns the identity of the person, the bounding box in image coordinates, and the confidence of the prediction. version: '0.1' + x-subscribelink: face_recognition_politicians_sg servers: - url: 'https://apis.sentient.io' tags: From 5b7e6c692a47e7034d7a9bb7f4e13861b579b84a Mon Sep 17 00:00:00 2001 From: Priyadharshini <57977344+priyadharshini-sent@users.noreply.github.com> Date: Wed, 30 Sep 2020 19:14:23 +0530 Subject: [PATCH 060/792] Update people_counting.yaml --- yaml/people_counting.yaml | 1 + 1 file changed, 1 insertion(+) diff --git a/yaml/people_counting.yaml b/yaml/people_counting.yaml index 62d2e7380..486b55b30 100644 --- a/yaml/people_counting.yaml +++ b/yaml/people_counting.yaml @@ -6,6 +6,7 @@ info: This microservice returns the number of people detected in that video, the likelihood of overestimation/underestimation, the first appearance and the duration and confidence of each person detected. version: '0.1' + x-subscribelink: people_counting servers: - url: 'https://apis.sentient.io' tags: From a5689e81fbe9bc86b936088b54a4a28a24fc3a41 Mon Sep 17 00:00:00 2001 From: Priyadharshini <57977344+priyadharshini-sent@users.noreply.github.com> Date: Wed, 30 Sep 2020 19:14:45 +0530 Subject: [PATCH 061/792] Update landmark_detection_sg.yaml --- yaml/landmark_detection_sg.yaml | 1 + 1 file changed, 1 insertion(+) diff --git a/yaml/landmark_detection_sg.yaml b/yaml/landmark_detection_sg.yaml index 5b238fd93..f2f844388 100644 --- a/yaml/landmark_detection_sg.yaml +++ b/yaml/landmark_detection_sg.yaml @@ -6,6 +6,7 @@ info: This microservice returns the detected landmark and confidence score. version: '0.1' + x-subscribelink: landmark_detection_sg servers: - url: 'https://apis.sentient.io' tags: From d04ac8b213b29017eccf9f82a9789eccf58d29e4 Mon Sep 17 00:00:00 2001 From: Priyadharshini <57977344+priyadharshini-sent@users.noreply.github.com> Date: Wed, 30 Sep 2020 19:15:10 +0530 Subject: [PATCH 062/792] Update landmark_detection_jp.yaml --- yaml/landmark_detection_jp.yaml | 1 + 1 file changed, 1 insertion(+) diff --git a/yaml/landmark_detection_jp.yaml b/yaml/landmark_detection_jp.yaml index 2cfeca636..7a6dbcc7b 100644 --- a/yaml/landmark_detection_jp.yaml +++ b/yaml/landmark_detection_jp.yaml @@ -6,6 +6,7 @@ info: The microservice returns the detected landmark and confidence score. version: '0.1' + x-subscribelink: landmark_detection_jp servers: - url: 'https://apis.sentient.io' tags: From 35e18159a91c19f527ca4dea9e1be441f55fd3b7 Mon Sep 17 00:00:00 2001 From: Priyadharshini <57977344+priyadharshini-sent@users.noreply.github.com> Date: Wed, 30 Sep 2020 19:15:58 +0530 Subject: [PATCH 063/792] Update youtube_video_downloader.yaml --- yaml/youtube_video_downloader.yaml | 1 + 1 file changed, 1 insertion(+) diff --git a/yaml/youtube_video_downloader.yaml b/yaml/youtube_video_downloader.yaml index 17e126f2b..173dceba2 100644 --- a/yaml/youtube_video_downloader.yaml +++ b/yaml/youtube_video_downloader.yaml @@ -4,6 +4,7 @@ info: description: |+ This Utility microservice retrieves the Youtube video of the input URL and output a download link. version: '0.1' + x-subscribelink: youtube_video_downloader servers: - url: 'https://apis.sentient.io' tags: From f4ec35ab342681c007a783e48fa7e71cae8d477e Mon Sep 17 00:00:00 2001 From: Priyadharshini <57977344+priyadharshini-sent@users.noreply.github.com> Date: Wed, 30 Sep 2020 19:16:30 +0530 Subject: [PATCH 064/792] Update video-to-audio_convertor.yaml --- yaml/video-to-audio_convertor.yaml | 1 + 1 file changed, 1 insertion(+) diff --git a/yaml/video-to-audio_convertor.yaml b/yaml/video-to-audio_convertor.yaml index 70116a57e..d370865ad 100644 --- a/yaml/video-to-audio_convertor.yaml +++ b/yaml/video-to-audio_convertor.yaml @@ -4,6 +4,7 @@ info: description: |+ This API is used to extract the sound from a video file and save it in an audio file. version: '0.1' + x-subscribelink: video-to-audio_convertor servers: - url: 'https://apis.sentient.io' tags: From f4b45918bc5b377941b58d31e73499b04e77cc98 Mon Sep 17 00:00:00 2001 From: Priyadharshini <57977344+priyadharshini-sent@users.noreply.github.com> Date: Wed, 30 Sep 2020 19:17:11 +0530 Subject: [PATCH 065/792] Update web_scraper.yaml --- yaml/web_scraper.yaml | 1 + 1 file changed, 1 insertion(+) diff --git a/yaml/web_scraper.yaml b/yaml/web_scraper.yaml index 8bf412b25..f6ab43322 100644 --- a/yaml/web_scraper.yaml +++ b/yaml/web_scraper.yaml @@ -1,6 +1,7 @@ openapi: 3.0.1 info: title: Web Scraper + x-subscribelink: web_scraper description: |+ This API is used to extract content or specific HTML elements from web pages. Supports both HTML and Text output. The web scraper can be instructed to extract HTML elements that match the criteria given in the queryList HTTP request parameter, it can even do navigate down the html tree like get all p tag inside a div class "class":"class_name p" x-description2: |+ From 9de12f29d4689688e37753a092ab58bcf30a902b Mon Sep 17 00:00:00 2001 From: Priyadharshini <57977344+priyadharshini-sent@users.noreply.github.com> Date: Wed, 30 Sep 2020 19:17:33 +0530 Subject: [PATCH 066/792] Update document_convertor_eng.yaml --- yaml/document_convertor_eng.yaml | 1 + 1 file changed, 1 insertion(+) diff --git a/yaml/document_convertor_eng.yaml b/yaml/document_convertor_eng.yaml index a7d1f8b08..6001c2bcc 100644 --- a/yaml/document_convertor_eng.yaml +++ b/yaml/document_convertor_eng.yaml @@ -4,6 +4,7 @@ info: description: |+ This Utility microservice extracts the English text content of singular input Microsoft Word, HTML or PDF documents and outputs into plain text format. version: '1.0' + x-subscribelink: document_convertor_eng servers: - url: 'https://apis.sentient.io' tags: From 59509eb7b4119f8d54d5eab474c49a686c2cc555 Mon Sep 17 00:00:00 2001 From: Priyadharshini <57977344+priyadharshini-sent@users.noreply.github.com> Date: Wed, 30 Sep 2020 19:17:54 +0530 Subject: [PATCH 067/792] Update pdf_extractor.yaml --- yaml/pdf_extractor.yaml | 1 + 1 file changed, 1 insertion(+) diff --git a/yaml/pdf_extractor.yaml b/yaml/pdf_extractor.yaml index 9f3e582fa..8fac40640 100644 --- a/yaml/pdf_extractor.yaml +++ b/yaml/pdf_extractor.yaml @@ -10,6 +10,7 @@ info: Supported languages: Hindi, German, Spanish, Portuguese, French, Turkish, Italian, Russian, Arabic, Indonesian, Chinese, Japanese and Korean. version: '1.0' + x-subscribelink: pdf_extractor servers: - url: 'https://apis.sentient.io' tags: From 37a8dbcf79ccd56aac5c7117caeea80b3f25786e Mon Sep 17 00:00:00 2001 From: Priyadharshini <57977344+priyadharshini-sent@users.noreply.github.com> Date: Wed, 30 Sep 2020 19:18:16 +0530 Subject: [PATCH 068/792] Update pki_key_generator.yaml --- yaml/pki_key_generator.yaml | 1 + 1 file changed, 1 insertion(+) diff --git a/yaml/pki_key_generator.yaml b/yaml/pki_key_generator.yaml index c80778b49..f2207c0c7 100644 --- a/yaml/pki_key_generator.yaml +++ b/yaml/pki_key_generator.yaml @@ -4,6 +4,7 @@ info: description: |+ This Utiltiy microservice generates Public key and Private key pair, useful for encryption purposes. version: '0.1' + x-subscribelink: pki_key_generator servers: - url: 'https://apis.sentient.io' tags: From d937e0bc765c5b396ab1a2ff969bab6e7a415cc4 Mon Sep 17 00:00:00 2001 From: Priyadharshini <57977344+priyadharshini-sent@users.noreply.github.com> Date: Wed, 30 Sep 2020 19:18:48 +0530 Subject: [PATCH 069/792] Update encryption_using_pki_key.yaml --- yaml/encryption_using_pki_key.yaml | 1 + 1 file changed, 1 insertion(+) diff --git a/yaml/encryption_using_pki_key.yaml b/yaml/encryption_using_pki_key.yaml index d6f4b9bc7..b0ca468ad 100644 --- a/yaml/encryption_using_pki_key.yaml +++ b/yaml/encryption_using_pki_key.yaml @@ -6,6 +6,7 @@ info: This can be use with PKI Key Generator. version: '0.1' + x-subscribelink: encryption_using_pki_key servers: - url: 'https://apis.sentient.io' tags: From efe7969442d1abf5537196dc4833fdef74ca97de Mon Sep 17 00:00:00 2001 From: Priyadharshini <57977344+priyadharshini-sent@users.noreply.github.com> Date: Wed, 30 Sep 2020 19:19:11 +0530 Subject: [PATCH 070/792] Update decryption_using_pki_key.yaml --- yaml/decryption_using_pki_key.yaml | 1 + 1 file changed, 1 insertion(+) diff --git a/yaml/decryption_using_pki_key.yaml b/yaml/decryption_using_pki_key.yaml index eeba72ee5..707d6f5cd 100644 --- a/yaml/decryption_using_pki_key.yaml +++ b/yaml/decryption_using_pki_key.yaml @@ -6,6 +6,7 @@ info: This can be use with PKI Key Generator. version: '0.1' + x-subscribelink: decryption_using_pki_key servers: - url: 'https://apis.sentient.io' tags: From e818945527871b432a2946e38d54f910271dd1ba Mon Sep 17 00:00:00 2001 From: Priyadharshini <57977344+priyadharshini-sent@users.noreply.github.com> Date: Wed, 30 Sep 2020 19:19:36 +0530 Subject: [PATCH 071/792] Update wikipedia_retrieval_eng.yaml --- yaml/wikipedia_retrieval_eng.yaml | 1 + 1 file changed, 1 insertion(+) diff --git a/yaml/wikipedia_retrieval_eng.yaml b/yaml/wikipedia_retrieval_eng.yaml index ac6dd5395..3b5b907c2 100644 --- a/yaml/wikipedia_retrieval_eng.yaml +++ b/yaml/wikipedia_retrieval_eng.yaml @@ -4,6 +4,7 @@ info: description: |+ It is an API that provides the user with a Wikipedia article based on the input keyword. Refer to this link for the full list of Wikipedias - https://meta.wikimedia.org/wiki/List_of_Wikipedias version: '0.1' + x-subscribelink: wikipedia_retrieval_eng servers: - url: 'https://apis.sentient.io' tags: From 18386846ac4b3313b21711b025f30aed738a31ba Mon Sep 17 00:00:00 2001 From: Priyadharshini <57977344+priyadharshini-sent@users.noreply.github.com> Date: Wed, 30 Sep 2020 19:20:12 +0530 Subject: [PATCH 072/792] Update json-csv_convertor.yaml --- yaml/json-csv_convertor.yaml | 1 + 1 file changed, 1 insertion(+) diff --git a/yaml/json-csv_convertor.yaml b/yaml/json-csv_convertor.yaml index 11d65615d..1313b6731 100644 --- a/yaml/json-csv_convertor.yaml +++ b/yaml/json-csv_convertor.yaml @@ -4,6 +4,7 @@ info: description: |+ This Utility microservice converts the input JSON (json string or json file) to CSV format. version: '1.0' + x-subscribelink: json-csv_convertor servers: - url: 'https://apis.sentient.io' tags: From c0b111857b5ff8ade21e58aef7bee369c05f2e2c Mon Sep 17 00:00:00 2001 From: Priyadharshini <57977344+priyadharshini-sent@users.noreply.github.com> Date: Wed, 30 Sep 2020 19:20:45 +0530 Subject: [PATCH 073/792] Update csv-json_convertor.yaml --- yaml/csv-json_convertor.yaml | 1 + 1 file changed, 1 insertion(+) diff --git a/yaml/csv-json_convertor.yaml b/yaml/csv-json_convertor.yaml index a70e643ea..62b4eba79 100644 --- a/yaml/csv-json_convertor.yaml +++ b/yaml/csv-json_convertor.yaml @@ -4,6 +4,7 @@ info: description: |+ This Utility microservice converts the input CSV to JSON format. The headers should be the keywords and columns should be the value of proper keywords. version: '1.0' + x-subscribelink: csv-json_convertor servers: - url: 'https://apis.sentient.io' tags: From 59f1caf42dcc3af4e2983ae325bde155f4e23498 Mon Sep 17 00:00:00 2001 From: Priyadharshini <57977344+priyadharshini-sent@users.noreply.github.com> Date: Wed, 30 Sep 2020 19:21:10 +0530 Subject: [PATCH 074/792] Update audio_format_convertor.yaml --- yaml/audio_format_convertor.yaml | 1 + 1 file changed, 1 insertion(+) diff --git a/yaml/audio_format_convertor.yaml b/yaml/audio_format_convertor.yaml index 4ac5633bf..c35493f54 100644 --- a/yaml/audio_format_convertor.yaml +++ b/yaml/audio_format_convertor.yaml @@ -4,6 +4,7 @@ info: description: >- This API is used to convert your audio like music(any format) to the WAV format. version: '0.1' + x-subscribelink: audio_format_convertor servers: - url: 'https://apis.sentient.io' tags: From 44b885b4992414c23705c260868f1c5872b519e9 Mon Sep 17 00:00:00 2001 From: Priyadharshini <57977344+priyadharshini-sent@users.noreply.github.com> Date: Wed, 30 Sep 2020 19:21:37 +0530 Subject: [PATCH 075/792] Update video-to-image_convertor.yaml --- yaml/video-to-image_convertor.yaml | 1 + 1 file changed, 1 insertion(+) diff --git a/yaml/video-to-image_convertor.yaml b/yaml/video-to-image_convertor.yaml index 4a87e7959..18a180761 100644 --- a/yaml/video-to-image_convertor.yaml +++ b/yaml/video-to-image_convertor.yaml @@ -6,6 +6,7 @@ info: Supported formats are : 3g2, avi, flv, mkv, mov, mp4, ogv, webm, wmv, m4v with H.264 codec encoded. version: '0.1' + x-subscribelink: video-to-image_convertor servers: - url: 'https://apis.sentient.io' tags: From 5396152d0643ce9b2c09afa0ea90f10920702d79 Mon Sep 17 00:00:00 2001 From: Priyadharshini <57977344+priyadharshini-sent@users.noreply.github.com> Date: Wed, 30 Sep 2020 19:22:02 +0530 Subject: [PATCH 076/792] Update newspaper_article_scraper.yaml --- yaml/newspaper_article_scraper.yaml | 1 + 1 file changed, 1 insertion(+) diff --git a/yaml/newspaper_article_scraper.yaml b/yaml/newspaper_article_scraper.yaml index 058fc1679..5b93a0816 100644 --- a/yaml/newspaper_article_scraper.yaml +++ b/yaml/newspaper_article_scraper.yaml @@ -4,6 +4,7 @@ info: description: |+ This api allows to extracting & curating articles and delivers Instapaper style article extraction. Current supported languages: Arabic, Russian, Dutch, German, English, Spanish, French, Hebrew, Italian, Korean, Norwegian, Persian, Polish, Portuguese, Swedish, Hungarian, Finnish, Danish, Chinese, Indonesian, Vietnamese, Swahili, Turkish, Greek, Ukrainian. Supports automatic languages detection. version: '0.1' + x-subscribelink: newspaper_article_scraper servers: - url: 'https://apis.sentient.io' tags: From e348ff1d1701153b2e6ba8f82eecdcae840e123c Mon Sep 17 00:00:00 2001 From: Priyadharshini <57977344+priyadharshini-sent@users.noreply.github.com> Date: Wed, 30 Sep 2020 19:22:23 +0530 Subject: [PATCH 077/792] Update urls_retrieval.yaml --- yaml/urls_retrieval.yaml | 1 + 1 file changed, 1 insertion(+) diff --git a/yaml/urls_retrieval.yaml b/yaml/urls_retrieval.yaml index c82491bd2..cd624ac65 100644 --- a/yaml/urls_retrieval.yaml +++ b/yaml/urls_retrieval.yaml @@ -4,6 +4,7 @@ info: description: |+ This Utility microservice crawls and retrieves their content from the input URLs, up to the specified depth. version: '0.1' + x-subscribelink: urls_retrieval servers: - url: 'https://apis.sentient.io' tags: From a3ad7d05aebe7e359fb29d3803b746b737cf6f9c Mon Sep 17 00:00:00 2001 From: Priyadharshini <57977344+priyadharshini-sent@users.noreply.github.com> Date: Wed, 30 Sep 2020 19:24:12 +0530 Subject: [PATCH 078/792] Update commercial_directories_hdb_sg.yaml --- yaml/commercial_directories_hdb_sg.yaml | 1 + 1 file changed, 1 insertion(+) diff --git a/yaml/commercial_directories_hdb_sg.yaml b/yaml/commercial_directories_hdb_sg.yaml index c84ba0ba1..c0565dcfc 100644 --- a/yaml/commercial_directories_hdb_sg.yaml +++ b/yaml/commercial_directories_hdb_sg.yaml @@ -1,6 +1,7 @@ openapi: 3.0.1 info: title: HDB Commercial Directories (SG) + x-subscribelink: commercial_directories_hdb_sg description: |+ This Data microservice retrieves the list of all retail shops in Singapore which allows you to search for a shop by its name, address, building name, postal code, latitude and longitude coordinates type of business. The resultant dataset offers useful information like the shop operating hours and contact number. Updated weekly. From ff32c495019e5fa8ce0ea1fb483c4623402fee6a Mon Sep 17 00:00:00 2001 From: Priyadharshini <57977344+priyadharshini-sent@users.noreply.github.com> Date: Wed, 30 Sep 2020 19:24:59 +0530 Subject: [PATCH 079/792] Update building_addresses_hdb_sg.yaml --- yaml/building_addresses_hdb_sg.yaml | 1 + 1 file changed, 1 insertion(+) diff --git a/yaml/building_addresses_hdb_sg.yaml b/yaml/building_addresses_hdb_sg.yaml index a78cd8895..04aa2400e 100644 --- a/yaml/building_addresses_hdb_sg.yaml +++ b/yaml/building_addresses_hdb_sg.yaml @@ -1,6 +1,7 @@ openapi: 3.0.1 info: title: HDB Block Coordinates (SG) + x-subscribelink: building_addresses_hdb_sg description: |+ This Data microservice retrieves information on the Singapore Housing Development Board building blocks in Singapore that includes addresses, postal code, latitude and longitude coordinates. Updated monthly From 76a3c44c3121fb75c7d01398cec2fec1aa8d6c74 Mon Sep 17 00:00:00 2001 From: Priyadharshini <57977344+priyadharshini-sent@users.noreply.github.com> Date: Wed, 30 Sep 2020 19:26:09 +0530 Subject: [PATCH 080/792] Update residential_sales_and_rental_hdb_sg.yaml --- yaml/residential_sales_and_rental_hdb_sg.yaml | 1 + 1 file changed, 1 insertion(+) diff --git a/yaml/residential_sales_and_rental_hdb_sg.yaml b/yaml/residential_sales_and_rental_hdb_sg.yaml index d5ff2487d..344740535 100644 --- a/yaml/residential_sales_and_rental_hdb_sg.yaml +++ b/yaml/residential_sales_and_rental_hdb_sg.yaml @@ -1,6 +1,7 @@ openapi: 3.0.1 info: title: HDB Residential Occupancy Status (SG) + x-subscribelink: residential_sales_and_rental_hdb_sg description: |+ This Data microservice retreives comprehensive details of each HDB block in Singapore including the number of units for each type of flats and whether they were sold or leased. Queries based on keywords and proximity to particular locations can be performed. Updated weekly. From fe8bde8032119ab0897180d1e0ba81a7a8809f07 Mon Sep 17 00:00:00 2001 From: Priyadharshini <57977344+priyadharshini-sent@users.noreply.github.com> Date: Wed, 30 Sep 2020 19:26:42 +0530 Subject: [PATCH 081/792] Update carpark_hdb_sg.yaml --- yaml/carpark_hdb_sg.yaml | 1 + 1 file changed, 1 insertion(+) diff --git a/yaml/carpark_hdb_sg.yaml b/yaml/carpark_hdb_sg.yaml index 5b25479a8..f117fc2f3 100644 --- a/yaml/carpark_hdb_sg.yaml +++ b/yaml/carpark_hdb_sg.yaml @@ -1,6 +1,7 @@ openapi: 3.0.1 info: title: HDB Carpark Locations (SG) + x-subscribelink: carpark_hdb_sg description: |+ This Data microservice retrieves the Singapore Housing Development Board's carpark information within Singapore HDB estates that includes location address, postal code and parking lot capacity for different types of vehicle by carpark location. Updated monthly. From d17efa2aacf4a566edcc449d6b70f57a9198a87d Mon Sep 17 00:00:00 2001 From: Priyadharshini <57977344+priyadharshini-sent@users.noreply.github.com> Date: Wed, 30 Sep 2020 19:27:12 +0530 Subject: [PATCH 082/792] Update demographics_hdb_sg.yaml --- yaml/demographics_hdb_sg.yaml | 1 + 1 file changed, 1 insertion(+) diff --git a/yaml/demographics_hdb_sg.yaml b/yaml/demographics_hdb_sg.yaml index e87aae00c..b701ec6c3 100644 --- a/yaml/demographics_hdb_sg.yaml +++ b/yaml/demographics_hdb_sg.yaml @@ -1,6 +1,7 @@ openapi: 3.0.1 info: title: HDB Demographics (SG) + x-subscribelink: demographics_hdb_sg description: |+ This Data microservice returns information on Housing Development Board of Singapore (HDB) estates that includes location address, postal code, gender and age groups, down to block-level granularity. The HDB POTH programme makes selected public and non-public datasets available to developers and companies to improve their service offerings to benefit the lives of Singapore citizens. Sentient.io is proud to partner with HDB to manage and facilitate the sharing of data for the POTH Programme. From ec37bd0e375c417d8285b6d465700162fd71de4c Mon Sep 17 00:00:00 2001 From: Priyadharshini <57977344+priyadharshini-sent@users.noreply.github.com> Date: Wed, 30 Sep 2020 19:27:49 +0530 Subject: [PATCH 083/792] Update flat_ownership_hdb_sg.yaml --- yaml/flat_ownership_hdb_sg.yaml | 1 + 1 file changed, 1 insertion(+) diff --git a/yaml/flat_ownership_hdb_sg.yaml b/yaml/flat_ownership_hdb_sg.yaml index c51acf96b..e4843f424 100644 --- a/yaml/flat_ownership_hdb_sg.yaml +++ b/yaml/flat_ownership_hdb_sg.yaml @@ -1,6 +1,7 @@ openapi: 3.0.1 info: title: HDB Flat Ownership Duration (SG) + x-subscribelink: flat_ownership_hdb_sg description: |+ This Data microservice returns information on flat ownership within Housing Development Board of Singapore (HDB) estates that includes location address, postal code, length of ownership and their quantity in units. From bc467d8d7f33eec50a3876dc861a90dc0b2e66e5 Mon Sep 17 00:00:00 2001 From: Priyadharshini <57977344+priyadharshini-sent@users.noreply.github.com> Date: Wed, 30 Sep 2020 19:28:45 +0530 Subject: [PATCH 084/792] Update season_parking_availability_hdb_sg.yaml --- yaml/season_parking_availability_hdb_sg.yaml | 1 + 1 file changed, 1 insertion(+) diff --git a/yaml/season_parking_availability_hdb_sg.yaml b/yaml/season_parking_availability_hdb_sg.yaml index 08fa0f339..1a3fc09db 100644 --- a/yaml/season_parking_availability_hdb_sg.yaml +++ b/yaml/season_parking_availability_hdb_sg.yaml @@ -1,6 +1,7 @@ openapi: 3.0.1 info: title: HDB Season Parking Availability (SG) + x-subscribelink: season_parking_availability_hdb_sg description: |+ This Data microservice returns season car park availability information within Housing Development Board of Singapore (HDB) estates that includes location address, postal code, branch office, vehicle type and parking lot availability for different types of vehicle by carpark location. From 3740f5033d1c5ec78461f097808c35828f935ceb Mon Sep 17 00:00:00 2001 From: Priyadharshini <57977344+priyadharshini-sent@users.noreply.github.com> Date: Wed, 30 Sep 2020 19:29:16 +0530 Subject: [PATCH 085/792] Update directory_of_singapore_startups.yaml --- yaml/directory_of_singapore_startups.yaml | 1 + 1 file changed, 1 insertion(+) diff --git a/yaml/directory_of_singapore_startups.yaml b/yaml/directory_of_singapore_startups.yaml index 219b63d44..0039eb943 100644 --- a/yaml/directory_of_singapore_startups.yaml +++ b/yaml/directory_of_singapore_startups.yaml @@ -1,6 +1,7 @@ openapi: 3.0.1 info: title: Directory of Singapore Startups + x-subscribelink: directory_of_singapore_startups description: |+ This Data microservice retrieves the list of all Singapore startup companies found on the internet through web scraping. Updated quarterly. x-additionalinfo: |+ From 1547a26d9aaeeeffb96ed044b126eca9ecc3515d Mon Sep 17 00:00:00 2001 From: Priyadharshini <57977344+priyadharshini-sent@users.noreply.github.com> Date: Wed, 30 Sep 2020 19:29:42 +0530 Subject: [PATCH 086/792] Update fitness_stations_and_playgrounds_hdb_sg.yaml --- yaml/fitness_stations_and_playgrounds_hdb_sg.yaml | 1 + 1 file changed, 1 insertion(+) diff --git a/yaml/fitness_stations_and_playgrounds_hdb_sg.yaml b/yaml/fitness_stations_and_playgrounds_hdb_sg.yaml index 3d7ca3e8e..5e457fa6c 100644 --- a/yaml/fitness_stations_and_playgrounds_hdb_sg.yaml +++ b/yaml/fitness_stations_and_playgrounds_hdb_sg.yaml @@ -1,6 +1,7 @@ openapi: 3.0.1 info: title: HDB Fitness Stations and Playgrounds (SG) + x-subscribelink: fitness_stations_and_playgrounds_hdb_sg description: |+ This Data microservice captures the indicative outline of fitness stations/playgrounds for all Housing Development Board of Singapore (HDB) Towns, HDB Estates and on HDB Land. The features were identified visually from high definition ortho-rectified aerial imagery (2014) and manually digitized. Objects largely obstructed by trees, structures and/or shadow are likely not captured in this dataset. The outlines of partially obstructed objects were extrapolated where possible and may not fully represent the actual shape of the actual object. As this is a dataset download microservice, a successful call will return a pre-signed URL where the entire dataset can be downloaded as a CSV file. From 2beda33dd552cd8092d1831b02677ad227c9eb49 Mon Sep 17 00:00:00 2001 From: Priyadharshini <57977344+priyadharshini-sent@users.noreply.github.com> Date: Wed, 30 Sep 2020 19:30:16 +0530 Subject: [PATCH 087/792] Update amenities_lamp_posts_hdb_sg.yaml --- yaml/amenities_lamp_posts_hdb_sg.yaml | 1 + 1 file changed, 1 insertion(+) diff --git a/yaml/amenities_lamp_posts_hdb_sg.yaml b/yaml/amenities_lamp_posts_hdb_sg.yaml index 777970c09..5c2a09439 100644 --- a/yaml/amenities_lamp_posts_hdb_sg.yaml +++ b/yaml/amenities_lamp_posts_hdb_sg.yaml @@ -1,6 +1,7 @@ openapi: 3.0.1 info: title: HDB Lamp Posts Locations (SG) + x-subscribelink: amenities_lamp_posts_hdb_sg description: |+ This Data microservice returns the indicative location of lamp posts for all Housing Development Board of Singapore (HDB) Towns, HDB Estates and on HDB Land. The features were identified visually from high definition ortho-rectified aerial imagery and manually digitised. The imagery was obtained from Singapore Land Authority (SLA) (captured in 2014). Objects largely obstructed by trees, structures and / or shadow are likely not captured in this dataset. As this is a dataset download microservice, a successful call will return a pre-signed URL where the entire dataset can be downloaded as a CSV file. From 0016be015ad9da74a0be3173b80e56fea3c052af Mon Sep 17 00:00:00 2001 From: Priyadharshini <57977344+priyadharshini-sent@users.noreply.github.com> Date: Wed, 30 Sep 2020 19:30:48 +0530 Subject: [PATCH 088/792] Update amenities_hardcourts_hdb_sg.yaml --- yaml/amenities_hardcourts_hdb_sg.yaml | 1 + 1 file changed, 1 insertion(+) diff --git a/yaml/amenities_hardcourts_hdb_sg.yaml b/yaml/amenities_hardcourts_hdb_sg.yaml index fc748c982..48324a035 100644 --- a/yaml/amenities_hardcourts_hdb_sg.yaml +++ b/yaml/amenities_hardcourts_hdb_sg.yaml @@ -1,6 +1,7 @@ openapi: 3.0.1 info: title: HDB Hardcourts Locations (SG) + x-subscribelink: amenities_hardcourts_hdb_sg description: |+ This Data microservice returns the indicative outline of hardcourts for all Housing Development Board of Singapore (HDB) Towns, HDB Estates and on HDB Land. The features were identified visually from high definition ortho-rectified aerial imagery and manually digitised. The imagery was obtained from Singapore Land Authority (SLA) (captured in 2014). Objects largely obstructed by trees, structures and / or shadow are likely not captured in this dataset. The outlines of partially obstructed objects were extrapolated where possible and may not fully represent the actual shape of the actual object. As this is a dataset download microservice, a successful call will return a pre-signed URL where the entire dataset can be downloaded as a CSV file. From c1506ddbc7eb1f59081aa64ca7812fcc089c49db Mon Sep 17 00:00:00 2001 From: Priyadharshini <57977344+priyadharshini-sent@users.noreply.github.com> Date: Wed, 30 Sep 2020 19:31:30 +0530 Subject: [PATCH 089/792] Update amenities_shelters_hdb_sg.yaml --- yaml/amenities_shelters_hdb_sg.yaml | 1 + 1 file changed, 1 insertion(+) diff --git a/yaml/amenities_shelters_hdb_sg.yaml b/yaml/amenities_shelters_hdb_sg.yaml index 4ebea897a..fad46f2fe 100644 --- a/yaml/amenities_shelters_hdb_sg.yaml +++ b/yaml/amenities_shelters_hdb_sg.yaml @@ -1,6 +1,7 @@ openapi: 3.0.1 info: title: HDB Shelters Locations (SG) + x-subscribelink: amenities_shelters_hdb_sg description: |+ This Data microservice returns the indicative outline of shelters for all HDB Towns and Estates and only on HDB Land. The features were identified visually from high definition ortho-rectified aerial imagery and manually digitised. The imagery was obtained from SLA (captured in 2014). Objects largely obstructed by trees, structures and / or shadow are likely not captured in this dataset. The outlines of partially obstructed objects were extrapolated where possible and may not fully represent the actual shape of the actual object. Precinct Pavilions are not included in this microservice. As this is a dataset download microservice, a successful call will return a pre-signed URL where the entire dataset can be downloaded as a CSV file. From d5ea6f5b2e0b5a551b1bf9b3da633468899fcc10 Mon Sep 17 00:00:00 2001 From: rameshsentient <51635015+rameshsentient@users.noreply.github.com> Date: Thu, 1 Oct 2020 11:23:07 +0530 Subject: [PATCH 090/792] Update spacy_named-entity_recognition_eng.yaml --- yaml/spacy_named-entity_recognition_eng.yaml | 11 +++++------ 1 file changed, 5 insertions(+), 6 deletions(-) diff --git a/yaml/spacy_named-entity_recognition_eng.yaml b/yaml/spacy_named-entity_recognition_eng.yaml index 19cd324ca..6d8bd26f9 100644 --- a/yaml/spacy_named-entity_recognition_eng.yaml +++ b/yaml/spacy_named-entity_recognition_eng.yaml @@ -2,12 +2,11 @@ openapi: 3.0.1 info: title: spaCy NER description: |+ - This NLP microservice locates and classifies the named-entities classes from input unstructured English text. - - The named-entity classes extracted are - person, norp, fac, org, gpe, loc, product, event, work_of_art, law, language, date, time, percent, money, quantity, ordinal, cardinal - - This microservice automatically extracts structured information from unstructured text data such as chatlogs, emails, news articles, etc. + This NLP microservice locates and classifies the named-entities classes from input unstructured English text, based on the spaCy model. + + The named-entity classes extracted include persons, nationalities, religious groups, political groups, buildings and facilities, organisations, geopolitical, locations, products, events, works of art, laws, languages, dates and time, percentages, monetary values, quantities, ordinals and cardinals. + + This microservice automatically extracts structured information from unstructured text data such as chatlogs, emails, news articles, etc. version: '0.1' x-subscribelink: spacy_ner servers: From e2e198286ed1ed993e2b9a437995c110d255fb72 Mon Sep 17 00:00:00 2001 From: Zhang Qiao <61284893+zqTheDesigner@users.noreply.github.com> Date: Thu, 1 Oct 2020 18:14:09 +0800 Subject: [PATCH 091/792] Update BriefFinancialExtractionDun&Bradstreet(SG).yaml Add quotation mark to TOT_ITEMS example --- yaml/BriefFinancialExtractionDun&Bradstreet(SG).yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/yaml/BriefFinancialExtractionDun&Bradstreet(SG).yaml b/yaml/BriefFinancialExtractionDun&Bradstreet(SG).yaml index 4d32f6888..e120b8c02 100644 --- a/yaml/BriefFinancialExtractionDun&Bradstreet(SG).yaml +++ b/yaml/BriefFinancialExtractionDun&Bradstreet(SG).yaml @@ -1350,7 +1350,7 @@ components: ENQUIRY: type: object example: |+ - 197601887ETRANSTAR TRAVEL PTE LTD + "197601887ETRANSTAR TRAVEL PTE LTD" description: Contains information of each request details default: true properties: From d2ce4dc6ac2ec8760614907fa66bd2175e1cb768 Mon Sep 17 00:00:00 2001 From: priyaPeristera Date: Fri, 2 Oct 2020 15:02:05 +1000 Subject: [PATCH 092/792] Update online_automatic_speech_recognition_eng_sg.yaml --- yaml/online_automatic_speech_recognition_eng_sg.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/yaml/online_automatic_speech_recognition_eng_sg.yaml b/yaml/online_automatic_speech_recognition_eng_sg.yaml index cacf491eb..8511c1319 100644 --- a/yaml/online_automatic_speech_recognition_eng_sg.yaml +++ b/yaml/online_automatic_speech_recognition_eng_sg.yaml @@ -12,6 +12,6 @@ tags: description: " " html: |+
-
From 4ce5ae3a1b826f5b65a09371171c869942bcf61c Mon Sep 17 00:00:00 2001 From: priyaPeristera Date: Fri, 2 Oct 2020 16:34:55 +1000 Subject: [PATCH 093/792] Update named-entity_recognition_eng_v1.0.yaml --- yaml/named-entity_recognition_eng_v1.0.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/yaml/named-entity_recognition_eng_v1.0.yaml b/yaml/named-entity_recognition_eng_v1.0.yaml index bd5e55add..ac9469650 100644 --- a/yaml/named-entity_recognition_eng_v1.0.yaml +++ b/yaml/named-entity_recognition_eng_v1.0.yaml @@ -1,6 +1,6 @@ openapi: 3.0.1 info: - title: Named-Entity Recognition ENG Updated + title: Named-Entity Recognition ENG description: |+ This NLP microservice locates and classifies the named-entities classes from input unstructured English text. From a9531df00ffb72c377dc65b586ec6e23bf642956 Mon Sep 17 00:00:00 2001 From: priyaPeristera Date: Fri, 2 Oct 2020 21:01:47 +1000 Subject: [PATCH 094/792] Update inverse_text_normalisation_eng.yaml --- yaml/inverse_text_normalisation_eng.yaml | 24 ------------------------ 1 file changed, 24 deletions(-) diff --git a/yaml/inverse_text_normalisation_eng.yaml b/yaml/inverse_text_normalisation_eng.yaml index 6239e3bcc..e9608478b 100644 --- a/yaml/inverse_text_normalisation_eng.yaml +++ b/yaml/inverse_text_normalisation_eng.yaml @@ -187,9 +187,6 @@ components: type: array required: - text - - start - - end - - seqNum items: type: object properties: @@ -200,27 +197,6 @@ components: example: Apple said the project-financing fund was the first of its kind Real estate developers often secure bonds for affordable housing development but must service the debt during construction until the houses are built and start to generate revenue Apple and state officials hope to provide bridge financing during construction at rates below those from commercial lenders description: |+ Input text - start: - x-name: start - type: string - default: true - example: "20.44" - description: |+ - Start time - end: - x-name: end - type: string - default: true - example: "28.4" - description: |+ - End time - seqNum: - x-name: seqNum - type: string - default: true - example: "4" - description: |+ - text order id securitySchemes: APIAuthorizer: type: apiKey From 7a9fe88e320d9834b2a1f0e946d4159741a2bb19 Mon Sep 17 00:00:00 2001 From: Priyadharshini <57977344+priyadharshini-sent@users.noreply.github.com> Date: Fri, 2 Oct 2020 16:55:41 +0530 Subject: [PATCH 095/792] Update index.yaml --- yaml/index.yaml | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/yaml/index.yaml b/yaml/index.yaml index 6efef16e4..c7387520e 100644 --- a/yaml/index.yaml +++ b/yaml/index.yaml @@ -211,6 +211,22 @@ Data: title: HDB Shelters Locations (SG) versions: v0.1: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/amenities_shelters_hdb_sg.yaml" + Business Check Plus Dun & Bradstreet (SG): + title: Business Check Plus Dun & Bradstreet (SG) + versions: + v0.1: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/BusinessCheckPlusDun&Bradstreet(SG).yaml" + Basic Individual Search Dun & Bradstreet (SG): + title: Basic Individual Search Dun & Bradstreet (SG) + versions: + v0.1: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/BasicIndividualSearchDun&Bradstreet(SG).yaml" + Business Check Dun & Bradstreet (SG): + title: Business Check Dun & Bradstreet (SG) + versions: + v0.1: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/BusinessCheckDun&Bradstreet(SG).yaml" + Brief Financial Extraction Dun & Bradstreet (SG): + title: Brief Financial Extraction Dun & Bradstreet (SG) + versions: + v0.1: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/BriefFinancialExtractionDun&Bradstreet(SG).yaml" Data Alliance: Download Dataset API: title: Download Dataset API From 64643f79b5f35ffe58e7fa3d9d1dbd6b82bd9571 Mon Sep 17 00:00:00 2001 From: priyaPeristera Date: Fri, 2 Oct 2020 21:42:26 +1000 Subject: [PATCH 096/792] Update index.yaml --- yaml/index.yaml | 24 ++++++++++++------------ 1 file changed, 12 insertions(+), 12 deletions(-) diff --git a/yaml/index.yaml b/yaml/index.yaml index c7387520e..5a59d1225 100644 --- a/yaml/index.yaml +++ b/yaml/index.yaml @@ -211,22 +211,22 @@ Data: title: HDB Shelters Locations (SG) versions: v0.1: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/amenities_shelters_hdb_sg.yaml" - Business Check Plus Dun & Bradstreet (SG): - title: Business Check Plus Dun & Bradstreet (SG) + D&B Business Check Plus (SG): + title: D&B Business Check Plus (SG) versions: - v0.1: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/BusinessCheckPlusDun&Bradstreet(SG).yaml" - Basic Individual Search Dun & Bradstreet (SG): - title: Basic Individual Search Dun & Bradstreet (SG) + v0.1: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/d&b_business_check_plus_sg.yaml" + D&B Basic Individual Search (SG): + title: D&B Basic Individual Search (SG) versions: - v0.1: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/BasicIndividualSearchDun&Bradstreet(SG).yaml" - Business Check Dun & Bradstreet (SG): - title: Business Check Dun & Bradstreet (SG) + v0.1: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/d&b_basic_individual_search_sg.yaml" + D&B Business Check (SG): + title: D&B Business Check (SG) versions: - v0.1: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/BusinessCheckDun&Bradstreet(SG).yaml" - Brief Financial Extraction Dun & Bradstreet (SG): - title: Brief Financial Extraction Dun & Bradstreet (SG) + v0.1: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/d&b_business_check_sg.yaml" + D&B Brief Financial Information (SG): + title: D&B Brief Financial Information (SG) versions: - v0.1: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/BriefFinancialExtractionDun&Bradstreet(SG).yaml" + v0.1: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/d&b_brief_financial_information_sg.yaml" Data Alliance: Download Dataset API: title: Download Dataset API From cc0c5cbd15e57597df4b403efe3d730a1290ae33 Mon Sep 17 00:00:00 2001 From: priyaPeristera Date: Fri, 2 Oct 2020 21:43:08 +1000 Subject: [PATCH 097/792] Update and rename BasicIndividualSearchDun&Bradstreet(SG).yaml to d&b_basic_individual_search_sg.yaml --- ...&Bradstreet(SG).yaml => d&b_basic_individual_search_sg.yaml} | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) rename yaml/{BasicIndividualSearchDun&Bradstreet(SG).yaml => d&b_basic_individual_search_sg.yaml} (99%) diff --git a/yaml/BasicIndividualSearchDun&Bradstreet(SG).yaml b/yaml/d&b_basic_individual_search_sg.yaml similarity index 99% rename from yaml/BasicIndividualSearchDun&Bradstreet(SG).yaml rename to yaml/d&b_basic_individual_search_sg.yaml index a4eb784ce..bdd751a03 100644 --- a/yaml/BasicIndividualSearchDun&Bradstreet(SG).yaml +++ b/yaml/d&b_basic_individual_search_sg.yaml @@ -1,6 +1,6 @@ openapi: 3.0.1 info: - title: Basic Individual Search Dun & Bradstreet (SG) + title: D&B Basic Individual Search (SG) description: |+ This Data microservice provides the information on the (Singapore-registered) business interest of an individual that includes the individual’s actual name, residential address, business and shareholding in businesses, current & previous ownership, litigation against individual and businesses, bankruptcy record and count on the times this individual has been searched on. Updated daily. version: '0.1' From 91cc3511f0b5ddc34f86fa8f3c7e4295fa9f369a Mon Sep 17 00:00:00 2001 From: priyaPeristera Date: Fri, 2 Oct 2020 21:43:44 +1000 Subject: [PATCH 098/792] Update and rename BusinessCheckDun&Bradstreet(SG).yaml to d&b_business_check_sg.yaml --- ...sCheckDun&Bradstreet(SG).yaml => d&b_business_check_sg.yaml} | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) rename yaml/{BusinessCheckDun&Bradstreet(SG).yaml => d&b_business_check_sg.yaml} (99%) diff --git a/yaml/BusinessCheckDun&Bradstreet(SG).yaml b/yaml/d&b_business_check_sg.yaml similarity index 99% rename from yaml/BusinessCheckDun&Bradstreet(SG).yaml rename to yaml/d&b_business_check_sg.yaml index 1d8950c0c..f21fa7b75 100644 --- a/yaml/BusinessCheckDun&Bradstreet(SG).yaml +++ b/yaml/d&b_business_check_sg.yaml @@ -1,6 +1,6 @@ openapi: 3.0.1 info: - title: Business Check Dun & Bradstreet (SG) + title: D&B Business Check (SG) description: |+ This Data microservice provides key business information of a Singapore-registered company includes the business name, registration number, registered address and date of change, company status, registered activities, shareholders details (i.e. date of commencement, residing address) capital amount and shares allocated to each shareholders. Updated daily. version: '0.1' From f525c9ab88f6ddf355787f0a540b3f61f43686b2 Mon Sep 17 00:00:00 2001 From: priyaPeristera Date: Fri, 2 Oct 2020 21:44:20 +1000 Subject: [PATCH 099/792] Update and rename BusinessCheckPlusDun&Bradstreet(SG).yaml to d&b_business_check_plus_sg.yaml --- ...sDun&Bradstreet(SG).yaml => d&b_business_check_plus_sg.yaml} | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) rename yaml/{BusinessCheckPlusDun&Bradstreet(SG).yaml => d&b_business_check_plus_sg.yaml} (99%) diff --git a/yaml/BusinessCheckPlusDun&Bradstreet(SG).yaml b/yaml/d&b_business_check_plus_sg.yaml similarity index 99% rename from yaml/BusinessCheckPlusDun&Bradstreet(SG).yaml rename to yaml/d&b_business_check_plus_sg.yaml index 71dce2d07..b144b933a 100644 --- a/yaml/BusinessCheckPlusDun&Bradstreet(SG).yaml +++ b/yaml/d&b_business_check_plus_sg.yaml @@ -1,6 +1,6 @@ openapi: 3.0.1 info: - title: Business Check Plus Dun & Bradstreet (SG) + title: D&B Business Check Plus (SG) description: The Data microservice provides key business information, litigation information (High and Subordinate Courts) and Winding Up Trace of a company including the Business name, registration number, registered address and date of change, company status, registered activities, shareholders details (i.e. date of commencement, residing address) capital amount and shares allocated to each shareholder, litigation information. Updated daily. version: '0.1' servers: From 78b8b3f44043500eb331266a5fc33419696db546 Mon Sep 17 00:00:00 2001 From: priyaPeristera Date: Fri, 2 Oct 2020 21:45:04 +1000 Subject: [PATCH 100/792] Update and rename BriefFinancialExtractionDun&Bradstreet(SG).yaml to d&b_brief_financial_information_sg.yaml --- ...dstreet(SG).yaml => d&b_brief_financial_information_sg.yaml} | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) rename yaml/{BriefFinancialExtractionDun&Bradstreet(SG).yaml => d&b_brief_financial_information_sg.yaml} (99%) diff --git a/yaml/BriefFinancialExtractionDun&Bradstreet(SG).yaml b/yaml/d&b_brief_financial_information_sg.yaml similarity index 99% rename from yaml/BriefFinancialExtractionDun&Bradstreet(SG).yaml rename to yaml/d&b_brief_financial_information_sg.yaml index e120b8c02..a9ed9eeda 100644 --- a/yaml/BriefFinancialExtractionDun&Bradstreet(SG).yaml +++ b/yaml/d&b_brief_financial_information_sg.yaml @@ -1,6 +1,6 @@ openapi: 3.0.1 info: - title: Brief Financial Extraction Dun & Bradstreet (SG) + title: D&B Brief Financial Information (SG) description: This Data microservice provides the annual financial information of the Singapore-registered business, inclusive of annual profit and loss and financial ratios. Updated daily. version: '0.1' servers: From 0e2e132fe286362c23b1873c31e0bbfecd722dc4 Mon Sep 17 00:00:00 2001 From: Priyadharshini <57977344+priyadharshini-sent@users.noreply.github.com> Date: Fri, 2 Oct 2020 17:40:03 +0530 Subject: [PATCH 101/792] Update d&b_basic_individual_search_sg.yaml --- yaml/d&b_basic_individual_search_sg.yaml | 1 + 1 file changed, 1 insertion(+) diff --git a/yaml/d&b_basic_individual_search_sg.yaml b/yaml/d&b_basic_individual_search_sg.yaml index bdd751a03..1883755f4 100644 --- a/yaml/d&b_basic_individual_search_sg.yaml +++ b/yaml/d&b_basic_individual_search_sg.yaml @@ -4,6 +4,7 @@ info: description: |+ This Data microservice provides the information on the (Singapore-registered) business interest of an individual that includes the individual’s actual name, residential address, business and shareholding in businesses, current & previous ownership, litigation against individual and businesses, bankruptcy record and count on the times this individual has been searched on. Updated daily. version: '0.1' + x-subscribelink: d&b_basic_individual_search_sg servers: - url: 'https://api.sentient.io' tags: From e29d686bbd6bef86f4e2392fc0b59ab11e1fda4c Mon Sep 17 00:00:00 2001 From: Priyadharshini <57977344+priyadharshini-sent@users.noreply.github.com> Date: Fri, 2 Oct 2020 17:45:49 +0530 Subject: [PATCH 102/792] Update d&b_brief_financial_information_sg.yaml --- yaml/d&b_brief_financial_information_sg.yaml | 1 + 1 file changed, 1 insertion(+) diff --git a/yaml/d&b_brief_financial_information_sg.yaml b/yaml/d&b_brief_financial_information_sg.yaml index a9ed9eeda..8f9d5869c 100644 --- a/yaml/d&b_brief_financial_information_sg.yaml +++ b/yaml/d&b_brief_financial_information_sg.yaml @@ -3,6 +3,7 @@ info: title: D&B Brief Financial Information (SG) description: This Data microservice provides the annual financial information of the Singapore-registered business, inclusive of annual profit and loss and financial ratios. Updated daily. version: '0.1' + x-subscribelink: d&b_brief_financial_information_sg servers: - url: 'https://api.sentient.io' tags: From a4580170bcfe13cc27e5f0286b9d327f43f274d5 Mon Sep 17 00:00:00 2001 From: Priyadharshini <57977344+priyadharshini-sent@users.noreply.github.com> Date: Fri, 2 Oct 2020 17:46:52 +0530 Subject: [PATCH 103/792] Update d&b_business_check_plus_sg.yaml --- yaml/d&b_business_check_plus_sg.yaml | 1 + 1 file changed, 1 insertion(+) diff --git a/yaml/d&b_business_check_plus_sg.yaml b/yaml/d&b_business_check_plus_sg.yaml index b144b933a..7d221b019 100644 --- a/yaml/d&b_business_check_plus_sg.yaml +++ b/yaml/d&b_business_check_plus_sg.yaml @@ -3,6 +3,7 @@ info: title: D&B Business Check Plus (SG) description: The Data microservice provides key business information, litigation information (High and Subordinate Courts) and Winding Up Trace of a company including the Business name, registration number, registered address and date of change, company status, registered activities, shareholders details (i.e. date of commencement, residing address) capital amount and shares allocated to each shareholder, litigation information. Updated daily. version: '0.1' + x-subscribelink: d&b_business_check_plus_sg servers: - url: 'https://api.sentient.io' tags: From 7b15a2d3e1f78363ead0c764e1138f116f98710a Mon Sep 17 00:00:00 2001 From: Priyadharshini <57977344+priyadharshini-sent@users.noreply.github.com> Date: Fri, 2 Oct 2020 17:47:31 +0530 Subject: [PATCH 104/792] Update d&b_business_check_sg.yaml --- yaml/d&b_business_check_sg.yaml | 1 + 1 file changed, 1 insertion(+) diff --git a/yaml/d&b_business_check_sg.yaml b/yaml/d&b_business_check_sg.yaml index f21fa7b75..ef145fd1a 100644 --- a/yaml/d&b_business_check_sg.yaml +++ b/yaml/d&b_business_check_sg.yaml @@ -4,6 +4,7 @@ info: description: |+ This Data microservice provides key business information of a Singapore-registered company includes the business name, registration number, registered address and date of change, company status, registered activities, shareholders details (i.e. date of commencement, residing address) capital amount and shares allocated to each shareholders. Updated daily. version: '0.1' + x-subscribelink: d&b_business_check_sg servers: - url: 'https://api.sentient.io' tags: From dae2d3bae5bd5acd9cb146be4d661d1326fae8a4 Mon Sep 17 00:00:00 2001 From: priyaPeristera Date: Fri, 2 Oct 2020 22:23:20 +1000 Subject: [PATCH 105/792] Update d&b_basic_individual_search_sg.yaml --- yaml/d&b_basic_individual_search_sg.yaml | 96 ++++++++++++------------ 1 file changed, 48 insertions(+), 48 deletions(-) diff --git a/yaml/d&b_basic_individual_search_sg.yaml b/yaml/d&b_basic_individual_search_sg.yaml index 1883755f4..feb5f9aff 100644 --- a/yaml/d&b_basic_individual_search_sg.yaml +++ b/yaml/d&b_basic_individual_search_sg.yaml @@ -634,54 +634,54 @@ components: type: string description: Bankruptcy Type example: "COMPANY WINDING UP PETITION" - LIST_PLAINTIFF: - type: array - description: |+ - List of Plaintiff with following children: - [PLAINTIFF] - example: |+ - - - - - - - - - items: - properties: - PLAINTIFF: - type: object - description: |+ - Plaintiff detail with following children: - PLA_NAME - PLA_SOLICITOR - PLA_SOLICITOR_ID - PLA_FILE_REF - example: |+ - - - - - - - properties: - PLA_NAME: - type: string - description: Pla. Name - example: "B 2003 P1" - PLA_SOLICITOR: - type: string - description: Pla. Solicitor - example: "PATRICK KHOO ENG HOCK" - PLA_SOLICITOR_ID: - type: string - description: Pla. Solicitor ID - example: - PLA_FILE_REF: - type: string - description: Pla. File Ref. - example: "RSP/292668/1" + LIST_PLAINTIFF: + type: array + description: |+ + List of Plaintiff with following children: + [PLAINTIFF] + example: |+ + + + + + + + + + items: + properties: + PLAINTIFF: + type: object + description: |+ + Plaintiff detail with following children: + PLA_NAME + PLA_SOLICITOR + PLA_SOLICITOR_ID + PLA_FILE_REF + example: |+ + + + + + + + properties: + PLA_NAME: + type: string + description: Pla. Name + example: "B 2003 P1" + PLA_SOLICITOR: + type: string + description: Pla. Solicitor + example: "PATRICK KHOO ENG HOCK" + PLA_SOLICITOR_ID: + type: string + description: Pla. Solicitor ID + example: + PLA_FILE_REF: + type: string + description: Pla. File Ref. + example: "RSP/292668/1" LIST_LIT: type: array description: |+ From 41d628f091e3c9cd700cc6e44682ecfe813fe16e Mon Sep 17 00:00:00 2001 From: priyaPeristera Date: Fri, 2 Oct 2020 22:39:06 +1000 Subject: [PATCH 106/792] Update d&b_business_check_plus_sg.yaml --- yaml/d&b_business_check_plus_sg.yaml | 13 ++++++++----- 1 file changed, 8 insertions(+), 5 deletions(-) diff --git a/yaml/d&b_business_check_plus_sg.yaml b/yaml/d&b_business_check_plus_sg.yaml index 7d221b019..6de4c65b5 100644 --- a/yaml/d&b_business_check_plus_sg.yaml +++ b/yaml/d&b_business_check_plus_sg.yaml @@ -1540,16 +1540,19 @@ components: example: Rcrptyid : type: string - description: Product Type - example: + description: |+ + Product Type. Possible values are: + 1. Biz Check: 0001 + 2. Biz Check Plus: 0002 + example: 0001 Rcsecflag : - type: string + type: integer description: Differentiate Search By Financial Sectors and Search By Non- Financial Sectors example: 1 LastUpdateDate : - type: string + type: datetime description: Last update date - example: + example: YYYY-MM-DD 00:00:00.0 unauthorized: type: object properties: From fc5177633c68a661bce09ec04aebe7abf5667f14 Mon Sep 17 00:00:00 2001 From: Mohamed Luqman <57977684+mohamedSent@users.noreply.github.com> Date: Fri, 2 Oct 2020 18:23:32 +0530 Subject: [PATCH 107/792] Update d&b_basic_individual_search_sg.yaml --- yaml/d&b_basic_individual_search_sg.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/yaml/d&b_basic_individual_search_sg.yaml b/yaml/d&b_basic_individual_search_sg.yaml index feb5f9aff..b0b36449d 100644 --- a/yaml/d&b_basic_individual_search_sg.yaml +++ b/yaml/d&b_basic_individual_search_sg.yaml @@ -658,7 +658,7 @@ components: PLA_SOLICITOR PLA_SOLICITOR_ID PLA_FILE_REF - example: |+ + example: |+ From eeab73002e61894870891398f71fc2ee380052ec Mon Sep 17 00:00:00 2001 From: Mohamed Luqman <57977684+mohamedSent@users.noreply.github.com> Date: Fri, 2 Oct 2020 18:25:15 +0530 Subject: [PATCH 108/792] Update d&b_basic_individual_search_sg.yaml --- yaml/d&b_basic_individual_search_sg.yaml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/yaml/d&b_basic_individual_search_sg.yaml b/yaml/d&b_basic_individual_search_sg.yaml index b0b36449d..ed01a5760 100644 --- a/yaml/d&b_basic_individual_search_sg.yaml +++ b/yaml/d&b_basic_individual_search_sg.yaml @@ -652,7 +652,7 @@ components: properties: PLAINTIFF: type: object - description: |+ + description: |+ Plaintiff detail with following children: PLA_NAME PLA_SOLICITOR @@ -665,7 +665,7 @@ components: - properties: + properties: PLA_NAME: type: string description: Pla. Name From 5d26602cb69ded0842b60a24bc37939c0bb6e307 Mon Sep 17 00:00:00 2001 From: priyaPeristera Date: Fri, 2 Oct 2020 23:00:12 +1000 Subject: [PATCH 109/792] Update d&b_business_check_plus_sg.yaml --- yaml/d&b_business_check_plus_sg.yaml | 54 +++++++++++++++++----------- 1 file changed, 34 insertions(+), 20 deletions(-) diff --git a/yaml/d&b_business_check_plus_sg.yaml b/yaml/d&b_business_check_plus_sg.yaml index 6de4c65b5..4d69d3bfe 100644 --- a/yaml/d&b_business_check_plus_sg.yaml +++ b/yaml/d&b_business_check_plus_sg.yaml @@ -322,7 +322,7 @@ components: description: System ID example: "DDP" CREATION_DATE: - type: string + type: datetime description: Report request date example: "Wed Apr 08 11:37:51 MYT 2009" USER_ID : @@ -505,7 +505,7 @@ components: description: Subject’s ID Number (individual) or Registration Number (company/business) example: "197401835M" REQ_DATE: - type: string + type: date description: Report Requested Date example: "2009-04-08 11:36:03.611" REQ_REG_NO: @@ -537,7 +537,7 @@ components: description: Description example: "Employee Size" AMOUNT: - type: string + type: integer description: Number of employee example: "300" LIST_BIZ_BRANCH : @@ -1232,7 +1232,13 @@ components: example: UNITED STATES OF AMERICA, DOLLARS SHAREHOLDER_TYPE : type: string - description: Indicator for Shareholder type + description: |+ + Indicator for Shareholder type. + Possible values are: + 1 Individual + 2 Company + 3 Unregistered foreign company + 4 Unregistered local company example: 2 SHARE_TYPE : type: string @@ -1248,8 +1254,12 @@ components: example: 09/05/2003 ADDR_TYPE : type: string - description: Address Type, indicates if it is Singapore or foreign address. - example: + description: |+ + Address Type, indicates if it is Singapore or foreign address. + Possible values are: + S Indicates Singapore address + - Indicates foreign address + example: S NATIONALITY : type: string description: Nationality @@ -1373,7 +1383,11 @@ components: example: DIRECTOR ADDR_TYPE : type: string - description: Address Type, indicates if it is Singapore or foreign address. + description: |+ + Address Type, indicates if it is Singapore or foreign address. + Possible values are: + S Indicates Singapore address + - Indicates foreign address example: S CESSATION_DATE : type: string @@ -1438,7 +1452,7 @@ components: example: SGD AMOUNT : type: string - description: Amount + description: Amount. Amount values that higher than 1000 have a comma to delimit every 3 digits of the amount value. example: 30000.00 LIST_Ddrptcount : type: array @@ -1483,51 +1497,51 @@ components: description: Internal database value example: N/A Rcjan : - type: string + type: integer description: Count for January example: 1 Rcfeb : - type: string + type: integer description: Count for February example: 1 Rcmar : - type: string + type: integer description: Count for March example: 1 Rcapr : - type: string + type: integer description: Count for April example: 1 Rcmay : - type: string + type: integer description: Count for May example: 1 Rcjun : - type: string + type: integer description: Count for June example: 1 Rcjul : - type: string + type: integer description: Count for July example: 1 Rcaug : - type: string + type: integer description: Count for August example: 1 Rcsep : - type: string + type: integer description: Count for September example: 1 Rcoct : - type: string + type: integer description: Count for October example: Rcnov : - type: string + type: integer description: Count for November example: 1 Rcdec : - type: string + type: integer description: Count for December example: 1 Rcid : From ed5572a31ed395c040951f040e8134449aef964e Mon Sep 17 00:00:00 2001 From: priyaPeristera Date: Fri, 2 Oct 2020 23:04:06 +1000 Subject: [PATCH 110/792] Update d&b_business_check_plus_sg.yaml --- yaml/d&b_business_check_plus_sg.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/yaml/d&b_business_check_plus_sg.yaml b/yaml/d&b_business_check_plus_sg.yaml index 4d69d3bfe..6fe0f30c3 100644 --- a/yaml/d&b_business_check_plus_sg.yaml +++ b/yaml/d&b_business_check_plus_sg.yaml @@ -505,7 +505,7 @@ components: description: Subject’s ID Number (individual) or Registration Number (company/business) example: "197401835M" REQ_DATE: - type: date + type: datetime description: Report Requested Date example: "2009-04-08 11:36:03.611" REQ_REG_NO: From f040d392892ba7409211c9c49e7a957efbf8565c Mon Sep 17 00:00:00 2001 From: priyaPeristera Date: Fri, 2 Oct 2020 23:07:02 +1000 Subject: [PATCH 111/792] Update d&b_business_check_plus_sg.yaml --- yaml/d&b_business_check_plus_sg.yaml | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/yaml/d&b_business_check_plus_sg.yaml b/yaml/d&b_business_check_plus_sg.yaml index 6fe0f30c3..5a26e4618 100644 --- a/yaml/d&b_business_check_plus_sg.yaml +++ b/yaml/d&b_business_check_plus_sg.yaml @@ -324,7 +324,7 @@ components: CREATION_DATE: type: datetime description: Report request date - example: "Wed Apr 08 11:37:51 MYT 2009" + example: Wed Apr 08 11:37:51 MYT 2009 USER_ID : type: string description: Valid user id in DDP system. It is for (For internal use) @@ -507,7 +507,7 @@ components: REQ_DATE: type: datetime description: Report Requested Date - example: "2009-04-08 11:36:03.611" + example: 2009-04-08 11:36:03.611 REQ_REG_NO: type: string description: Request Registration Number @@ -539,7 +539,7 @@ components: AMOUNT: type: integer description: Number of employee - example: "300" + example: 300 LIST_BIZ_BRANCH : type: array description: |+ From b00883dbeefa7b7cec27eec71f572c2134e44968 Mon Sep 17 00:00:00 2001 From: priyaPeristera Date: Fri, 2 Oct 2020 23:13:07 +1000 Subject: [PATCH 112/792] Update d&b_business_check_plus_sg.yaml --- yaml/d&b_business_check_plus_sg.yaml | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/yaml/d&b_business_check_plus_sg.yaml b/yaml/d&b_business_check_plus_sg.yaml index 5a26e4618..3318a8cb1 100644 --- a/yaml/d&b_business_check_plus_sg.yaml +++ b/yaml/d&b_business_check_plus_sg.yaml @@ -1535,7 +1535,7 @@ components: Rcoct : type: integer description: Count for October - example: + example: 1 Rcnov : type: integer description: Count for November @@ -1546,8 +1546,10 @@ components: example: 1 Rcid : type: string - description: Internal database value - example: + description: |+ + Internal database value, respond value from table Primary Key ID + It is for (For internal use) + example: N/A Rcreg : type: string description: Company Registration Number From 517a0096d1e1f2c94c524d9d230311ea732c0f14 Mon Sep 17 00:00:00 2001 From: priyaPeristera Date: Fri, 2 Oct 2020 23:23:58 +1000 Subject: [PATCH 113/792] Delete HDBFlatOwnership(SG).yaml --- yaml/HDBFlatOwnership(SG).yaml | 292 --------------------------------- 1 file changed, 292 deletions(-) delete mode 100644 yaml/HDBFlatOwnership(SG).yaml diff --git a/yaml/HDBFlatOwnership(SG).yaml b/yaml/HDBFlatOwnership(SG).yaml deleted file mode 100644 index 41412b1ce..000000000 --- a/yaml/HDBFlatOwnership(SG).yaml +++ /dev/null @@ -1,292 +0,0 @@ -openapi: 3.0.1 -info: - title: Flat Ownership HDB (SG) - description: This Data microservice returns information on flat ownership within Housing Development Board of Singapore (HDB) estates that includes location address, postal code, length of ownership and their quantity in units.

Authentication:

Authentication is done using the x-api-key in the request header.

Search Types


*All values have to be URL encoded

Keyword search

      Keyword search; search for all searchable fields

      Using querystring:

ang mo kio

      Filter search

      Example 1: Get all results except ang mo kio

      Using fiterdata:

{"must_not":[{"match_phrase":{"street":"ang mo kio"}}]}

      Or

      Using querystring:

      name:"ang mo kio"

      Example 2: Filter results with len_of_ownership t <= 10

      Using fiterdata:

{"filter":[{"match":{"len_of_ownership":"t <= 10"}}]}

Geo search

      Example 1: Geo search; distance in km and lat/lon.

      Using fiterdata:

{"filter":[{"geo_distance":{"distance":"1km","location":"1.3492463819999998,103.7511959"}}]}

      Example 2: Geo search; distance in km and lat/lon and trade type supermarket

      Using fiterdata:

{"filter":[{"geo_distance":{"distance":"1km","location":"1.3492463819999998,103.7511959"}},{"match":{"street":"bukit batok"}}]}

Supported Filter Types:


      must - All of these clauses must match. The equivalent of AND.

      must_not - All of these clauses must not match. The equivalent of NOT.

      should - At least one of these clauses must match. The equivalent of OR.

      filter - Clauses that must match, but are run in non-scoring, filtering mode.

Supported Match Types:


      match - is to search within a full-text field for a single word

      { "match":{"street":"bishan"}}

      match_phrase - is to search a full text field

      { "match_phrase":{ "street":bishan street 24"}}

      match_phrase_prefix - is to search a full text field with prefix

      {"match_phrase_prefix":{"street":"bishan"}}

      term - returns documents that contain one or more exact terms in a provided field.

      {"term":{"street":"bishan"}}

      terms - The terms query is the same as the term query, except you can search for multiple values.

      {"terms":{"street":["bishan","and mo kio"]}}

Sample filterdata JSON:


      {
      "must":[{"match_phrase":{"street":"ang+mo+kio+street+21"}}],
      "filter":[{"match":{"tags.type":"source"}}] ,
      "should":[{"match":{"source":"hdb"}}],
      "must_not":[{"match":{"len_of_ownership":"30 < t <= 40"}}
      } - - version: '0.1' -servers: - - url: 'https://api.sentient.io' -tags: -- name: "v0.1" - description: "Published Date - Apr 24, 2020" -paths: - /DaaS/prod/hdb/ownership: - get: - tags: - - v0.1 - parameters: - - in: query - name: querystring - schema: - type: string - description: keyword match to all searchable fields - required: true - - in: query - name: offset - schema: - type: integer - example: "0" - description: The offset of the record list ie the starting index - required: false - - in: query - name: limit - schema: - type: integer - example: 10 - description: The max records to return for the request - required: false - - in: query - name: filterdata - schema: - type: string - description: Additional filter {"must":[ ],"should":[ ],"must_not":[ ],"filter":[ ]} - required: false - responses: - '200': - description: success response - content: - application/json: - schema: - $ref: '#/components/schemas/success' - '401': - description: Unauthorized - content: - application/json: - schema: - $ref: '#/components/schemas/unauthorized' - '402': - description: Payment Required - content: - application/json: - schema: - $ref: '#/components/schemas/paymentrequired' - '403': - description: Forbidden - content: - application/json: - schema: - $ref: '#/components/schemas/forbidden' - '404': - description: Not Found - content: - application/json: - schema: - $ref: '#/components/schemas/notfound' - '419': - description: Input Field Missing - content: - application/json: - schema: - $ref: '#/components/schemas/inputfieldmissing' - '420': - description: Input Limit Exceeded - content: - application/json: - schema: - $ref: '#/components/schemas/inputlimitexceeded' - '500': - description: Internal Server Error - content: - application/json: - schema: - $ref: '#/components/schemas/servererror' - '504': - description: Gateway Timeout - content: - application/json: - schema: - $ref: '#/components/schemas/gatewaytimeout' - security: - - APIAuthorizer: [] -components: - schemas: - success: - type: object - properties: - results: - type: object - properties: - total: - type: number - example: 986 - description: Total number of records - max_score: - type: number - example: 17.995623 - description: The highest score value - hits: - type: array - items: - type: object - properties: - _index: - type: string - description: Index group of the document - example: "sentient_durationofownership_hdb_index" - _type: - type: string - description: Content type of the document - example: "dir_doc" - _id: - type: number - description: Document ID - example: "050533/40 Date: Fri, 2 Oct 2020 23:24:23 +1000 Subject: [PATCH 114/792] Delete DataAllianceDownloadDatasetAPI.yaml --- yaml/DataAllianceDownloadDatasetAPI.yaml | 178 ----------------------- 1 file changed, 178 deletions(-) delete mode 100644 yaml/DataAllianceDownloadDatasetAPI.yaml diff --git a/yaml/DataAllianceDownloadDatasetAPI.yaml b/yaml/DataAllianceDownloadDatasetAPI.yaml deleted file mode 100644 index e3f87c4d3..000000000 --- a/yaml/DataAllianceDownloadDatasetAPI.yaml +++ /dev/null @@ -1,178 +0,0 @@ -openapi: 3.0.1 -info: - title: Data Alliance - Download Dataset API - description: >- - Data Alliance API to download the complete dataset using pre-signed URL. It's a two steps process

Pre-request:

1. Get the organization "API-KEY" from the organization detail page
2. Decrypted the API endpoint shared in the contract using your private key corresponding to the public key set in the organization detail page. - version: '1.0' -servers: - - url: 'https://api.sentient.io' -paths: - /DaaS/prod/v1/{storagelocation}/{filetype}/{filename}/{proxy}: - get: - tags: - - v0.1 - parameters: - - name: "filename" - in: "path" - required: true - schema: - type: "string" - - name: "proxy" - in: "path" - required: true - schema: - type: "string" - - name: "filetype" - in: "path" - required: true - schema: - type: "string" - - name: "storagelocation" - in: "path" - required: true - schema: - type: "string" - responses: - '200': - description: success response - content: - application/json: - schema: - $ref: '#/components/schemas/success' - '401': - description: Unauthorized - content: - application/json: - schema: - $ref: '#/components/schemas/unauthorized' - '402': - description: Payment Required - content: - application/json: - schema: - $ref: '#/components/schemas/paymentrequired' - '403': - description: Forbidden - content: - application/json: - schema: - $ref: '#/components/schemas/forbidden' - '404': - description: Not Found - content: - application/json: - schema: - $ref: '#/components/schemas/notfound' - '500': - description: Internal Server Error - content: - application/json: - schema: - $ref: '#/components/schemas/servererror' - '504': - description: Gateway Timeout - content: - application/json: - schema: - $ref: '#/components/schemas/gatewaytimeout' - security: - - APIAuthorizer: [] -components: - schemas: - success: - type: object - properties: - results: - type: string - example: url: - status: - type: string - example: success - message: - type: string - example: successfully processed - unauthorized: - type: object - properties: - message: - type: string - example: Missing Authentication Token - status: - type: string - example: Failure - forbidden: - type: object - properties: - message: - type: string - example: Access Denied Unauthorized User - status: - type: string - example: Failure - paymentrequired: - type: object - properties: - message: - type: string - example: Insufficient Credits Kindly Top Up - status: - type: string - example: Failure - notfound: - type: object - properties: - message: - type: string - example: Invalid Request URL - status: - type: string - example: Failure - servererror: - type: object - properties: - message: - type: string - example: Internal Server Error - status: - type: string - example: Failure - gatewaytimeout: - type: object - properties: - message: - type: string - example: Request Timeout - status: - type: string - example: Failure - input: - type: object - properties: - model: - type: string - wav_base64: - type: string - file_type: - type: string - vad_threshold: - type: string - inputwav: - type: object - properties: - model: - type: string - wav_url: - type: string - wav_base64: - type: string - file_type: - type: string - vad_threshold: - type: string - - securitySchemes: - APIAuthorizer: - type: apiKey - name: x-api-key - in: header - x-amazon-apigateway-authtype: custom \ No newline at end of file From 2b1c9091d534f40cde3161016db9ec6b1fee43ec Mon Sep 17 00:00:00 2001 From: priyaPeristera Date: Fri, 2 Oct 2020 23:24:36 +1000 Subject: [PATCH 115/792] Delete Audio convertor.yaml --- yaml/Audio convertor.yaml | 232 -------------------------------------- 1 file changed, 232 deletions(-) delete mode 100644 yaml/Audio convertor.yaml diff --git a/yaml/Audio convertor.yaml b/yaml/Audio convertor.yaml deleted file mode 100644 index 4ac5633bf..000000000 --- a/yaml/Audio convertor.yaml +++ /dev/null @@ -1,232 +0,0 @@ -openapi: 3.0.1 -info: - title: Audio convertor - description: >- - This API is used to convert your audio like music(any format) to the WAV format. - version: '0.1' -servers: - - url: 'https://apis.sentient.io' -tags: -- name: "v0.1" - description: "Published Date - Feb 10, 2020" -paths: - /microservices/utility/audioprocessing/v0.1/getresults: - post: - tags: - - v0.1 - responses: - '200': - description: success response - content: - application/json: - schema: - $ref: '#/components/schemas/success' - example: - results: - AudioContent: actual base64 string of input wav - message: Successfully Processed - status: Success - '401': - description: Unauthorized - content: - application/json: - schema: - $ref: '#/components/schemas/unauthorized' - '402': - description: Payment Required - content: - application/json: - schema: - $ref: '#/components/schemas/paymentrequired' - '403': - description: Forbidden - content: - application/json: - schema: - $ref: '#/components/schemas/forbidden' - '404': - description: Not Found - content: - application/json: - schema: - $ref: '#/components/schemas/notfound' - '419': - description: Input Field Missing - content: - application/json: - schema: - $ref: '#/components/schemas/inputfieldmissing' - '420': - description: Input Limit Exceeded - content: - application/json: - schema: - $ref: '#/components/schemas/inputlimitexceeded' - '500': - description: Internal Server error - content: - application/json: - schema: - $ref: '#/components/schemas/servererror' - '504': - description: Gateway Timeout - content: - application/json: - schema: - $ref: '#/components/schemas/gatewaytimeout' - security: - - APIAuthorizer: [] - requestBody: - content: - multipart/form-data: - schema: - $ref: '#/components/schemas/input' - required: true -components: - schemas: - success: - type: object - properties: - results: - type: string - example: - AudioContent: UklGRgaAoQBXQVZFZm10IBAAAAABAAIARKwAABCxAgAEABAATElTVBoAAABJTkZPSVNGVA4AAABMYXZmNTguMjkuMTAwAGRhdGHAf6EAAAAAAAAAAAAAAAAAAAAAAAAAAAAA................. - description: Audio wav file convert to base64 encode string - message: - type: string - example: Successfully Processed - description: Detail description on the API status - status: - type: string - example: Success - description: The status of the API call success/failure - unauthorized: - type: object - properties: - message: - type: string - example: Missing Authentication Token - status: - type: string - example: Failure - forbidden: - type: object - properties: - message: - type: string - example: Access Denied Unauthorized User - status: - type: string - example: Failure - paymentrequired: - type: object - properties: - message: - type: string - example: Insufficient Credits Kindly Top Up - status: - type: string - example: Failure - notfound: - type: object - properties: - message: - type: string - example: Invalid Request URL - status: - type: string - example: Failure - servererror: - type: object - properties: - message: - type: string - example: Internal Server Error - status: - type: string - example: Failure - gatewaytimeout: - type: object - properties: - message: - type: string - example: Request Timeout - status: - type: string - example: Failure - inputfieldmissing: - type: object - properties: - message: - type: string - example: Input Field Missing - status: - type: string - example: Failure - inputlimitexceeded: - type: object - properties: - message: - type: string - example: Input Limit Exceeded - status: - type: string - example: Failure - versions: - type: object - properties: - v1.0: - type: array - items: - oneOf: - - type: string - example: Published Date - Feb 10, 2020 - description: Initial version release - input: - type: object - required: - - filePath - properties: - filePath: - type: string - format: binary - default: true - example: upload file - description: Maximum file size up to 10MB - samplerate: - type: string - default: false - example: '16000' - description: Sample rate of the audio file in Hz - channel: - type: string - default: false - example: '1' - description: Indicates the type of audio channel. Value must be 1 for mono or 2 for Stereo. Default is 2(Stereo) - bitrate: - type: string - default: false - example: '4' - description: Indicates the bit resolution. Value must be 1(8bit) or 2 (16 bit) or 4(32bit) - normalize: - type: string - default: false - example: yes or no - description: A boolean value that indicates whether to normalize the audio or not. Values must be either “yes” or “no” - trim_start_time: - type: string - default: false - example: '1' - description: Indicates the start in seconds between which the audio is extracted - trim_stop_time: - type: string - default: false - example: '5' - description: Indicates the end time in seconds between which the audio is extracted - securitySchemes: - APIAuthorizer: - type: apiKey - name: x-api-key - in: header - x-amazon-apigateway-authtype: custom - description: Authentication is done using the x-api-key in the request header From 0683e38111bfbc1997c7e80b49555f031bb81030 Mon Sep 17 00:00:00 2001 From: Mohamed Luqman <57977684+mohamedSent@users.noreply.github.com> Date: Fri, 2 Oct 2020 19:18:40 +0530 Subject: [PATCH 116/792] Update d&b_business_check_sg.yaml --- yaml/d&b_business_check_sg.yaml | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/yaml/d&b_business_check_sg.yaml b/yaml/d&b_business_check_sg.yaml index ef145fd1a..87e5a88f5 100644 --- a/yaml/d&b_business_check_sg.yaml +++ b/yaml/d&b_business_check_sg.yaml @@ -271,15 +271,15 @@ components: REG_ACTIVITY_DESC1: type: string description: Registered Activities Description - example: + example: "N/A" REG_ACTIVITY_DESC2: type: string description: Registered Activities Description - example: + example: "N/A" AUDITOR: type: string description: Auditor Name - example: + example: "N/A" AUDITOR_APPMT_DATE: type: string description: Auditor Appointment Date @@ -390,7 +390,7 @@ components: ADDR_BUILDING: type: string description: Building Name - example: + example: "N/A" ADDR_POSTCODE: type: string description: Postcode @@ -460,7 +460,7 @@ components: STATUS_SATISFACTION: type: string description: Status of Satisfaction - example: + example: "N/A" LIST_LIQUIDATOR: type: array description: |+ From 71f943165e08f936747eb488063a2320f5c17662 Mon Sep 17 00:00:00 2001 From: priyaPeristera Date: Sat, 3 Oct 2020 00:10:15 +1000 Subject: [PATCH 117/792] Update d&b_business_check_plus_sg.yaml --- yaml/d&b_business_check_plus_sg.yaml | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/yaml/d&b_business_check_plus_sg.yaml b/yaml/d&b_business_check_plus_sg.yaml index 3318a8cb1..5efd41e63 100644 --- a/yaml/d&b_business_check_plus_sg.yaml +++ b/yaml/d&b_business_check_plus_sg.yaml @@ -1563,7 +1563,11 @@ components: example: 0001 Rcsecflag : type: integer - description: Differentiate Search By Financial Sectors and Search By Non- Financial Sectors + description: |+ + Differentiate Search By Financial Sectors and Search By Non- Financial Sectors. + Possible values are: + 1 SEARCH BY FINANCIAL SECTORS + 0 SEARCH BY NON FINANCIAL SECTORS example: 1 LastUpdateDate : type: datetime From ae72e7ac9782545281a1b715817e46fe306e1e9d Mon Sep 17 00:00:00 2001 From: Mohamed Luqman <57977684+mohamedSent@users.noreply.github.com> Date: Fri, 2 Oct 2020 19:56:40 +0530 Subject: [PATCH 118/792] Update d&b_business_check_sg.yaml --- yaml/d&b_business_check_sg.yaml | 39 ++++++++++++++++++++++++--------- 1 file changed, 29 insertions(+), 10 deletions(-) diff --git a/yaml/d&b_business_check_sg.yaml b/yaml/d&b_business_check_sg.yaml index 87e5a88f5..c279ff569 100644 --- a/yaml/d&b_business_check_sg.yaml +++ b/yaml/d&b_business_check_sg.yaml @@ -357,7 +357,7 @@ components: description: Description example: "Employee Size" AMOUNT: - type: string + type: integer description: Number of employee example: "300" LIST_BIZ_BRANCH : @@ -689,7 +689,13 @@ components: example: UNITED STATES OF AMERICA, DOLLARS SHAREHOLDER_TYPE : type: string - description: Indicator for Shareholder type + description: |+ + Indicator for Shareholder type + Possible values are: + 1 Individual + 2 Company + 3 Unregistered foreign company + 4 Unregistered local company example: 2 SHARE_TYPE : type: string @@ -830,7 +836,11 @@ components: example: DIRECTOR ADDR_TYPE : type: string - description: Address Type, indicates if it is Singapore or foreign address. + description: |+ + Address Type, indicates if it is Singapore or foreign address. + Possible values are: + S Indicates Singapore address + - Indicates foreign address example: S CESSATION_DATE : type: string @@ -988,25 +998,34 @@ components: description: Count for December example: 1 Rcid : - type: integer - description: Internal database value - example: + type: string + description: |+ + Internal database value, respond value from table Primary Key ID + It is for (For internal use) + example: N/A Rcreg : type: string description: Company Registration Number example: Rcrptyid : type: string - description: Product Type - example: + description: |+ + Product Type. Possible values are: + 1. Biz Check: 0001 + 2. Biz Check Plus: 0002 + example: 0001 Rcsecflag : type: integer - description: Differentiate Search By Financial Sectors and Search By Non- Financial Sectors + description: |+ + Differentiate Search By Financial Sectors and Search By Non- Financial Sectors. + Possible values are: + 1 SEARCH BY FINANCIAL SECTORS + 0 SEARCH BY NON FINANCIAL SECTORS example: 1 LastUpdateDate : type: string description: Last update date - example: + example: YYYY-MM-DD 00:00:00.0 unauthorized: type: object properties: From 9d3aca72e9c1278b5b4496ef12882025e8830786 Mon Sep 17 00:00:00 2001 From: priyaPeristera Date: Thu, 8 Oct 2020 23:17:37 +1100 Subject: [PATCH 119/792] Update audio_format_convertor.yaml --- yaml/audio_format_convertor.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/yaml/audio_format_convertor.yaml b/yaml/audio_format_convertor.yaml index c35493f54..8f1408991 100644 --- a/yaml/audio_format_convertor.yaml +++ b/yaml/audio_format_convertor.yaml @@ -1,6 +1,6 @@ openapi: 3.0.1 info: - title: Audio convertor + title: Audio Format Convertor description: >- This API is used to convert your audio like music(any format) to the WAV format. version: '0.1' From e49caad6bee9cc8b0ae08757e56b938ad6eabb72 Mon Sep 17 00:00:00 2001 From: priyaPeristera Date: Thu, 8 Oct 2020 23:18:10 +1100 Subject: [PATCH 120/792] Update and rename wikipedia_retrieval_eng.yaml to wikipedia_retrieval.yaml --- ...{wikipedia_retrieval_eng.yaml => wikipedia_retrieval.yaml} | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) rename yaml/{wikipedia_retrieval_eng.yaml => wikipedia_retrieval.yaml} (99%) diff --git a/yaml/wikipedia_retrieval_eng.yaml b/yaml/wikipedia_retrieval.yaml similarity index 99% rename from yaml/wikipedia_retrieval_eng.yaml rename to yaml/wikipedia_retrieval.yaml index 3b5b907c2..ceea86ec0 100644 --- a/yaml/wikipedia_retrieval_eng.yaml +++ b/yaml/wikipedia_retrieval.yaml @@ -1,10 +1,10 @@ openapi: 3.0.1 info: - title: Wikipedia Retrieval ENG + title: Wikipedia Retrieval description: |+ It is an API that provides the user with a Wikipedia article based on the input keyword. Refer to this link for the full list of Wikipedias - https://meta.wikimedia.org/wiki/List_of_Wikipedias version: '0.1' - x-subscribelink: wikipedia_retrieval_eng + x-subscribelink: wikipedia_retrieval servers: - url: 'https://apis.sentient.io' tags: From 320e82085d122fbaf1045f521a0c29c4e19d84bc Mon Sep 17 00:00:00 2001 From: priyaPeristera Date: Thu, 8 Oct 2020 23:19:13 +1100 Subject: [PATCH 121/792] Update index.yaml --- yaml/index.yaml | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/yaml/index.yaml b/yaml/index.yaml index 5a59d1225..f98f6451f 100644 --- a/yaml/index.yaml +++ b/yaml/index.yaml @@ -134,10 +134,10 @@ Utility: title: Decryption using PKI Key versions: v0.1: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/decryption_using_pki_key.yaml" - Wikipedia Retrieval ENG: - title: Wikipedia Retrieval ENG + Wikipedia Retrieval: + title: Wikipedia Retrieval versions: - v0.1: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/wikipedia_retrieval_eng.yaml" + v0.1: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/wikipedia_retrieval.yaml" JSON-CSV Convertor: title: JSON-CSV Convertor versions: From a4bcb3a5b342957251f81cf3833332b77c2944a1 Mon Sep 17 00:00:00 2001 From: rameshsentient <51635015+rameshsentient@users.noreply.github.com> Date: Fri, 9 Oct 2020 09:28:46 +0530 Subject: [PATCH 122/792] Update face_recognition_politicians_sg.yaml --- yaml/face_recognition_politicians_sg.yaml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/yaml/face_recognition_politicians_sg.yaml b/yaml/face_recognition_politicians_sg.yaml index 85643aec1..ba432f649 100644 --- a/yaml/face_recognition_politicians_sg.yaml +++ b/yaml/face_recognition_politicians_sg.yaml @@ -214,9 +214,9 @@ components: x-name: model type: string default: true - example: sg_parliament_2019 + example: sg-parliament-2019 description: |+ - Model name. “sg_parliament_2019” is trained on Singapore Members of Parliament - 2019. + Model name. “sg-parliament-2019” is trained on Singapore Members of Parliament - 2019. img_base64: x-name: img_base64 type: string From 0854099c74e7287d291f3ba79a33c61583227c94 Mon Sep 17 00:00:00 2001 From: rameshsentient <51635015+rameshsentient@users.noreply.github.com> Date: Fri, 9 Oct 2020 09:34:49 +0530 Subject: [PATCH 123/792] Update face_recognition_politicians_sg.yaml --- yaml/face_recognition_politicians_sg.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/yaml/face_recognition_politicians_sg.yaml b/yaml/face_recognition_politicians_sg.yaml index ba432f649..17ae58867 100644 --- a/yaml/face_recognition_politicians_sg.yaml +++ b/yaml/face_recognition_politicians_sg.yaml @@ -236,7 +236,7 @@ components: type: number format: float default: false - example: 1.0 + example: 0.5 description: |+ 0.0 to 1.0. Default is 0.4. Higher threshold will return results with higher confidence. From b647244ead8f1a3d0e6798c4a9da6373f2ff9297 Mon Sep 17 00:00:00 2001 From: rameshsentient <51635015+rameshsentient@users.noreply.github.com> Date: Fri, 9 Oct 2020 09:48:56 +0530 Subject: [PATCH 124/792] Update json-csv_convertor.yaml --- yaml/json-csv_convertor.yaml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/yaml/json-csv_convertor.yaml b/yaml/json-csv_convertor.yaml index 1313b6731..8c351fa0c 100644 --- a/yaml/json-csv_convertor.yaml +++ b/yaml/json-csv_convertor.yaml @@ -9,7 +9,7 @@ servers: - url: 'https://apis.sentient.io' tags: - name: "v1.0" - description: "Published Date - Apr 16, 2020" + description: "Published Date - May 21, 2020" paths: /microservices/utility/jsontocsv/v1.0/getresults: post: @@ -204,7 +204,7 @@ components: items: oneOf: - type: string - example: Published Date - Apr 16, 2020 + example: Published Date - May 21, 2020 description: Initial version release securitySchemes: APIAuthorizer: From cbdeb4ee5eecca360971eb3cd815c6f20e769af2 Mon Sep 17 00:00:00 2001 From: rameshsentient <51635015+rameshsentient@users.noreply.github.com> Date: Fri, 9 Oct 2020 09:49:23 +0530 Subject: [PATCH 125/792] Update csv-json_convertor.yaml --- yaml/csv-json_convertor.yaml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/yaml/csv-json_convertor.yaml b/yaml/csv-json_convertor.yaml index 62b4eba79..af00c6474 100644 --- a/yaml/csv-json_convertor.yaml +++ b/yaml/csv-json_convertor.yaml @@ -9,7 +9,7 @@ servers: - url: 'https://apis.sentient.io' tags: - name: "v1.0" - description: "Published Date - May 07, 2020" + description: "Published Date - May 21, 2020" paths: /microservices/utility/csvtojson/v1.0/getresults: post: @@ -190,7 +190,7 @@ components: items: oneOf: - type: string - example: Published Date - May 07, 2020 + example: Published Date - May 21, 2020 description: Initial version release input: type: object From 611ca51c07afe53eb21a3dd7b36c5df83b735e5e Mon Sep 17 00:00:00 2001 From: rameshsentient <51635015+rameshsentient@users.noreply.github.com> Date: Fri, 9 Oct 2020 09:54:58 +0530 Subject: [PATCH 126/792] Update page_profiler_eng.yaml --- yaml/page_profiler_eng.yaml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/yaml/page_profiler_eng.yaml b/yaml/page_profiler_eng.yaml index c2934f291..17ebd00c8 100644 --- a/yaml/page_profiler_eng.yaml +++ b/yaml/page_profiler_eng.yaml @@ -13,7 +13,7 @@ - url: 'https://apis.sentient.io' tags: - name: "v1.0" - description: "Published Date - Apr 11, 2018" + description: "Published Date - May 15, 2020" paths: /microservices/nlp/pageprofiler/v1.0/getpredictions: post: @@ -185,7 +185,7 @@ items: oneOf: - type: string - example: Published Date - Apr 11, 2018 + example: Published Date - May 15, 2020 description: Initial version release input: type: object From ebc2a856029e2a764358664c2841c30a57420088 Mon Sep 17 00:00:00 2001 From: rameshsentient <51635015+rameshsentient@users.noreply.github.com> Date: Fri, 9 Oct 2020 10:23:32 +0530 Subject: [PATCH 127/792] Update page_profiler_eng_v2.0.yaml --- yaml/page_profiler_eng_v2.0.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/yaml/page_profiler_eng_v2.0.yaml b/yaml/page_profiler_eng_v2.0.yaml index 2fc13f92b..d36399d65 100644 --- a/yaml/page_profiler_eng_v2.0.yaml +++ b/yaml/page_profiler_eng_v2.0.yaml @@ -15,7 +15,7 @@ - name: "v2.0" description: "Published Date - Sep 30, 2020" paths: - /microservices/nlp/pageprofiler/v2.0/getpredictions: + /microservices/nlp/pageprofiler/v2/getpredictions: post: tags: - v2.0 From d6f8829d53c41b6a33514778407dbe95a23fa6a8 Mon Sep 17 00:00:00 2001 From: rameshsentient <51635015+rameshsentient@users.noreply.github.com> Date: Fri, 9 Oct 2020 10:40:10 +0530 Subject: [PATCH 128/792] Update named-entity_recognition_eng_v1.0.yaml --- yaml/named-entity_recognition_eng_v1.0.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/yaml/named-entity_recognition_eng_v1.0.yaml b/yaml/named-entity_recognition_eng_v1.0.yaml index ac9469650..c8cd570c3 100644 --- a/yaml/named-entity_recognition_eng_v1.0.yaml +++ b/yaml/named-entity_recognition_eng_v1.0.yaml @@ -15,7 +15,7 @@ tags: - name: "v1.0" description: "Published Date - Sep 30, 2020" paths: - /microservices/nlp/namedentityrecognition/v1.0/getpredictions: + /microservices/nlp/namedentityrecognition/v1/getpredictions: post: tags: - v1.0 From e98843422be2ac208634bd032a70bca150db4970 Mon Sep 17 00:00:00 2001 From: rameshsentient <51635015+rameshsentient@users.noreply.github.com> Date: Fri, 9 Oct 2020 12:38:01 +0530 Subject: [PATCH 129/792] Update pki_key_generator.yaml --- yaml/pki_key_generator.yaml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/yaml/pki_key_generator.yaml b/yaml/pki_key_generator.yaml index f2207c0c7..cdc6ce57f 100644 --- a/yaml/pki_key_generator.yaml +++ b/yaml/pki_key_generator.yaml @@ -9,7 +9,7 @@ servers: - url: 'https://apis.sentient.io' tags: - name: "v0.1" - description: "Published Date - Mar 13, 2020" + description: "Published Date - Aug 30, 2019" paths: /microservices/utility/rsa_getkeys/v0.1/getresults: post: @@ -179,7 +179,7 @@ components: items: oneOf: - type: string - example: Published Date - Mar 13, 2020 + example: Published Date - Aug 30, 2019 description: Initial version release input: type: object From d54453f7bc819cd1c8f13de013715eb9ce838b16 Mon Sep 17 00:00:00 2001 From: rameshsentient <51635015+rameshsentient@users.noreply.github.com> Date: Fri, 9 Oct 2020 12:39:44 +0530 Subject: [PATCH 130/792] Update encryption_using_pki_key.yaml --- yaml/encryption_using_pki_key.yaml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/yaml/encryption_using_pki_key.yaml b/yaml/encryption_using_pki_key.yaml index b0ca468ad..8de36d739 100644 --- a/yaml/encryption_using_pki_key.yaml +++ b/yaml/encryption_using_pki_key.yaml @@ -11,7 +11,7 @@ servers: - url: 'https://apis.sentient.io' tags: - name: "v0.1" - description: "Published Date - Mar 13, 2020" + description: "Published Date - Aug 30, 2019" paths: /microservices/utility/rsa_encode/v0.1/getresults: post: @@ -194,7 +194,7 @@ components: items: oneOf: - type: string - example: Published Date - Mar 13, 2020 + example: Published Date - Aug 30, 2019 description: Initial version release securitySchemes: APIAuthorizer: From e1a16c0b7b825b6f0e9d1e109f8f877c8003d331 Mon Sep 17 00:00:00 2001 From: rameshsentient <51635015+rameshsentient@users.noreply.github.com> Date: Fri, 9 Oct 2020 12:40:19 +0530 Subject: [PATCH 131/792] Update decryption_using_pki_key.yaml --- yaml/decryption_using_pki_key.yaml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/yaml/decryption_using_pki_key.yaml b/yaml/decryption_using_pki_key.yaml index 707d6f5cd..bab372aa9 100644 --- a/yaml/decryption_using_pki_key.yaml +++ b/yaml/decryption_using_pki_key.yaml @@ -11,7 +11,7 @@ servers: - url: 'https://apis.sentient.io' tags: - name: "v0.1" - description: "Published Date - Mar 13, 2020" + description: "Published Date - Aug 30, 2019" paths: /microservices/utility/rsa_decode/v0.1/getresults: post: @@ -181,7 +181,7 @@ components: items: oneOf: - type: string - example: Published Date - Mar 13, 2020 + example: Published Date - Aug 30, 2019 description: Initial version release input: type: object From 3f08d3d49c9a99b3f9820ca37e26088516fc41af Mon Sep 17 00:00:00 2001 From: rameshsentient <51635015+rameshsentient@users.noreply.github.com> Date: Fri, 9 Oct 2020 12:44:42 +0530 Subject: [PATCH 132/792] Update named-entity_recognition_jp_v1.0.yaml --- yaml/named-entity_recognition_jp_v1.0.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/yaml/named-entity_recognition_jp_v1.0.yaml b/yaml/named-entity_recognition_jp_v1.0.yaml index fa12fa81f..fdd6079ad 100644 --- a/yaml/named-entity_recognition_jp_v1.0.yaml +++ b/yaml/named-entity_recognition_jp_v1.0.yaml @@ -15,7 +15,7 @@ tags: - name: "v1.0" description: "Published Date - Sep 30, 2020" paths: - /microservices/nlp/japanesener/v1.0/getpredictions: + /microservices/nlp/japanesener/v1/getpredictions: post: tags: - v1.0 From ffbebfe899d089ad75d4a5c3f284378965623f07 Mon Sep 17 00:00:00 2001 From: rameshsentient <51635015+rameshsentient@users.noreply.github.com> Date: Fri, 9 Oct 2020 12:58:55 +0530 Subject: [PATCH 133/792] Update named-entity_recognition_thai_v1.0.yaml --- yaml/named-entity_recognition_thai_v1.0.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/yaml/named-entity_recognition_thai_v1.0.yaml b/yaml/named-entity_recognition_thai_v1.0.yaml index a517d65af..0926c28db 100644 --- a/yaml/named-entity_recognition_thai_v1.0.yaml +++ b/yaml/named-entity_recognition_thai_v1.0.yaml @@ -15,7 +15,7 @@ tags: - name: "v1.0" description: "Published Date - Sep 30, 2020" paths: - /microservices/nlp/thainer/v1.0/getpredictions: + /microservices/nlp/thainer/v1/getpredictions: post: tags: - v1.0 From 786a69b808e7da28cd155fc04e21481e02fc4d7a Mon Sep 17 00:00:00 2001 From: rameshsentient <51635015+rameshsentient@users.noreply.github.com> Date: Fri, 9 Oct 2020 15:09:12 +0530 Subject: [PATCH 134/792] Update spacy_named-entity_recognition_eng.yaml --- yaml/spacy_named-entity_recognition_eng.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/yaml/spacy_named-entity_recognition_eng.yaml b/yaml/spacy_named-entity_recognition_eng.yaml index 6d8bd26f9..22df577fc 100644 --- a/yaml/spacy_named-entity_recognition_eng.yaml +++ b/yaml/spacy_named-entity_recognition_eng.yaml @@ -15,7 +15,7 @@ tags: - name: "v0.1" description: "Published Date - Sep 30, 2020" paths: - /microservices/nlp/spacyner/v0.1/getpredictions: + /microservices/nlp/spacyner/v1/getpredictions: post: tags: - v0.1 From 1a232954279d09bd69b820cc7ef8a9330e38f2c7 Mon Sep 17 00:00:00 2001 From: rameshsentient <51635015+rameshsentient@users.noreply.github.com> Date: Fri, 9 Oct 2020 15:28:12 +0530 Subject: [PATCH 135/792] Update page_profiler_jp.yaml --- yaml/page_profiler_jp.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/yaml/page_profiler_jp.yaml b/yaml/page_profiler_jp.yaml index 642262c7d..d8e159466 100644 --- a/yaml/page_profiler_jp.yaml +++ b/yaml/page_profiler_jp.yaml @@ -15,7 +15,7 @@ - name: "v0.1" description: "Published Date - Sep 30, 2020" paths: - /microservices/nlp/pageprofilerjp/v0.1/getpredictions: + /microservices/nlp/pageprofilerjp/v1/getpredictions: post: tags: - v0.1 From 76a235882fc4fa3cb731a38b0a21639c863c3197 Mon Sep 17 00:00:00 2001 From: rameshsentient <51635015+rameshsentient@users.noreply.github.com> Date: Fri, 9 Oct 2020 15:44:46 +0530 Subject: [PATCH 136/792] Update page_profiler_thai.yaml --- yaml/page_profiler_thai.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/yaml/page_profiler_thai.yaml b/yaml/page_profiler_thai.yaml index 7203caf44..e777d3bda 100644 --- a/yaml/page_profiler_thai.yaml +++ b/yaml/page_profiler_thai.yaml @@ -15,7 +15,7 @@ - name: "v0.1" description: "Published Date - Sep 30, 2020" paths: - /microservices/nlp/pageprofilerthai/v0.1/getpredictions: + /microservices/nlp/pageprofilerthai/v1/getpredictions: post: tags: - v0.1 From 0ebb7723c8caaeb7e14ad3c682623e0154458c06 Mon Sep 17 00:00:00 2001 From: priyaPeristera Date: Mon, 12 Oct 2020 12:18:30 +1100 Subject: [PATCH 137/792] Update asr_with_vad_eng_sg.yaml --- yaml/asr_with_vad_eng_sg.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/yaml/asr_with_vad_eng_sg.yaml b/yaml/asr_with_vad_eng_sg.yaml index 737dbc58e..0276240ee 100644 --- a/yaml/asr_with_vad_eng_sg.yaml +++ b/yaml/asr_with_vad_eng_sg.yaml @@ -99,7 +99,7 @@ components: example: 1 description: Running sequence number starts from 1. start: - type: float + type: integer example: 0.64 description: Start time of utterance text: From 27d88feeb4110ba263baa3e7b5519bbbbfdb9203 Mon Sep 17 00:00:00 2001 From: priyaPeristera Date: Wed, 14 Oct 2020 14:43:16 +1100 Subject: [PATCH 138/792] Add files via upload --- yaml/openapi.json | 341 ++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 341 insertions(+) create mode 100644 yaml/openapi.json diff --git a/yaml/openapi.json b/yaml/openapi.json new file mode 100644 index 000000000..08d8b2ac9 --- /dev/null +++ b/yaml/openapi.json @@ -0,0 +1,341 @@ +{ + "openapi": "3.0.1", + "info": { + "title": "ASR with Voice Activity Detection ENG (SG)", + "description": "This Voice microservice combines Voice Activity Detection feature and Automatic Speech Recognition capability. It detects speech in an audio file (.wav format) and transcribes English speech content from the audio stream into text. The transcript text is timestamped for each utterance. An utterance is a continuous piece of speech beginning and ending with a clear pause.\n\nThis Voice microservice performs well on Singapore-accented English speech. For best performance, select the model which best matches the use-case: news_parliament, nsc_parliament, nscfull_8k\n", + "version": "0.1", + "x-subscribelink": "asr_with_vad_eng_sg" + }, + "servers": [ + { + "url": "https://apis.sentient.io" + } + ], + "tags": [ + { + "name": "v0.1", + "description": "Published Date - Sep 30, 2019" + } + ], + "paths": { + "/microservices/voice/vadasr/v0.1/getpredictions": { + "post": { + "tags": [ + "v0.1" + ], + "responses": { + "200": { + "description": "success response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/success" + }, + "example": [ + { + "seqNum": 1, + "start": 0.64, + "end": 23.72, + "text": "HELLO WORLD" + } + ] + } + } + }, + "401": { + "description": "Unauthorized", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/unauthorized" + } + } + } + }, + "402": { + "description": "Payment Required", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/paymentrequired" + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/forbidden" + } + } + } + }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/notfound" + } + } + } + }, + "419": { + "description": "Input Field Missing", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/inputfieldmissing" + } + } + } + }, + "420": { + "description": "Input Limit Exceeded", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/inputlimitexceeded" + } + } + } + }, + "500": { + "description": "Internal Server Error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/servererror" + } + } + } + }, + "504": { + "description": "Gateway Timeout", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/gatewaytimeout" + } + } + } + } + }, + "security": [ + { + "APIAuthorizer": [] + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/input" + } + } + }, + "required": true + } + } + } + }, + "components": { + "schemas": { + "success": { + "type": "object", + "properties": { + "end": { + "type": "string", + "example": 23.72, + "description": "End time of utterance" + }, + "seqNum": { + "type": "string", + "example": 1, + "description": "Running sequence number starts from 1." + }, + "start": { + "type": "integer", + "example": 0.64, + "description": "Start time of utterance" + }, + "text": { + "type": "string", + "description": "Converted text from the input audio file", + "example": "THE COMING YEAR LIFE FOR A REASON A CITIZEN OR A LIFETIME LIKE YOU WHEN SOMEONE IS IN YOUR LIFE A REASON IT USUALLY TO MEET IN NEED WITHIN YOU HAVE NEVER MET YOU BUT I LIKE YOU WHEN SOMEONE IS IN YOUR LIFE FOR A SEASON IS BECAUSE IT IS YOUR TURN TO SHARE LEARN AND GROW AND WANT SOMEONE IN YOUR LIFE FOR A LIFETIME IT CITY THROUGH LESSONS AND IF NOT WHAT THE PEOPLE" + } + } + }, + "unauthorized": { + "type": "object", + "properties": { + "message": { + "type": "string", + "example": "Missing Authentication Token" + }, + "status": { + "type": "string", + "example": "Failure" + } + } + }, + "forbidden": { + "type": "object", + "properties": { + "message": { + "type": "string", + "example": "Access Denied Unauthorized User" + }, + "status": { + "type": "string", + "example": "Failure" + } + } + }, + "paymentrequired": { + "type": "object", + "properties": { + "message": { + "type": "string", + "example": "Insufficient Credits Kindly Top Up" + }, + "status": { + "type": "string", + "example": "Failure" + } + } + }, + "notfound": { + "type": "object", + "properties": { + "message": { + "type": "string", + "example": "Invalid Request URL" + }, + "status": { + "type": "string", + "example": "Failure" + } + } + }, + "servererror": { + "type": "object", + "properties": { + "message": { + "type": "string", + "example": "Internal Server Error" + }, + "status": { + "type": "string", + "example": "Failure" + } + } + }, + "gatewaytimeout": { + "type": "object", + "properties": { + "message": { + "type": "string", + "example": "Request Timeout" + }, + "status": { + "type": "string", + "example": "Failure" + } + } + }, + "inputfieldmissing": { + "type": "object", + "properties": { + "message": { + "type": "string", + "example": "Input Field Missing" + }, + "status": { + "type": "string", + "example": "Failure" + } + } + }, + "inputlimitexceeded": { + "type": "object", + "properties": { + "message": { + "type": "string", + "example": "Input Limit Exceeded" + }, + "status": { + "type": "string", + "example": "Failure" + } + } + }, + "input": { + "type": "object", + "required": [ + "wav_base64", + "wav_url" + ], + "properties": { + "model": { + "x-name": "model", + "type": "string", + "default": true, + "example": "news_parliament", + "description": "Model selection. For best performance, select the model which best matches the use-case:\n\n1. news_parliament - 16 kHz, mono channel, .wav format. Trained on Singapore news and parliament corpus.\n2. nsc_parliament - 16 kHz, mono channel, .wav format. Trained on National Speech Corpus and parliament corpus.\n3. nscfull_8k - 8 kHz, mono channel, .wav format. Trained on National Speech Corpus. Trained on Full National Speech Corpus corpus.\n" + }, + "wav_url/wav_base64": { + "x-name": "wav_url/wav_base64", + "type": "string", + "default": true, + "example": "https://api.sentient.io/test2.wav or UklGRpxNHQBXQVZFZm10IBAAAAABAAEAgD4AAAB9AAACABAAT ...", + "description": "The public URL link to the wave file or Input audio wav file in base64 format. Mono channel, 8kHz / 16kHz sampling rate.\n" + }, + "file_type": { + "x-name": "file_type", + "type": "string", + "default": true, + "example": "wav", + "description": "Input file extension. Only “wav” is supported at the moment.\n" + }, + "vad_threshold": { + "x-name": "vad_threshold", + "type": "number", + "format": "float", + "default": true, + "example": 0.4, + "description": "0.0 to 1.0. Lower will result in more sentence splits. Recommended value is 0.25.\n" + } + } + }, + "versions": { + "type": "object", + "properties": { + "v0.1": { + "type": "array", + "items": { + "oneOf": [ + { + "type": "string", + "example": "Published Date - Sept 30,2019", + "description": "Initial version release" + } + ] + } + } + } + } + }, + "securitySchemes": { + "APIAuthorizer": { + "type": "apiKey", + "name": "x-api-key", + "in": "header", + "x-amazon-apigateway-authtype": "custom", + "description": "Authentication is done using the x-api-key in the request header" + } + } + } +} \ No newline at end of file From c91120bce9b5a2e03ba761796ccec4856baa0a43 Mon Sep 17 00:00:00 2001 From: Priyadharshini <57977344+priyadharshini-sent@users.noreply.github.com> Date: Wed, 14 Oct 2020 18:02:45 +0530 Subject: [PATCH 139/792] Update asr_with_vad_eng_sg.yaml --- yaml/asr_with_vad_eng_sg.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/yaml/asr_with_vad_eng_sg.yaml b/yaml/asr_with_vad_eng_sg.yaml index 0276240ee..fa8e41a6f 100644 --- a/yaml/asr_with_vad_eng_sg.yaml +++ b/yaml/asr_with_vad_eng_sg.yaml @@ -211,7 +211,7 @@ components: Input file extension. Only “wav” is supported at the moment. vad_threshold: x-name: vad_threshold - type: number + type: integer format: float default: true example: 0.4 From 8a4c912fe37821167b3aa96a8689ce989b1883ce Mon Sep 17 00:00:00 2001 From: Priyadharshini <57977344+priyadharshini-sent@users.noreply.github.com> Date: Wed, 14 Oct 2020 18:04:10 +0530 Subject: [PATCH 140/792] Update automatic_speech_recognition_eng_sg.yaml --- yaml/automatic_speech_recognition_eng_sg.yaml | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/yaml/automatic_speech_recognition_eng_sg.yaml b/yaml/automatic_speech_recognition_eng_sg.yaml index e9640dfc8..ebd06737e 100644 --- a/yaml/automatic_speech_recognition_eng_sg.yaml +++ b/yaml/automatic_speech_recognition_eng_sg.yaml @@ -101,16 +101,16 @@ components: example: {seqNum: 1,start: 1.0,end: 4.0,text: HELLO WORLD} properties: end: - type: number + type: integer format: float example: 23.72 description: End time of utterance in seconds seqNum: - type: number + type: integer example: 1 description: Running sequence. Starts from 1. start: - type: number + type: integer format: float example: 0.64 description: Start time of utterance in seconds @@ -227,7 +227,7 @@ components: properties: end: x-name: end - type: number + type: integer format: float default: false example: "4.0" @@ -235,14 +235,14 @@ components: "End time of utterance, in seconds. Offset from the start of stream." seqNum: x-name: seqNum - type: number + type: integer default: false example: "1" description: |+ "Running sequence. Starts from 1." start: x-name: start - type: number + type: integer format: float default: false example: "1.0" From ddf224e9a9ffd1cba349d41b8a8f40285ea73ef1 Mon Sep 17 00:00:00 2001 From: Priyadharshini <57977344+priyadharshini-sent@users.noreply.github.com> Date: Wed, 14 Oct 2020 18:04:53 +0530 Subject: [PATCH 141/792] Update building_addresses_hdb_sg.yaml --- yaml/building_addresses_hdb_sg.yaml | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/yaml/building_addresses_hdb_sg.yaml b/yaml/building_addresses_hdb_sg.yaml index 04aa2400e..51087a25b 100644 --- a/yaml/building_addresses_hdb_sg.yaml +++ b/yaml/building_addresses_hdb_sg.yaml @@ -226,11 +226,11 @@ components: description: Json Object of returned results properties: total: - type: number + type: integer example: 1 description: Total number of records max_score: - type: number + type: integer example: 17.995623 description: The highest score value hits: @@ -253,7 +253,7 @@ components: description: Document ID example: "uLxcqWgBv3dNEHq2Dznn" _score: - type: number + type: integer description: The document score for the search request example: 12.08503 _source: From b4276aa0acd1dd14a68d8c1ebf6a9764d0da74aa Mon Sep 17 00:00:00 2001 From: Priyadharshini <57977344+priyadharshini-sent@users.noreply.github.com> Date: Wed, 14 Oct 2020 18:06:31 +0530 Subject: [PATCH 142/792] Update carpark_hdb_sg.yaml --- yaml/carpark_hdb_sg.yaml | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/yaml/carpark_hdb_sg.yaml b/yaml/carpark_hdb_sg.yaml index f117fc2f3..a730cab4a 100644 --- a/yaml/carpark_hdb_sg.yaml +++ b/yaml/carpark_hdb_sg.yaml @@ -273,11 +273,11 @@ components: description: Json Object of returned results properties: total: - type: number + type: integer example: 986 description: Total number of records max_score: - type: number + type: integer example: 17.995623 description: The highest score value hits: @@ -300,7 +300,7 @@ components: description: Document ID example: "K7scqWgBv3dNEHq2WvMo" _score: - type: number + type: integer description: The document score for the search request example: 17.995623 _source: @@ -358,15 +358,15 @@ components: description: WGS84 (GPS) longitude example: 103.8469821 car: - type: number + type: integer description: Number of car parking lots example: 18 lorry: - type: number + type: integer description: Number of lorry parking lots example: 6 mc: - type: number + type: integer description: Number of motorcycle parking lots example: 0 createddate: From d07231418676389b4e081ed8f017bf616f09542d Mon Sep 17 00:00:00 2001 From: Priyadharshini <57977344+priyadharshini-sent@users.noreply.github.com> Date: Wed, 14 Oct 2020 18:08:21 +0530 Subject: [PATCH 143/792] Update commercial_directories_hdb_sg.yaml --- yaml/commercial_directories_hdb_sg.yaml | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/yaml/commercial_directories_hdb_sg.yaml b/yaml/commercial_directories_hdb_sg.yaml index c0565dcfc..cc55ce7a9 100644 --- a/yaml/commercial_directories_hdb_sg.yaml +++ b/yaml/commercial_directories_hdb_sg.yaml @@ -257,11 +257,11 @@ components: description: Json Object of returned results properties: total: - type: number + type: integer example: 986 description: Total number of records max_score: - type: number + type: integer example: 17.995623 description: The highest score value hits: @@ -284,7 +284,7 @@ components: description: Document ID example: "K7scqWgBv3dNEHq2WvMo" _score: - type: number + type: integer description: The document score for the search request example: 17.995623 _source: From 855dfc050f516a552b8950fae61aeaf8d9630b58 Mon Sep 17 00:00:00 2001 From: Priyadharshini <57977344+priyadharshini-sent@users.noreply.github.com> Date: Wed, 14 Oct 2020 18:09:55 +0530 Subject: [PATCH 144/792] Update d&b_basic_individual_search_sg.yaml --- yaml/d&b_basic_individual_search_sg.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/yaml/d&b_basic_individual_search_sg.yaml b/yaml/d&b_basic_individual_search_sg.yaml index ed01a5760..dc11fda59 100644 --- a/yaml/d&b_basic_individual_search_sg.yaml +++ b/yaml/d&b_basic_individual_search_sg.yaml @@ -1247,7 +1247,7 @@ components: type: object properties: TOT_ITEMS: - type: number + type: integer example: 1 description: Number of subjects being enquired relating to the Run default: false From a8a06b8e5a19bea20e58403ec9db6b0afc05018c Mon Sep 17 00:00:00 2001 From: Priyadharshini <57977344+priyadharshini-sent@users.noreply.github.com> Date: Thu, 15 Oct 2020 09:31:56 +0530 Subject: [PATCH 145/792] Update d&b_brief_financial_information_sg.yaml --- yaml/d&b_brief_financial_information_sg.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/yaml/d&b_brief_financial_information_sg.yaml b/yaml/d&b_brief_financial_information_sg.yaml index 8f9d5869c..7f969cbd7 100644 --- a/yaml/d&b_brief_financial_information_sg.yaml +++ b/yaml/d&b_brief_financial_information_sg.yaml @@ -1344,7 +1344,7 @@ components: type: object properties: TOT_ITEMS: - type: number + type: integer example: 1 description: Number of subjects being enquired relating to the Run default: false From 629948002d86086d6b5d521e1a432475d7bf4771 Mon Sep 17 00:00:00 2001 From: Priyadharshini <57977344+priyadharshini-sent@users.noreply.github.com> Date: Thu, 15 Oct 2020 09:33:35 +0530 Subject: [PATCH 146/792] Update d&b_business_check_plus_sg.yaml --- yaml/d&b_business_check_plus_sg.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/yaml/d&b_business_check_plus_sg.yaml b/yaml/d&b_business_check_plus_sg.yaml index 5efd41e63..0bf55f77b 100644 --- a/yaml/d&b_business_check_plus_sg.yaml +++ b/yaml/d&b_business_check_plus_sg.yaml @@ -1649,7 +1649,7 @@ components: type: object properties: TOT_ITEMS: - type: number + type: integer example: 1 description: Number of subjects being enquired relating to the Run default: false From fe49b3a1b13d2fc043df1bab5c307dde17a8d8b9 Mon Sep 17 00:00:00 2001 From: Priyadharshini <57977344+priyadharshini-sent@users.noreply.github.com> Date: Thu, 15 Oct 2020 09:34:25 +0530 Subject: [PATCH 147/792] Update d&b_business_check_sg.yaml --- yaml/d&b_business_check_sg.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/yaml/d&b_business_check_sg.yaml b/yaml/d&b_business_check_sg.yaml index c279ff569..ff1a83428 100644 --- a/yaml/d&b_business_check_sg.yaml +++ b/yaml/d&b_business_check_sg.yaml @@ -1102,7 +1102,7 @@ components: type: object properties: TOT_ITEMS: - type: number + type: integer example: 1 description: Number of subjects being enquired relating to the Run default: false From fa86c8ae46f014ce5a3d1bf9a85b6ac5b2f0cc0f Mon Sep 17 00:00:00 2001 From: Priyadharshini <57977344+priyadharshini-sent@users.noreply.github.com> Date: Thu, 15 Oct 2020 09:35:37 +0530 Subject: [PATCH 148/792] Update demographics_hdb_sg.yaml --- yaml/demographics_hdb_sg.yaml | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/yaml/demographics_hdb_sg.yaml b/yaml/demographics_hdb_sg.yaml index b701ec6c3..27388d0b6 100644 --- a/yaml/demographics_hdb_sg.yaml +++ b/yaml/demographics_hdb_sg.yaml @@ -223,11 +223,11 @@ components: description: Json Object of returned results properties: total: - type: number + type: integer example: 986 description: Total number of records max_score: - type: number + type: integer example: 17.995623 description: The highest score value hits: @@ -250,7 +250,7 @@ components: description: Document ID example: "K7scqWgBv3dNEHq2WvMo" _score: - type: number + type: integer description: The document score for the search request example: 17.995623 _source: @@ -271,7 +271,7 @@ components: description: Range of age groups example: "50 to 59" age_group_id: - type: number + type: integer description: |+ Age group ID represents a certain age range: 1 (<10 years) @@ -284,7 +284,7 @@ components: 8 (>70 years) example: 6 residents: - type: number + type: integer description: Number of residents example: 54 block: From 71384b9c287e46f3f530994375b35a7424f12d5f Mon Sep 17 00:00:00 2001 From: Priyadharshini <57977344+priyadharshini-sent@users.noreply.github.com> Date: Thu, 15 Oct 2020 09:36:25 +0530 Subject: [PATCH 149/792] Update directory_of_singapore_startups.yaml --- yaml/directory_of_singapore_startups.yaml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/yaml/directory_of_singapore_startups.yaml b/yaml/directory_of_singapore_startups.yaml index 0039eb943..fa9131657 100644 --- a/yaml/directory_of_singapore_startups.yaml +++ b/yaml/directory_of_singapore_startups.yaml @@ -245,11 +245,11 @@ components: description: Json Object of returned results properties: total: - type: number + type: integer example: 986 description: Total number of records max_score: - type: number + type: integer example: 1 description: The highest score value hits: From 2c7472888b9db92f2f4dbf0f8bd7ba9736362868 Mon Sep 17 00:00:00 2001 From: Priyadharshini <57977344+priyadharshini-sent@users.noreply.github.com> Date: Thu, 15 Oct 2020 09:37:51 +0530 Subject: [PATCH 150/792] Update face_recognition_politicians_sg.yaml --- yaml/face_recognition_politicians_sg.yaml | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/yaml/face_recognition_politicians_sg.yaml b/yaml/face_recognition_politicians_sg.yaml index 17ae58867..db942c980 100644 --- a/yaml/face_recognition_politicians_sg.yaml +++ b/yaml/face_recognition_politicians_sg.yaml @@ -96,7 +96,7 @@ components: - type: object properties: conf: - type: number + type: integer format: float example: 0.6588699206768599 description: 0.0 to 1.0. Confidence score of identification. Higher is more confidence. @@ -110,7 +110,7 @@ components: description: bounding box of the face in pixel coordinates of top, right, bottom, left. items: oneOf: - - type: number + - type: integer example: 67 unauthorized: @@ -233,7 +233,7 @@ components: Type of image file. If not specified, the type of file is detected and processed.Refers to Python Imaging Library (PIL) for supported formats: bmp, gif, jpg/jpeg, png. threshold: x-name: threshold - type: number + type: integer format: float default: false example: 0.5 From e594be414cf268f2a3e99811edcc67077ace855c Mon Sep 17 00:00:00 2001 From: Priyadharshini <57977344+priyadharshini-sent@users.noreply.github.com> Date: Thu, 15 Oct 2020 09:38:46 +0530 Subject: [PATCH 151/792] Update flat_ownership_hdb_sg.yaml --- yaml/flat_ownership_hdb_sg.yaml | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/yaml/flat_ownership_hdb_sg.yaml b/yaml/flat_ownership_hdb_sg.yaml index e4843f424..7fa075287 100644 --- a/yaml/flat_ownership_hdb_sg.yaml +++ b/yaml/flat_ownership_hdb_sg.yaml @@ -229,11 +229,11 @@ components: description: Json Object of returned results properties: total: - type: number + type: integer example: 986 description: Total number of records max_score: - type: number + type: integer example: 17.995623 description: The highest score value hits: @@ -256,7 +256,7 @@ components: description: Document ID example: "050533/40 Date: Thu, 15 Oct 2020 09:41:10 +0530 Subject: [PATCH 152/792] Update object_detection.yaml --- yaml/object_detection.yaml | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/yaml/object_detection.yaml b/yaml/object_detection.yaml index 766987c6c..6d3e1139d 100644 --- a/yaml/object_detection.yaml +++ b/yaml/object_detection.yaml @@ -105,19 +105,19 @@ components: description: Bounding box of the image properties: Bot: - type: number + type: integer example: 742 description: Bottom coordinate of the box Left: - type: number + type: integer example: 19 description: Left coordinate of the box Right: - type: number + type: integer example: 1019 description: Right coordinate of the box Top: - type: number + type: integer example: 73 description: Top coordinate of the box unauthorized: From a8bca73e6caaa2d7c8a11fb9f5c99a2865581dba Mon Sep 17 00:00:00 2001 From: Priyadharshini <57977344+priyadharshini-sent@users.noreply.github.com> Date: Thu, 15 Oct 2020 09:42:31 +0530 Subject: [PATCH 153/792] Update pdf_extractor.yaml --- yaml/pdf_extractor.yaml | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/yaml/pdf_extractor.yaml b/yaml/pdf_extractor.yaml index 8fac40640..d2577bf29 100644 --- a/yaml/pdf_extractor.yaml +++ b/yaml/pdf_extractor.yaml @@ -207,22 +207,22 @@ components: example: file upload description: The file object Max. file size upto - 7MB. *Image pdf not supported pageNumbers: - type: number + type: integer default: false example: "1,3,6" description: Page numbers, example 1,3,6. Default all pages maxPages: - type: number + type: integer default: false example: "3" description: Maximum of page number. Default all pages startPage: - type: number + type: integer default: false example: "1" description: Starting page number, if used endPage parameter is mandatory endPage: - type: number + type: integer default: false example: "5" description: End of page number, if used startPage parameter is mandatory From 02584efc2cb1a6f080a97de45dec58debb0a1b91 Mon Sep 17 00:00:00 2001 From: Priyadharshini <57977344+priyadharshini-sent@users.noreply.github.com> Date: Thu, 15 Oct 2020 09:44:15 +0530 Subject: [PATCH 154/792] Update residential_sales_and_rental_hdb_sg.yaml --- yaml/residential_sales_and_rental_hdb_sg.yaml | 34 +++++++++---------- 1 file changed, 17 insertions(+), 17 deletions(-) diff --git a/yaml/residential_sales_and_rental_hdb_sg.yaml b/yaml/residential_sales_and_rental_hdb_sg.yaml index 344740535..7f48fca70 100644 --- a/yaml/residential_sales_and_rental_hdb_sg.yaml +++ b/yaml/residential_sales_and_rental_hdb_sg.yaml @@ -241,11 +241,11 @@ components: description: Json Object of returned results properties: total: - type: number + type: integer example: 12150 description: Total number of records max_score: - type: number + type: integer example: 1 description: The highest score value hits: @@ -268,7 +268,7 @@ components: description: Document ID example: '750405' _score: - type: number + type: integer description: The document score for the search request example: 1 _source: @@ -281,59 +281,59 @@ components: description: Postal code example: '750405' year_completed: - type: number + type: integer description: Completed year of the Building example: 1999 total_dwelling_units: - type: number + type: integer description: Total Dwelling units example: 112 1room_sold: - type: number + type: integer description: No. of one room units sold example: 0 2room_sold: - type: number + type: integer description: No. of two room units sold example: 0 3room_sold: - type: number + type: integer description: No. of three room units sold example: 0 4room_sold: - type: number + type: integer description: No. of four room units sold example: 112 5room_sold: - type: number + type: integer description: No. of five room units sold example: 0 exec_sold: - type: number + type: integer description: No. of executive units sold example: 0 multigen_sold: - type: number + type: integer description: No. of multi generation units sold example: 0 studio_apartment_sold: - type: number + type: integer description: No. of studio units sold example: 0 1room_rental: - type: number + type: integer description: No. of one room units rented example: 0 2room_rental: - type: number + type: integer description: No. of two room units rented example: 0 3room_rental: - type: number + type: integer description: No. of three room units rented example: 0 other_room_rental: - type: number + type: integer description: No. of other units rented example: 0 block: From e1d7944c65052a1368b861ea6519bc4639fad5b9 Mon Sep 17 00:00:00 2001 From: Priyadharshini <57977344+priyadharshini-sent@users.noreply.github.com> Date: Thu, 15 Oct 2020 09:44:48 +0530 Subject: [PATCH 155/792] Update script_alignment.yaml --- yaml/script_alignment.yaml | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/yaml/script_alignment.yaml b/yaml/script_alignment.yaml index 8a372a043..d5062c5e5 100644 --- a/yaml/script_alignment.yaml +++ b/yaml/script_alignment.yaml @@ -218,14 +218,14 @@ components: properties: seqNum: x-name: seqNum - type: number + type: integer default: true example: 1 description: |+ Running sequence. Start from 1. start: x-name: start - type: number + type: integer format: float default: true example: 1.0 @@ -233,7 +233,7 @@ components: Start time of utterance, in seconds. Offset from the start of stream. end: x-name: end - type: number + type: integer format: float default: true example: 4.0 From f5845e2fae98706a46ca0bcd4f46987336c61098 Mon Sep 17 00:00:00 2001 From: Priyadharshini <57977344+priyadharshini-sent@users.noreply.github.com> Date: Thu, 15 Oct 2020 09:46:45 +0530 Subject: [PATCH 156/792] Update season_parking_availability_hdb_sg.yaml --- yaml/season_parking_availability_hdb_sg.yaml | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/yaml/season_parking_availability_hdb_sg.yaml b/yaml/season_parking_availability_hdb_sg.yaml index 1a3fc09db..01f33d074 100644 --- a/yaml/season_parking_availability_hdb_sg.yaml +++ b/yaml/season_parking_availability_hdb_sg.yaml @@ -235,11 +235,11 @@ components: description: Json Object of returned results properties: total: - type: number + type: integer example: 1 description: Total number of records max_score: - type: number + type: integer example: 13.663734 description: The highest score value hits: @@ -258,7 +258,7 @@ components: description: Document ID example: "AM/G40/Y/552506" _score: - type: number + type: integer description: The document score for the search request example: 13.663734 _source: @@ -285,7 +285,7 @@ components: S - Season (Car) example: "Y" car_park_availability: - type: number + type: integer description: Car Park Availability example: 15 postalcode: From 8dd7b8686fd74795472b5a6b41b5d03ff2af4157 Mon Sep 17 00:00:00 2001 From: Priyadharshini <57977344+priyadharshini-sent@users.noreply.github.com> Date: Thu, 15 Oct 2020 09:47:50 +0530 Subject: [PATCH 157/792] Update taxonomy_matcher_eng.yaml --- yaml/taxonomy_matcher_eng.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/yaml/taxonomy_matcher_eng.yaml b/yaml/taxonomy_matcher_eng.yaml index fb11e1218..083a8ba82 100644 --- a/yaml/taxonomy_matcher_eng.yaml +++ b/yaml/taxonomy_matcher_eng.yaml @@ -197,7 +197,7 @@ components: A list of object names to be classified. Up to a maximum of 20 search terms can be processed each time. threshold: x-name: threshold - type: number + type: integer default: true example: 1 description: |+ From cad204253d16d02621538a0662dd2be7e866555e Mon Sep 17 00:00:00 2001 From: Priyadharshini <57977344+priyadharshini-sent@users.noreply.github.com> Date: Thu, 15 Oct 2020 09:49:11 +0530 Subject: [PATCH 158/792] Update voice_activity_detection_eng.yaml --- yaml/voice_activity_detection_eng.yaml | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/yaml/voice_activity_detection_eng.yaml b/yaml/voice_activity_detection_eng.yaml index 75f463579..c7f681f46 100644 --- a/yaml/voice_activity_detection_eng.yaml +++ b/yaml/voice_activity_detection_eng.yaml @@ -97,16 +97,16 @@ components: - type: object properties: end: - type: number + type: integer format: float example: 23.72 description: End time of utterance, in seconds. Offset from the start of stream. seqNum: - type: number + type: integer example: 1 description: Running sequence. Starts from 1. start: - type: number + type: integer format: float example: 0.64 description: Start time of utterance, in seconds. Offset from the start of stream. @@ -196,7 +196,7 @@ components: Required. Input audio file in base64 format threshold: x-name: threshold - type: number + type: integer format: float default: false example: 0.2 From b51f0550d98e3b706a30e9e33a43b766062b0074 Mon Sep 17 00:00:00 2001 From: Priyadharshini <57977344+priyadharshini-sent@users.noreply.github.com> Date: Thu, 15 Oct 2020 09:49:58 +0530 Subject: [PATCH 159/792] Update word_sense_disambiguation_eng.yaml --- yaml/word_sense_disambiguation_eng.yaml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/yaml/word_sense_disambiguation_eng.yaml b/yaml/word_sense_disambiguation_eng.yaml index f97f55e47..8d9f76af0 100644 --- a/yaml/word_sense_disambiguation_eng.yaml +++ b/yaml/word_sense_disambiguation_eng.yaml @@ -156,12 +156,12 @@ components: example: society.n.01 description: The target word name in wordnet library synset_score: - type: number + type: integer format : float example: 0.9870249032974243 description: Is the confidence score from the network token_index: - type: number + type: integer example: 40 description: Is the target word position in the sentence unauthorized: From f0db398ab96078c0d5eb601f1e6c7a76749236ea Mon Sep 17 00:00:00 2001 From: priyaPeristera Date: Fri, 16 Oct 2020 10:56:22 +1100 Subject: [PATCH 160/792] Not in use --- yaml/asr-sg.yaml | 180 ----------------------------------------------- 1 file changed, 180 deletions(-) delete mode 100644 yaml/asr-sg.yaml diff --git a/yaml/asr-sg.yaml b/yaml/asr-sg.yaml deleted file mode 100644 index 35f63e465..000000000 --- a/yaml/asr-sg.yaml +++ /dev/null @@ -1,180 +0,0 @@ -openapi: 3.0.1 -info: - title: Automatic Speech Recognition ENG - description: >- - "This Voice microservice takes in an audio file (in WAV format at 16kHz) and transcribes English speech content within the input file into text.

The Automatic Speech Recognition (ASR) AI model is employed to understand the mapping of sound features to actual words in English.

Use this microservice if the audio file consists of mostly speech with no long pauses in between.

Use this microservice if the audio file consists of mostly speech with no long pauses in between.

Authentication:

Authentication is done using the x-api-key in the request header. - version: '0.1' -servers: - - url: 'https://apis.sentient.io' -tags: -- name: "v0.1" - description: "Published Date - Jun 18, 2018" -paths: - /microservices/voice/asreng/v0.1/getpredictions: - post: - tags: - - v0.1 - responses: - '200': - description: success response - content: - application/json: - schema: - $ref: '#/components/schemas/success' - '401': - description: Unauthorized - content: - application/json: - schema: - $ref: '#/components/schemas/unauthorized' - '402': - description: Payment Required - content: - application/json: - schema: - $ref: '#/components/schemas/paymentrequired' - '403': - description: Forbidden - content: - application/json: - schema: - $ref: '#/components/schemas/forbidden' - '404': - description: Not Found - content: - application/json: - schema: - $ref: '#/components/schemas/notfound' - '419': - description: Input Field Missing - content: - application/json: - schema: - $ref: '#/components/schemas/inputfieldmissing' - '420': - description: Input Limit Exceeded - content: - application/json: - schema: - $ref: '#/components/schemas/inputlimitexceeded' - '500': - description: Internal Server Error - content: - application/json: - schema: - $ref: '#/components/schemas/servererror' - '504': - description: Gateway Timeout - content: - application/json: - schema: - $ref: '#/components/schemas/gatewaytimeout' - security: - - APIAuthorizer: [] - requestBody: - description: Input parameters

FieldTypeDescription
audioStringRequired. Input file in base64 format and needs to be prefixed by the data type and encoding.
E.g. "data:audio/wav;base64,<wav in base64 string>"

Audio file should be:
Channel Type mono
Sample Rate 16kHz


- content: - application/json: - schema: - $ref: '#/components/schemas/input' - required: true -components: - schemas: - success: - type: object - properties: - message: - type: string - example: Hi there - description: Converted Text - status: - type: string - example: success - description: The status of the API call success/failure - unauthorized: - type: object - properties: - message: - type: string - example: Missing Authentication Token - status: - type: string - example: Failure - forbidden: - type: object - properties: - message: - type: string - example: Access Denied Unauthorized User - status: - type: string - example: Failure - paymentrequired: - type: object - properties: - message: - type: string - example: Insufficient Credits Kindly Top Up - status: - type: string - example: Failure - notfound: - type: object - properties: - message: - type: string - example: Invalid Request URL - status: - type: string - example: Failure - servererror: - type: object - properties: - message: - type: string - example: Internal Server Error - status: - type: string - example: Failure - gatewaytimeout: - type: object - properties: - message: - type: string - example: Request Timeout - status: - type: string - example: Failure - inputfieldmissing: - type: object - properties: - message: - type: string - example: Input Field Missing - status: - type: string - example: Failure - inputlimitexceeded: - type: object - properties: - message: - type: string - example: Input Limit Exceeded - status: - type: string - example: Failure - input: - type: object - properties: - audio: - type: string - example: - required: true - example: data:audio/wav;base64,UklGRkbiBABXQVZFZm10IBAAAAABA... - description: Required. Input file in base64 format and needs to be prefixed by the data type and encoding.
E.g. "data:audio/wav;base64," - securitySchemes: - APIAuthorizer: - type: apiKey - name: x-api-key - in: header - x-amazon-apigateway-authtype: custom From b72567418bfac6f6bf93d1ea6dffc752b8a342d1 Mon Sep 17 00:00:00 2001 From: priyaPeristera Date: Fri, 16 Oct 2020 10:56:42 +1100 Subject: [PATCH 161/792] Update and rename asr_with_vad_eng_sg.yaml to asr_with_voice_activity_detection_eng_sg.yaml --- ...ng_sg.yaml => asr_with_voice_activity_detection_eng_sg.yaml} | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) rename yaml/{asr_with_vad_eng_sg.yaml => asr_with_voice_activity_detection_eng_sg.yaml} (99%) diff --git a/yaml/asr_with_vad_eng_sg.yaml b/yaml/asr_with_voice_activity_detection_eng_sg.yaml similarity index 99% rename from yaml/asr_with_vad_eng_sg.yaml rename to yaml/asr_with_voice_activity_detection_eng_sg.yaml index fa8e41a6f..87f4140cb 100644 --- a/yaml/asr_with_vad_eng_sg.yaml +++ b/yaml/asr_with_voice_activity_detection_eng_sg.yaml @@ -6,7 +6,7 @@ info: This Voice microservice performs well on Singapore-accented English speech. For best performance, select the model which best matches the use-case: news_parliament, nsc_parliament, nscfull_8k version: '0.1' - x-subscribelink: asr_with_vad_eng_sg + x-subscribelink: asr_with_voice_activity_detection_eng_sg servers: - url: 'https://apis.sentient.io' tags: From 1168e9a48e7ad4f375e37f2050683cb6ca9d672b Mon Sep 17 00:00:00 2001 From: priyaPeristera Date: Fri, 16 Oct 2020 10:58:08 +1100 Subject: [PATCH 162/792] Update index.yaml --- yaml/index.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/yaml/index.yaml b/yaml/index.yaml index f98f6451f..e7177ed89 100644 --- a/yaml/index.yaml +++ b/yaml/index.yaml @@ -26,7 +26,7 @@ Voice: ASR with Voice Activity Detection ENG (SG): title: ASR with Voice Activity Detection ENG (SG) versions: - v0.1: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/asr_with_vad_eng_sg.yaml" + v0.1: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/asr_with_voice_activity_detection_eng_sg.yaml" Voice Activity Detection ENG: title: Voice Activity Detection ENG versions: From b4f80aa13486eee20020dee1dc3b6f934fa4701d Mon Sep 17 00:00:00 2001 From: priyaPeristera Date: Mon, 19 Oct 2020 22:09:23 +1100 Subject: [PATCH 163/792] Update named-entity_recognition_eng_v1.0.yaml --- yaml/named-entity_recognition_eng_v1.0.yaml | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/yaml/named-entity_recognition_eng_v1.0.yaml b/yaml/named-entity_recognition_eng_v1.0.yaml index c8cd570c3..716529556 100644 --- a/yaml/named-entity_recognition_eng_v1.0.yaml +++ b/yaml/named-entity_recognition_eng_v1.0.yaml @@ -119,7 +119,14 @@ components: - Immigration and Checkpoints Authority - ICA - LOA - description: "name of organizations names found in the text string" + description: "name of organizations names found in the text string" + per: + type: array + items: + type: string + example: + - Lee Hsien Loong + description: "person names found in the text string" message: type: string example: Successfully Processed From 9d32bc5c6353326832e2ce78bd3511413a74ef42 Mon Sep 17 00:00:00 2001 From: priyaPeristera Date: Mon, 26 Oct 2020 11:58:13 +1100 Subject: [PATCH 164/792] Not in use --- yaml/openapi.json | 341 ---------------------------------------------- 1 file changed, 341 deletions(-) delete mode 100644 yaml/openapi.json diff --git a/yaml/openapi.json b/yaml/openapi.json deleted file mode 100644 index 08d8b2ac9..000000000 --- a/yaml/openapi.json +++ /dev/null @@ -1,341 +0,0 @@ -{ - "openapi": "3.0.1", - "info": { - "title": "ASR with Voice Activity Detection ENG (SG)", - "description": "This Voice microservice combines Voice Activity Detection feature and Automatic Speech Recognition capability. It detects speech in an audio file (.wav format) and transcribes English speech content from the audio stream into text. The transcript text is timestamped for each utterance. An utterance is a continuous piece of speech beginning and ending with a clear pause.\n\nThis Voice microservice performs well on Singapore-accented English speech. For best performance, select the model which best matches the use-case: news_parliament, nsc_parliament, nscfull_8k\n", - "version": "0.1", - "x-subscribelink": "asr_with_vad_eng_sg" - }, - "servers": [ - { - "url": "https://apis.sentient.io" - } - ], - "tags": [ - { - "name": "v0.1", - "description": "Published Date - Sep 30, 2019" - } - ], - "paths": { - "/microservices/voice/vadasr/v0.1/getpredictions": { - "post": { - "tags": [ - "v0.1" - ], - "responses": { - "200": { - "description": "success response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/success" - }, - "example": [ - { - "seqNum": 1, - "start": 0.64, - "end": 23.72, - "text": "HELLO WORLD" - } - ] - } - } - }, - "401": { - "description": "Unauthorized", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/unauthorized" - } - } - } - }, - "402": { - "description": "Payment Required", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/paymentrequired" - } - } - } - }, - "403": { - "description": "Forbidden", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/forbidden" - } - } - } - }, - "404": { - "description": "Not Found", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/notfound" - } - } - } - }, - "419": { - "description": "Input Field Missing", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/inputfieldmissing" - } - } - } - }, - "420": { - "description": "Input Limit Exceeded", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/inputlimitexceeded" - } - } - } - }, - "500": { - "description": "Internal Server Error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/servererror" - } - } - } - }, - "504": { - "description": "Gateway Timeout", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/gatewaytimeout" - } - } - } - } - }, - "security": [ - { - "APIAuthorizer": [] - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/input" - } - } - }, - "required": true - } - } - } - }, - "components": { - "schemas": { - "success": { - "type": "object", - "properties": { - "end": { - "type": "string", - "example": 23.72, - "description": "End time of utterance" - }, - "seqNum": { - "type": "string", - "example": 1, - "description": "Running sequence number starts from 1." - }, - "start": { - "type": "integer", - "example": 0.64, - "description": "Start time of utterance" - }, - "text": { - "type": "string", - "description": "Converted text from the input audio file", - "example": "THE COMING YEAR LIFE FOR A REASON A CITIZEN OR A LIFETIME LIKE YOU WHEN SOMEONE IS IN YOUR LIFE A REASON IT USUALLY TO MEET IN NEED WITHIN YOU HAVE NEVER MET YOU BUT I LIKE YOU WHEN SOMEONE IS IN YOUR LIFE FOR A SEASON IS BECAUSE IT IS YOUR TURN TO SHARE LEARN AND GROW AND WANT SOMEONE IN YOUR LIFE FOR A LIFETIME IT CITY THROUGH LESSONS AND IF NOT WHAT THE PEOPLE" - } - } - }, - "unauthorized": { - "type": "object", - "properties": { - "message": { - "type": "string", - "example": "Missing Authentication Token" - }, - "status": { - "type": "string", - "example": "Failure" - } - } - }, - "forbidden": { - "type": "object", - "properties": { - "message": { - "type": "string", - "example": "Access Denied Unauthorized User" - }, - "status": { - "type": "string", - "example": "Failure" - } - } - }, - "paymentrequired": { - "type": "object", - "properties": { - "message": { - "type": "string", - "example": "Insufficient Credits Kindly Top Up" - }, - "status": { - "type": "string", - "example": "Failure" - } - } - }, - "notfound": { - "type": "object", - "properties": { - "message": { - "type": "string", - "example": "Invalid Request URL" - }, - "status": { - "type": "string", - "example": "Failure" - } - } - }, - "servererror": { - "type": "object", - "properties": { - "message": { - "type": "string", - "example": "Internal Server Error" - }, - "status": { - "type": "string", - "example": "Failure" - } - } - }, - "gatewaytimeout": { - "type": "object", - "properties": { - "message": { - "type": "string", - "example": "Request Timeout" - }, - "status": { - "type": "string", - "example": "Failure" - } - } - }, - "inputfieldmissing": { - "type": "object", - "properties": { - "message": { - "type": "string", - "example": "Input Field Missing" - }, - "status": { - "type": "string", - "example": "Failure" - } - } - }, - "inputlimitexceeded": { - "type": "object", - "properties": { - "message": { - "type": "string", - "example": "Input Limit Exceeded" - }, - "status": { - "type": "string", - "example": "Failure" - } - } - }, - "input": { - "type": "object", - "required": [ - "wav_base64", - "wav_url" - ], - "properties": { - "model": { - "x-name": "model", - "type": "string", - "default": true, - "example": "news_parliament", - "description": "Model selection. For best performance, select the model which best matches the use-case:\n\n1. news_parliament - 16 kHz, mono channel, .wav format. Trained on Singapore news and parliament corpus.\n2. nsc_parliament - 16 kHz, mono channel, .wav format. Trained on National Speech Corpus and parliament corpus.\n3. nscfull_8k - 8 kHz, mono channel, .wav format. Trained on National Speech Corpus. Trained on Full National Speech Corpus corpus.\n" - }, - "wav_url/wav_base64": { - "x-name": "wav_url/wav_base64", - "type": "string", - "default": true, - "example": "https://api.sentient.io/test2.wav or UklGRpxNHQBXQVZFZm10IBAAAAABAAEAgD4AAAB9AAACABAAT ...", - "description": "The public URL link to the wave file or Input audio wav file in base64 format. Mono channel, 8kHz / 16kHz sampling rate.\n" - }, - "file_type": { - "x-name": "file_type", - "type": "string", - "default": true, - "example": "wav", - "description": "Input file extension. Only “wav” is supported at the moment.\n" - }, - "vad_threshold": { - "x-name": "vad_threshold", - "type": "number", - "format": "float", - "default": true, - "example": 0.4, - "description": "0.0 to 1.0. Lower will result in more sentence splits. Recommended value is 0.25.\n" - } - } - }, - "versions": { - "type": "object", - "properties": { - "v0.1": { - "type": "array", - "items": { - "oneOf": [ - { - "type": "string", - "example": "Published Date - Sept 30,2019", - "description": "Initial version release" - } - ] - } - } - } - } - }, - "securitySchemes": { - "APIAuthorizer": { - "type": "apiKey", - "name": "x-api-key", - "in": "header", - "x-amazon-apigateway-authtype": "custom", - "description": "Authentication is done using the x-api-key in the request header" - } - } - } -} \ No newline at end of file From 9a62f61ec6f5fc2c66a30ea4352d813800d019e9 Mon Sep 17 00:00:00 2001 From: rameshsentient <51635015+rameshsentient@users.noreply.github.com> Date: Thu, 29 Oct 2020 17:45:04 +0530 Subject: [PATCH 165/792] Update video-to-audio_convertor.yaml --- yaml/video-to-audio_convertor.yaml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/yaml/video-to-audio_convertor.yaml b/yaml/video-to-audio_convertor.yaml index d370865ad..9bd361182 100644 --- a/yaml/video-to-audio_convertor.yaml +++ b/yaml/video-to-audio_convertor.yaml @@ -190,8 +190,8 @@ components: default: true description: The file object. Maximum file size up to - 3.5MB samplerate: - type: string - example: "16000" + type: integer + example: 16000 default: false description: Sample rate of the audio file in Hz channel: From ef7472f36aaa7c179bd69ed31c06de80710db1ba Mon Sep 17 00:00:00 2001 From: rameshsentient <51635015+rameshsentient@users.noreply.github.com> Date: Thu, 29 Oct 2020 17:56:35 +0530 Subject: [PATCH 166/792] Update video-to-audio_convertor.yaml --- yaml/video-to-audio_convertor.yaml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/yaml/video-to-audio_convertor.yaml b/yaml/video-to-audio_convertor.yaml index 9bd361182..d370865ad 100644 --- a/yaml/video-to-audio_convertor.yaml +++ b/yaml/video-to-audio_convertor.yaml @@ -190,8 +190,8 @@ components: default: true description: The file object. Maximum file size up to - 3.5MB samplerate: - type: integer - example: 16000 + type: string + example: "16000" default: false description: Sample rate of the audio file in Hz channel: From 7bd43eb32490d571e74a5ee33a6b43a742b540ff Mon Sep 17 00:00:00 2001 From: Mohan Palanisamy <51600193+mohanpalanisamy92@users.noreply.github.com> Date: Fri, 30 Oct 2020 19:26:22 +0530 Subject: [PATCH 167/792] Create base64-file-encode.yaml --- yaml/base64-file-encode.yaml | 219 +++++++++++++++++++++++++++++++++++ 1 file changed, 219 insertions(+) create mode 100644 yaml/base64-file-encode.yaml diff --git a/yaml/base64-file-encode.yaml b/yaml/base64-file-encode.yaml new file mode 100644 index 000000000..27d1119fa --- /dev/null +++ b/yaml/base64-file-encode.yaml @@ -0,0 +1,219 @@ +openapi: 3.0.1 +info: + title: Base64 Encoder + description: |+ + This Utility microservice converts an uploaded file to Base64 encoded text (also known as a binary file to text converter). This microservice supports most documents, images, audio, video, archive and font files. See documentation for the detailed list of supported file formats.

User can choose the output base64 text string in 5 different formats (plain text, JSON, hyperlink, datauri, XML).

For the reverse process (converting Base64 string back to binary file), check out the Base 64 File Decode microservice. + version: '0.0.1' + x-subscribelink: base64_file_encode +servers: + - url: 'https://apis.sentient.io' +tags: +- name: "v0.0.1" + description: "Published Date - Oct 30, 2020" +paths: + /microservices/utility/base64encode/v0/getresults: + post: + tags: + - v0.0.1 + responses: + '200': + description: success response + content: + application/json: + schema: + $ref: '#/components/schemas/success' + example: + results: + base64: /9j/4AAQSkZJRgABAQAAAQABAAD/2wCEAAMCAggIBQUICAUGBQUGBgYGBgUFBQYGBgYGBgYGBgYGBgYGBQYGBgYGBgYGBgoGBgcICQkJBgYLDgoIDQYICQgBAwQEBgUGCAYGCAgHBwcICAgICAgBAABAgMFBgcECP.... + message: Successfully Processed + status: Success + '401': + description: Unauthorized + content: + application/json: + schema: + $ref: '#/components/schemas/unauthorized' + '402': + description: Payment Required + content: + application/json: + schema: + $ref: '#/components/schemas/paymentrequired' + '403': + description: Forbidden + content: + application/json: + schema: + $ref: '#/components/schemas/forbidden' + '404': + description: Not Found + content: + application/json: + schema: + $ref: '#/components/schemas/notfound' + '419': + description: Input Field Missing + content: + application/json: + schema: + $ref: '#/components/schemas/inputfieldmissing' + '420': + description: Input Limit Exceeded + content: + application/json: + schema: + $ref: '#/components/schemas/inputlimitexceeded' + '500': + description: Internal Server Error + content: + application/json: + schema: + $ref: '#/components/schemas/servererror' + '504': + description: Gateway Timeout + content: + application/json: + schema: + $ref: '#/components/schemas/gatewaytimeout' + security: + - APIAuthorizer: [] + requestBody: + description: Input parameters

FieldType Description
filePathFileRequired. The file object
typeStringOptional. type of return data as xml/hyperlink/json/datauri/plaintext. plaintext is default if none selected


+ content: + multipart/form-data: + schema: + $ref: '#/components/schemas/input' + # required: true +components: + schemas: + success: + type: object + properties: + results: + type: object + example: { "" } + description: Json Object of returned results + properties: + base64: + type: string + description: Converted base64 encoded text in the requested output format + example: /9j/4AAQSkZJRgABAQAAAQABAAD/2wCEAAMCAggIBQUICAUGBQUGBgYGBgUFBQYGBgYGBgYGBgYGBgYGBQYGBgYGBgYGBgoGBgcICQkJBgYLDgoIDQYICQgBAwQEBgUGCAYGCAgHBwcICAgICAgBAABAgMFBgcECP.... + message: + type: string + example: Successfully Processed + description: Detail description on the API status + status: + type: string + example: Success + description: The status of the API call success/failure + unauthorized: + type: object + properties: + message: + type: string + example: Missing Authentication Token + status: + type: string + example: Failure + forbidden: + type: object + properties: + message: + type: string + example: Access Denied Unauthorized User + status: + type: string + example: Failure + paymentrequired: + type: object + properties: + message: + type: string + example: Insufficient Credits Kindly Top Up + status: + type: string + example: Failure + notfound: + type: object + properties: + message: + type: string + example: Invalid Request URL + status: + type: string + example: Failure + servererror: + type: object + properties: + message: + type: string + example: Internal Server Error + status: + type: string + example: Failure + gatewaytimeout: + type: object + properties: + message: + type: string + example: Request Timeout + status: + type: string + example: Failure + inputfieldmissing: + type: object + properties: + message: + type: string + example: Input Field Missing + status: + type: string + example: Failure + inputlimitexceeded: + type: object + properties: + message: + type: string + example: Input Limit Exceeded + status: + type: string + example: Failure + input: + type: object + required: + - filePath + properties: + filePath: + type: string + format: binary + example: sample.txt + default: true + description: The file object. + format: + type: string + example: "xml" + default: false + description: |+ + The output format. Possible values are: + 1. plaintext (default) + 2. json + 3. hyperlink + 4. datauri + 5. xml + versions: + type: object + properties: + v0.0.1: + type: array + items: + oneOf: + - type: string + example: Published Date - Oct 30, 2020 + description: Initial version release + securitySchemes: + APIAuthorizer: + type: apiKey + name: x-api-key + in: header + x-amazon-apigateway-authtype: custom + description: Authentication is done using the x-api-key in the request header From bf4c29cecaaacb906931d29dc11dc9541a226887 Mon Sep 17 00:00:00 2001 From: Mohan Palanisamy <51600193+mohanpalanisamy92@users.noreply.github.com> Date: Fri, 30 Oct 2020 19:27:47 +0530 Subject: [PATCH 168/792] Create base64-file-decode.yaml --- yaml/base64-file-decode.yaml | 202 +++++++++++++++++++++++++++++++++++ 1 file changed, 202 insertions(+) create mode 100644 yaml/base64-file-decode.yaml diff --git a/yaml/base64-file-decode.yaml b/yaml/base64-file-decode.yaml new file mode 100644 index 000000000..10c7cf266 --- /dev/null +++ b/yaml/base64-file-decode.yaml @@ -0,0 +1,202 @@ +openapi: 3.0.1 +info: + title: Base64 Decoder + description: |+ + This Utility microservice converts a Base64 encoded text string to a binary file.

For the reverse process (convert binary file to Base64 encoded text string), check out the Base64 File Encode microservice. + version: '0.0.1' + x-subscribelink: base64_file_decode +servers: + - url: 'https://apis.sentient.io' +tags: +- name: "v0.0.1" + description: "Published Date - Oct 30, 2020" +paths: + /microservices/utility/base64decode/v0/getresults: + post: + tags: + - "0.0.1" + responses: + '200': + description: success response + content: + application/json: + schema: + $ref: '#/components/schemas/success' + example: + url: https://storage.googleapis.com/base64decode_dev/24f03729131e469181a2fc22eb3a627a.zip?X-Goog-Algorithm=GOOG4-RSA-SHA256&X-Goog-Credential=sentient-dev-bigquery%40sentient-207310.iam.gserviceaccount.com%2F20201015%2Fa... + message: Successfully Processed + status: Success + '401': + description: Unauthorized + content: + application/json: + schema: + $ref: '#/components/schemas/unauthorized' + '402': + description: Payment Required + content: + application/json: + schema: + $ref: '#/components/schemas/paymentrequired' + '403': + description: Forbidden + content: + application/json: + schema: + $ref: '#/components/schemas/forbidden' + '404': + description: Not Found + content: + application/json: + schema: + $ref: '#/components/schemas/notfound' + '419': + description: Input Field Missing + content: + application/json: + schema: + $ref: '#/components/schemas/inputfieldmissing' + '420': + description: Input Limit Exceeded + content: + application/json: + schema: + $ref: '#/components/schemas/inputlimitexceeded' + '500': + description: Internal Server Error + content: + application/json: + schema: + $ref: '#/components/schemas/servererror' + '504': + description: Gateway Timeout + content: + application/json: + schema: + $ref: '#/components/schemas/gatewaytimeout' + security: + - APIAuthorizer: [] + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/input' + required: true +components: + schemas: + success: + type: object + properties: + message: + type: string + example: Successfully Processed + description: Detail description on the api status + status: + type: string + example: Success + description: The status of the API call success/failure + url: + type: string + example: https://storage.googleapis.com/base64decode/24f03729131e469181a2fc22eb3a627a.zip?X-Goog-Algorithm=GOOG4-RSA-SHA256&X-Goog-Credential=sentient-dev-bigquery%40sentient-207310.iam.gserviceaccount.com%2F20201015%2Fauto%2Fstora... + description: Pre-signed URL to download the file + unauthorized: + type: object + properties: + message: + type: string + example: Missing Authentication Token + status: + type: string + example: Failure + forbidden: + type: object + properties: + message: + type: string + example: Access Denied Unauthorized User + status: + type: string + example: Failure + paymentrequired: + type: object + properties: + message: + type: string + example: Insufficient Credits Kindly Top Up + status: + type: string + example: Failure + notfound: + type: object + properties: + message: + type: string + example: Invalid Request URL + status: + type: string + example: Failure + servererror: + type: object + properties: + message: + type: string + example: Internal Server Error + status: + type: string + example: Failure + gatewaytimeout: + type: object + properties: + message: + type: string + example: Request Timeout + status: + type: string + example: Failure + inputfieldmissing: + type: object + properties: + message: + type: string + example: Input Field Missing + status: + type: string + example: Failure + inputlimitexceeded: + type: object + properties: + message: + type: string + example: Input Limit Exceeded + status: + type: string + example: Failure + versions: + type: object + properties: + v0.0.1: + type: array + items: + oneOf: + - type: string + example: Published Date - Oct 30,2020 + description: Initial version release + input: + type: object + required: + - base64 + properties: + base64: + x-name: base64 + type: string + default: true + example: UklGRoboDgBXQVZFZm10IBAAAAABAAEAgD4AAAB9AAACABAATElTVBoAAABJTkZPSVNGVA4AAABMYXZmNTguMjAuMTAwAGRhdGFA6A4AAAAAAAAAAAAAAAAAAAAAAAAA... + description: |+ + Input base64 encoded string + securitySchemes: + APIAuthorizer: + type: apiKey + name: x-api-key + in: header + x-amazon-apigateway-authtype: custom + description: Authentication is done using the x-api-key in the request header From ccc77a4eb22185e41dde9a70913fc124660111c0 Mon Sep 17 00:00:00 2001 From: Mohan Palanisamy <51600193+mohanpalanisamy92@users.noreply.github.com> Date: Fri, 30 Oct 2020 19:34:40 +0530 Subject: [PATCH 169/792] Update index.yaml --- yaml/index.yaml | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/yaml/index.yaml b/yaml/index.yaml index e7177ed89..f76eccbc0 100644 --- a/yaml/index.yaml +++ b/yaml/index.yaml @@ -162,6 +162,14 @@ Utility: title: URLs Retrieval versions: v0.1: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/urls_retrieval.yaml" + Base64 Encoder: + title: Base64 Encoder + versions: + v0.1: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/base64-file-encode.yaml" + Base64 Decoder: + title: Base64 Decoder + versions: + v0.1: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/base64-file-decode.yaml" Data: HDB Commercial Directories (SG): title: HDB Commercial Directories (SG) From 47220a5573455796cbd48fa68a1570717e6232bd Mon Sep 17 00:00:00 2001 From: Priyadharshini Date: Fri, 6 Nov 2020 16:22:00 +0530 Subject: [PATCH 170/792] sprint 24 latest yaml merge from dev branch --- yaml/amenities_hardcourts_hdb_sg.yaml | 12 +- yaml/amenities_lamp_posts_hdb_sg.yaml | 12 +- yaml/amenities_shelters_hdb_sg.yaml | 12 +- ..._with_voice_activity_detection_eng_sg.yaml | 26 +- yaml/audio_format_convertor.yaml | 18 +- yaml/automatic_speech_recognition_chi_sg.yaml | 28 +- yaml/automatic_speech_recognition_eng_sg.yaml | 26 +- yaml/automatic_voice_recognition_eng.yaml | 203 ++++++++++++ yaml/building_addresses_hdb_sg.yaml | 18 +- yaml/carpark_hdb_sg.yaml | 34 +- yaml/commercial_directories_hdb_sg.yaml | 18 +- yaml/csv-json_convertor.yaml | 18 +- yaml/d&b_basic_individual_search_sg.yaml | 14 +- yaml/d&b_brief_financial_information_sg.yaml | 14 +- yaml/d&b_business_check_plus_sg.yaml | 20 +- yaml/d&b_business_check_sg.yaml | 63 ++-- yaml/decryption_using_pki_key.yaml | 10 +- yaml/demographics_hdb_sg.yaml | 22 +- yaml/directory_of_singapore_startups.yaml | 16 +- yaml/document_convertor_eng.yaml | 23 +- yaml/download_dataset.yaml | 4 +- yaml/encryption_using_pki_key.yaml | 10 +- yaml/face_recognition_politicians_sg.yaml | 20 +- ...tness_stations_and_playgrounds_hdb_sg.yaml | 12 +- yaml/flat_ownership_hdb_sg.yaml | 22 +- yaml/inverse_text_normalisation_eng.yaml | 18 +- yaml/inverse_text_normalisation_eng_v1.0.yaml | 228 +++++++++++++ yaml/json-csv_convertor.yaml | 12 +- yaml/landmark_detection_jp.yaml | 14 +- yaml/landmark_detection_sg.yaml | 14 +- yaml/named-entity_recognition_eng.yaml | 18 +- yaml/named-entity_recognition_eng_v1.0.yaml | 16 +- yaml/named-entity_recognition_jp.yaml | 16 +- yaml/named-entity_recognition_jp_v1.0.yaml | 18 +- yaml/named-entity_recognition_thai.yaml | 10 +- yaml/named-entity_recognition_thai_v1.0.yaml | 16 +- yaml/newspaper_article_scraper.yaml | 20 +- yaml/object_detection.yaml | 28 +- ...e_automatic_speech_recognition_eng_sg.yaml | 6 +- ...d_automatic_speech_recognition_eng_sg.yaml | 6 +- yaml/page_profiler_eng.yaml | 40 ++- yaml/page_profiler_eng_v2.1.yaml | 243 ++++++++++++++ yaml/page_profiler_jp.yaml | 21 +- yaml/page_profiler_thai.yaml | 23 +- yaml/pdf_extractor.yaml | 24 +- yaml/people_counting.yaml | 15 +- yaml/pki_key_generator.yaml | 10 +- yaml/residential_sales_and_rental_hdb_sg.yaml | 46 +-- yaml/script_alignment.yaml | 24 +- yaml/script_alignment_v1.0.yaml | 284 ++++++++++++++++ yaml/season_parking_availability_hdb_sg.yaml | 20 +- yaml/sentiment-analysis-aws.yaml | 6 +- yaml/sentiment-analysis-google.yaml | 6 +- yaml/spacy_named-entity_recognition_eng.yaml | 11 +- yaml/taxonomy_matcher_eng.yaml | 18 +- yaml/taxonomy_matcher_eng_v1.0.yaml | 238 ++++++++++++++ yaml/text-to-speech_chi.yaml | 14 +- yaml/text-to-speech_eng.yaml | 155 ++++++++- yaml/urls_retrieval.yaml | 21 +- yaml/video-to-audio_convertor.yaml | 19 +- yaml/video-to-image_convertor.yaml | 20 +- yaml/voice_activity_detection_eng.yaml | 18 +- yaml/web_scraper.yaml | 231 +++++++------ yaml/wikipedia_retrieval.yaml | 12 +- yaml/word_sense_disambiguation_eng.yaml | 23 +- yaml/word_sense_disambiguation_eng_v1.0.yaml | 307 ++++++++++++++++++ yaml/youtube_video_downloader.yaml | 16 +- 67 files changed, 2392 insertions(+), 588 deletions(-) create mode 100644 yaml/automatic_voice_recognition_eng.yaml create mode 100644 yaml/inverse_text_normalisation_eng_v1.0.yaml create mode 100644 yaml/page_profiler_eng_v2.1.yaml create mode 100644 yaml/script_alignment_v1.0.yaml create mode 100644 yaml/taxonomy_matcher_eng_v1.0.yaml create mode 100644 yaml/word_sense_disambiguation_eng_v1.0.yaml diff --git a/yaml/amenities_hardcourts_hdb_sg.yaml b/yaml/amenities_hardcourts_hdb_sg.yaml index 48324a035..41faaa918 100644 --- a/yaml/amenities_hardcourts_hdb_sg.yaml +++ b/yaml/amenities_hardcourts_hdb_sg.yaml @@ -32,17 +32,17 @@ info: | INC_CRC | Varchar | 50 | Sub Location Id | | FMEL_UPD_D | Datetime | N/A | Area of the feature | | Shape__Length | Float | N/A | Length of the feature | - version: '0.1' + version: '0.1.0' servers: - url: 'https://api.sentient.io' tags: -- name: "v0.1" - description: "Published Date - Feb 07, 2020" +- name: "v0.1.0" + description: "Published Date - Mar 24, 2020" paths: /DaaS/prod/hdb/amenities/gs/csv/hardcourt/hdb: get: tags: - - v0.1 + - v0.1.0 responses: '200': description: success response @@ -202,12 +202,12 @@ components: versions: type: object properties: - v0.1: + v0.1.0: type: array items: oneOf: - type: string - example: Published Date - Feb 07, 2020 + example: Published Date - Mar 24, 2020 description: Initial version release securitySchemes: APIAuthorizer: diff --git a/yaml/amenities_lamp_posts_hdb_sg.yaml b/yaml/amenities_lamp_posts_hdb_sg.yaml index 5c2a09439..7aad87823 100644 --- a/yaml/amenities_lamp_posts_hdb_sg.yaml +++ b/yaml/amenities_lamp_posts_hdb_sg.yaml @@ -33,18 +33,18 @@ info: | FMEL_UPD_D | Datetime | N/A | Area of the feature | | x | Float | N/A | ESRI x coordinate | | y | Float | N/A | ESRI y coordinate | - version: '0.1' + version: '0.1.0' servers: - url: 'https://api.sentient.io' tags: -- name: "v0.1" - description: "Published Date - Feb 07, 2020" +- name: "v0.1.0" + description: "Published Date - Mar 24, 2020" paths: /DaaS/prod/hdb/amenities/gs/csv/lamppost/hdb: get: tags: - - v0.1 + - v0.1.0 responses: '200': description: success response @@ -204,12 +204,12 @@ components: versions: type: object properties: - v0.1: + v0.1.0: type: array items: oneOf: - type: string - example: Published Date - Feb 07, 2020 + example: Published Date - Mar 24, 2020 description: Initial version release securitySchemes: APIAuthorizer: diff --git a/yaml/amenities_shelters_hdb_sg.yaml b/yaml/amenities_shelters_hdb_sg.yaml index fad46f2fe..d41b3f772 100644 --- a/yaml/amenities_shelters_hdb_sg.yaml +++ b/yaml/amenities_shelters_hdb_sg.yaml @@ -33,17 +33,17 @@ info: | FMEL_UPD_D | Datetime | N/A | Area of the feature | | Shape__Area | Float | N/A | Area of the feature | | Shape__Length | Float | N/A | Length of the feature | - version: '0.1' + version: '0.1.0' servers: - url: 'https://api.sentient.io' tags: -- name: "v0.1" - description: "Published Date - Feb 07, 2020" +- name: "v0.1.0" + description: "Published Date - Mar 24, 2020" paths: /DaaS/prod/hdb/amenities/gs/csv/shelter/hdb: get: tags: - - v0.1 + - v0.1.0 responses: '200': description: success response @@ -203,12 +203,12 @@ components: versions: type: object properties: - v0.1: + v0.1.0: type: array items: oneOf: - type: string - example: Published Date - Feb 07, 2020 + example: Published Date - Mar 24, 2020 description: Initial version release securitySchemes: APIAuthorizer: diff --git a/yaml/asr_with_voice_activity_detection_eng_sg.yaml b/yaml/asr_with_voice_activity_detection_eng_sg.yaml index 87f4140cb..ce6cdbf0d 100644 --- a/yaml/asr_with_voice_activity_detection_eng_sg.yaml +++ b/yaml/asr_with_voice_activity_detection_eng_sg.yaml @@ -4,19 +4,21 @@ info: description: |+ This Voice microservice combines Voice Activity Detection feature and Automatic Speech Recognition capability. It detects speech in an audio file (.wav format) and transcribes English speech content from the audio stream into text. The transcript text is timestamped for each utterance. An utterance is a continuous piece of speech beginning and ending with a clear pause. - This Voice microservice performs well on Singapore-accented English speech. For best performance, select the model which best matches the use-case: news_parliament, nsc_parliament, nscfull_8k - version: '0.1' + This Voice microservice performs well on Singapore-accented English speech. For best performance, select the model which best matches the use-case: news_parliament, nsc_parliament, nscfull_8k. + + The size of your audio file should be **between 3 KB to 10 MB**. + version: '0.1.0' x-subscribelink: asr_with_voice_activity_detection_eng_sg servers: - url: 'https://apis.sentient.io' tags: -- name: "v0.1" - description: "Published Date - Sep 30, 2019" +- name: "v0.1.0" + description: "Published Date - Dec 14, 2019" paths: /microservices/voice/vadasr/v0.1/getpredictions: post: tags: - - v0.1 + - v0.1.0 responses: '200': description: success response @@ -201,17 +203,21 @@ components: default: true example: https://api.sentient.io/test2.wav or UklGRpxNHQBXQVZFZm10IBAAAAABAAEAgD4AAAB9AAACABAAT ... description: |+ - The public URL link to the wave file or Input audio wav file in base64 format. Mono channel, 8kHz / 16kHz sampling rate. + The public URL link to the wave file or Input audio wav file in base64 format. + + Mono channel, 8kHz / 16kHz sampling rate. file_type: x-name: file_type type: string default: true example: wav description: |+ - Input file extension. Only “wav” is supported at the moment. + Input file extension. + + Currently supported formats: .wav vad_threshold: x-name: vad_threshold - type: integer + type: number format: float default: true example: 0.4 @@ -220,12 +226,12 @@ components: versions: type: object properties: - v0.1: + v0.1.0: type: array items: oneOf: - type: string - example: Published Date - Sept 30,2019 + example: Published Date - Dec 14,2019 description: Initial version release securitySchemes: diff --git a/yaml/audio_format_convertor.yaml b/yaml/audio_format_convertor.yaml index 8f1408991..eaa54cf06 100644 --- a/yaml/audio_format_convertor.yaml +++ b/yaml/audio_format_convertor.yaml @@ -3,18 +3,20 @@ info: title: Audio Format Convertor description: >- This API is used to convert your audio like music(any format) to the WAV format. - version: '0.1' + + The size of your audio file should **not exceed 10 MB**. + version: '0.1.0' x-subscribelink: audio_format_convertor servers: - url: 'https://apis.sentient.io' tags: -- name: "v0.1" - description: "Published Date - Feb 10, 2020" +- name: "v0.1.0" + description: "Published Date - Mar 24, 2020" paths: /microservices/utility/audioprocessing/v0.1/getresults: post: tags: - - v0.1 + - v0.1.0 responses: '200': description: success response @@ -176,12 +178,12 @@ components: versions: type: object properties: - v1.0: + v0.1.0: type: array items: oneOf: - type: string - example: Published Date - Feb 10, 2020 + example: Published Date - Mar 24, 2020 description: Initial version release input: type: object @@ -192,8 +194,8 @@ components: type: string format: binary default: true - example: upload file - description: Maximum file size up to 10MB + example: sample.wav + description: Maximum file size up to 10 MB. samplerate: type: string default: false diff --git a/yaml/automatic_speech_recognition_chi_sg.yaml b/yaml/automatic_speech_recognition_chi_sg.yaml index 41cbac215..1a10ed1c6 100644 --- a/yaml/automatic_speech_recognition_chi_sg.yaml +++ b/yaml/automatic_speech_recognition_chi_sg.yaml @@ -5,18 +5,20 @@ info: This Voice microservice takes in the input audio file (in WAV format at 16kHz) and transcribes Mandarin speech content within the input file into text. This microservice works best for if the audio file consists of mostly speech with no long pauses in between. - version: '0.1' + + The size of your audio file should be **between 3 KB to 10 MB**. + version: '0.1.1' x-subscribelink: automatic_speech_recognition_chi_sg servers: - url: 'https://apis.sentient.io' tags: -- name: "v0.1" - description: "Published Date - Jun 18, 2018" +- name: "v0.1.1" + description: "Published Date - Sep 28, 2018" paths: /microservices/voice/asrsch/v0.1/getpredictions: post: tags: - - v0.1 + - v0.1.1 responses: '200': description: success response @@ -179,8 +181,11 @@ components: default: true example: data:audio/wav;base64,UklGRkbiBABXQVZFZm10IBAAAAABA... description: |+ - Input file in base64 format and needs to be prefixed by the data type and encoding - data:audio/wav;base64, + Input file in base64 format. + + Input file needs to be prefixed by the data type and encoding. + + Data:audio/wav;base64, language: x-name: language type: string @@ -192,12 +197,19 @@ components: versions: type: object properties: - v0.1: + v0.1.1: + type: array + items: + oneOf: + - type: string + example: Published Date - Sep 28,2018 + description: Patch update on bug fixes + v0.1.0: type: array items: oneOf: - type: string - example: Published Date - Jun 18,2018 + example: Published Date - Jun 21,2018 description: Initial version release securitySchemes: APIAuthorizer: diff --git a/yaml/automatic_speech_recognition_eng_sg.yaml b/yaml/automatic_speech_recognition_eng_sg.yaml index ebd06737e..6e64f6eca 100644 --- a/yaml/automatic_speech_recognition_eng_sg.yaml +++ b/yaml/automatic_speech_recognition_eng_sg.yaml @@ -5,18 +5,20 @@ info: This Voice microservice transcribes the input audio stream into text. This microservice performs well on Singaporean-accented English speech. For best performance, select the model which best matches the use-case: news_parliament, nsc_parliament and nscfull_8k. - version: '0.1' + + The size of your audio file should be **between 3 KB to 10 MB**. + version: '0.1.0' x-subscribelink: automatic_speech_recognition_eng_sg servers: - url: 'https://apis.sentient.io' tags: -- name: "v0.1" - description: "Published Date - July 3, 2020" +- name: "v0.1.0" + description: "Published Date - Jul 03, 2020" paths: /microservices/voice/asr/v0.1/getpredictions: post: tags: - - v0.1 + - v0.1.0 responses: '200': description: success response @@ -101,16 +103,16 @@ components: example: {seqNum: 1,start: 1.0,end: 4.0,text: HELLO WORLD} properties: end: - type: integer + type: number format: float example: 23.72 description: End time of utterance in seconds seqNum: - type: integer + type: number example: 1 description: Running sequence. Starts from 1. start: - type: integer + type: number format: float example: 0.64 description: Start time of utterance in seconds @@ -227,7 +229,7 @@ components: properties: end: x-name: end - type: integer + type: number format: float default: false example: "4.0" @@ -235,14 +237,14 @@ components: "End time of utterance, in seconds. Offset from the start of stream." seqNum: x-name: seqNum - type: integer + type: number default: false example: "1" description: |+ "Running sequence. Starts from 1." start: x-name: start - type: integer + type: number format: float default: false example: "1.0" @@ -251,12 +253,12 @@ components: versions: type: object properties: - v0.1: + v0.1.0: type: array items: oneOf: - type: string - example: Published Date - Jun 03,2020 + example: Published Date - Jul 03,2020 description: Initial version release securitySchemes: APIAuthorizer: diff --git a/yaml/automatic_voice_recognition_eng.yaml b/yaml/automatic_voice_recognition_eng.yaml new file mode 100644 index 000000000..9a3645a81 --- /dev/null +++ b/yaml/automatic_voice_recognition_eng.yaml @@ -0,0 +1,203 @@ +openapi: 3.0.1 +info: + title: Automatic Voice Recognition ENG + description: |+ + This Voice microservice takes in an audio file (in WAV format at 16kHz) and transcribes English speech content within the input file into text. + + The Automatic Speech Recognition (ASR) AI model is employed to understand the mapping of sound features to actual words in English. + + Use this microservice if the audio file consists of mostly speech with no long pauses in between. + version: '0.1.0' +servers: + - url: 'https://apis.sentient.io' +tags: +- name: "v0.1.0" + description: "Published Date - Jun 18, 2018" +paths: + /microservices/voice/asreng/v0.1/getpredictions: + post: + tags: + - v0.1.0 + responses: + '200': + description: success response + content: + application/json: + schema: + $ref: '#/components/schemas/success' + example: + message: Hi there + status: success + '401': + description: Unauthorized + content: + application/json: + schema: + $ref: '#/components/schemas/unauthorized' + '402': + description: Payment Required + content: + application/json: + schema: + $ref: '#/components/schemas/paymentrequired' + '403': + description: Forbidden + content: + application/json: + schema: + $ref: '#/components/schemas/forbidden' + '404': + description: Not Found + content: + application/json: + schema: + $ref: '#/components/schemas/notfound' + '419': + description: Input Field Missing + content: + application/json: + schema: + $ref: '#/components/schemas/inputfieldmissing' + '420': + description: Input Limit Exceeded + content: + application/json: + schema: + $ref: '#/components/schemas/inputlimitexceeded' + '500': + description: Internal Server Error + content: + application/json: + schema: + $ref: '#/components/schemas/servererror' + '504': + description: Gateway Timeout + content: + application/json: + schema: + $ref: '#/components/schemas/gatewaytimeout' + security: + - APIAuthorizer: [] + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/input' + required: true +components: + schemas: + success: + type: object + properties: + message: + x-name: message + type: string + example: Hi there + description: Converted Text + status: + x-name: status + type: string + example: success + description: The status of the API call success/failure + unauthorized: + type: object + properties: + message: + type: string + example: Missing Authentication Token + status: + type: string + example: Failure + forbidden: + type: object + properties: + message: + type: string + example: Access Denied Unauthorized User + status: + type: string + example: Failure + paymentrequired: + type: object + properties: + message: + type: string + example: Insufficient Credits Kindly Top Up + status: + type: string + example: Failure + notfound: + type: object + properties: + message: + type: string + example: Invalid Request URL + status: + type: string + example: Failure + servererror: + type: object + properties: + message: + type: string + example: Internal Server Error + status: + type: string + example: Failure + gatewaytimeout: + type: object + properties: + message: + type: string + example: Request Timeout + status: + type: string + example: Failure + inputfieldmissing: + type: object + properties: + message: + type: string + example: Input Field Missing + status: + type: string + example: Failure + inputlimitexceeded: + type: object + properties: + message: + type: string + example: Input Limit Exceeded + status: + type: string + example: Failure + input: + type: object + required: + - audio + properties: + audio: + x-name: audio + type: string + default: true + example: data:audio/wav;base64,UklGRkbiBABXQVZFZm10IBAAAAABA... + description: |+ + Input file in base64 format and needs to be prefixed by the data type and encoding + data:audio/wav;base64, + versions: + type: object + properties: + v0.1.0: + type: array + items: + oneOf: + - type: string + example: Published Date - Jun 18,2018 + description: Initial version release + securitySchemes: + APIAuthorizer: + type: apiKey + name: x-api-key + in: header + x-amazon-apigateway-authtype: custom + description: Authentication is done using the x-api-key in the request header diff --git a/yaml/building_addresses_hdb_sg.yaml b/yaml/building_addresses_hdb_sg.yaml index 51087a25b..aadb938ab 100644 --- a/yaml/building_addresses_hdb_sg.yaml +++ b/yaml/building_addresses_hdb_sg.yaml @@ -87,17 +87,17 @@ info: Using a filterdata only: > filterdata = {"filter":[{"geo_distance": {"distance": "1km","location": "1.368960,103.957980"}}]} - version: '0.1' + version: '0.1.0' servers: - url: 'https://api.sentient.io' tags: -- name: "v0.1" - description: "Published Date - Oct 10, 2019" +- name: "v0.1.0" + description: "Published Date - Nov 25, 2019" paths: /DaaS/prod/directories/searchbranch: get: tags: - - v0.1 + - v0.1.0 parameters: - in: query name: querystring @@ -226,11 +226,11 @@ components: description: Json Object of returned results properties: total: - type: integer + type: number example: 1 description: Total number of records max_score: - type: integer + type: number example: 17.995623 description: The highest score value hits: @@ -253,7 +253,7 @@ components: description: Document ID example: "uLxcqWgBv3dNEHq2Dznn" _score: - type: integer + type: number description: The document score for the search request example: 12.08503 _source: @@ -381,12 +381,12 @@ components: versions: type: object properties: - v0.1: + v0.1.0: type: array items: oneOf: - type: string - example: Published Date - Oct 10,2019 + example: Published Date - Nov 25,2019 description: Initial version release securitySchemes: APIAuthorizer: diff --git a/yaml/carpark_hdb_sg.yaml b/yaml/carpark_hdb_sg.yaml index a730cab4a..e5f01e595 100644 --- a/yaml/carpark_hdb_sg.yaml +++ b/yaml/carpark_hdb_sg.yaml @@ -115,17 +115,17 @@ info: > querystring = "bishan street 22" > filterdata = {"filter":[ {"range":{"lorry":{"gte":1}}} ]} - version: '0.1' + version: '0.2.0' servers: - url: 'https://api.sentient.io' tags: -- name: "v0.1" - description: "Published Date - Oct 10, 2019" +- name: "v0.2.0" + description: "Published Date - Sep 15, 2020" paths: /DaaS/prod/hdb/carpark: get: tags: - - v0.1 + - v0.2.0 parameters: - in: query name: querystring @@ -273,11 +273,11 @@ components: description: Json Object of returned results properties: total: - type: integer + type: number example: 986 description: Total number of records max_score: - type: integer + type: number example: 17.995623 description: The highest score value hits: @@ -300,7 +300,7 @@ components: description: Document ID example: "K7scqWgBv3dNEHq2WvMo" _score: - type: integer + type: number description: The document score for the search request example: 17.995623 _source: @@ -358,15 +358,15 @@ components: description: WGS84 (GPS) longitude example: 103.8469821 car: - type: integer + type: number description: Number of car parking lots example: 18 lorry: - type: integer + type: number description: Number of lorry parking lots example: 6 mc: - type: integer + type: number description: Number of motorcycle parking lots example: 0 createddate: @@ -460,12 +460,22 @@ components: versions: type: object properties: - v0.1: + v0.2.0: type: array items: oneOf: - type: string - example: Published Date - Oct 10,2019 + example: Published Date - Sep 15,2020 + description: |+ + The following additional fields are added: + 1. postalcode - list of postal code + 2. location - lat / log of the carpark park + v0.1.0: + type: array + items: + oneOf: + - type: string + example: Published Date - Nov 25,2019 description: Initial version release securitySchemes: APIAuthorizer: diff --git a/yaml/commercial_directories_hdb_sg.yaml b/yaml/commercial_directories_hdb_sg.yaml index cc55ce7a9..df9b6e5e1 100644 --- a/yaml/commercial_directories_hdb_sg.yaml +++ b/yaml/commercial_directories_hdb_sg.yaml @@ -107,17 +107,17 @@ info: > filterdata = {"filter":[{"match_phrase": {"trade":"cake shop"}},{"match": {"block":"122"}},{"match_phrase": {"street":"bukit merah lane 1"}}]} - version: '0.1' + version: '0.1.0' servers: - url: 'https://api.sentient.io' tags: -- name: "v0.1" - description: "Published Date - Oct 31, 2018" +- name: "v0.1.0" + description: "Published Date - Dec 26, 2018" paths: /DaaS/prod/directories/hdb/searchdir: get: tags: - - v0.1 + - v0.1.0 parameters: - in: query name: querystring @@ -257,11 +257,11 @@ components: description: Json Object of returned results properties: total: - type: integer + type: number example: 986 description: Total number of records max_score: - type: integer + type: number example: 17.995623 description: The highest score value hits: @@ -284,7 +284,7 @@ components: description: Document ID example: "K7scqWgBv3dNEHq2WvMo" _score: - type: integer + type: number description: The document score for the search request example: 17.995623 _source: @@ -487,12 +487,12 @@ components: versions: type: object properties: - v0.1: + v0.1.0: type: array items: oneOf: - type: string - example: Published Date - Oct 31,2018 + example: Published Date - Dec 26,2018 description: Initial version release securitySchemes: APIAuthorizer: diff --git a/yaml/csv-json_convertor.yaml b/yaml/csv-json_convertor.yaml index af00c6474..618a431f5 100644 --- a/yaml/csv-json_convertor.yaml +++ b/yaml/csv-json_convertor.yaml @@ -3,18 +3,20 @@ info: title: CSV-JSON Convertor description: |+ This Utility microservice converts the input CSV to JSON format. The headers should be the keywords and columns should be the value of proper keywords. - version: '1.0' + + The size of your file should **not exceed 3.5 MB**. + version: '1.0.0' x-subscribelink: csv-json_convertor servers: - url: 'https://apis.sentient.io' tags: -- name: "v1.0" - description: "Published Date - May 21, 2020" +- name: "v1.0.0" + description: "Published Date - May 15, 2020" paths: /microservices/utility/csvtojson/v1.0/getresults: post: tags: - - v1.0 + - v1.0.0 responses: '200': description: success response @@ -185,12 +187,12 @@ components: versions: type: object properties: - v1.0: + v1.0.0: type: array items: oneOf: - type: string - example: Published Date - May 21, 2020 + example: Published Date - May 15, 2020 description: Initial version release input: type: object @@ -201,8 +203,8 @@ components: type: string format: binary default: true - example: upload file - description: The file object Max. file size upto - 3.5MB + example: sample.csv + description: The file object. securitySchemes: APIAuthorizer: type: apiKey diff --git a/yaml/d&b_basic_individual_search_sg.yaml b/yaml/d&b_basic_individual_search_sg.yaml index dc11fda59..d9cf0ef93 100644 --- a/yaml/d&b_basic_individual_search_sg.yaml +++ b/yaml/d&b_basic_individual_search_sg.yaml @@ -3,18 +3,18 @@ info: title: D&B Basic Individual Search (SG) description: |+ This Data microservice provides the information on the (Singapore-registered) business interest of an individual that includes the individual’s actual name, residential address, business and shareholding in businesses, current & previous ownership, litigation against individual and businesses, bankruptcy record and count on the times this individual has been searched on. Updated daily. - version: '0.1' + version: '0.1.0' x-subscribelink: d&b_basic_individual_search_sg servers: - url: 'https://api.sentient.io' tags: -- name: "v0.1" - description: "Published Date - Jul 23, 2019" +- name: "v0.1.0" + description: "Published Date - Aug 15, 2019" paths: /dnb/prod/sbis: post: tags: - - v0.1 + - v0.1.0 summary: Adds a new user requestBody: content: @@ -1247,7 +1247,7 @@ components: type: object properties: TOT_ITEMS: - type: integer + type: number example: 1 description: Number of subjects being enquired relating to the Run default: false @@ -1271,12 +1271,12 @@ components: versions: type: object properties: - v0.1: + v0.1.0: type: array items: oneOf: - type: string - example: Published Date - Jul 23, 2019 + example: Published Date - Aug 15, 2019 description: Initial version release securitySchemes: APIAuthorizer: diff --git a/yaml/d&b_brief_financial_information_sg.yaml b/yaml/d&b_brief_financial_information_sg.yaml index 7f969cbd7..e921954c9 100644 --- a/yaml/d&b_brief_financial_information_sg.yaml +++ b/yaml/d&b_brief_financial_information_sg.yaml @@ -2,18 +2,18 @@ openapi: 3.0.1 info: title: D&B Brief Financial Information (SG) description: This Data microservice provides the annual financial information of the Singapore-registered business, inclusive of annual profit and loss and financial ratios. Updated daily. - version: '0.1' + version: '0.1.0' x-subscribelink: d&b_brief_financial_information_sg servers: - url: 'https://api.sentient.io' tags: -- name: "v0.1" - description: "Published Date - Jul 23, 2019" +- name: "v0.1.0" + description: "Published Date - Aug 15, 2019" paths: /dnb/prod/sbfe: post: tags: - - v0.1 + - v0.1.0 summary: Adds a new user requestBody: content: @@ -1344,7 +1344,7 @@ components: type: object properties: TOT_ITEMS: - type: integer + type: number example: 1 description: Number of subjects being enquired relating to the Run default: false @@ -1368,12 +1368,12 @@ components: versions: type: object properties: - v0.1: + v0.1.0: type: array items: oneOf: - type: string - example: Published Date - Jul 23, 2019 + example: Published Date - Aug 15, 2019 description: Initial version release securitySchemes: APIAuthorizer: diff --git a/yaml/d&b_business_check_plus_sg.yaml b/yaml/d&b_business_check_plus_sg.yaml index 0bf55f77b..abd4f3e57 100644 --- a/yaml/d&b_business_check_plus_sg.yaml +++ b/yaml/d&b_business_check_plus_sg.yaml @@ -2,18 +2,18 @@ openapi: 3.0.1 info: title: D&B Business Check Plus (SG) description: The Data microservice provides key business information, litigation information (High and Subordinate Courts) and Winding Up Trace of a company including the Business name, registration number, registered address and date of change, company status, registered activities, shareholders details (i.e. date of commencement, residing address) capital amount and shares allocated to each shareholder, litigation information. Updated daily. - version: '0.1' + version: '0.1.0' x-subscribelink: d&b_business_check_plus_sg servers: - url: 'https://api.sentient.io' tags: -- name: "v0.1" - description: "Published Date - Jul 23, 2019" +- name: "v0.1.0" + description: "Published Date - Aug 15, 2019" paths: /dnb/prod/sbcp: post: tags: - - v0.1 + - v0.1.0 summary: Adds a new user requestBody: content: @@ -1563,11 +1563,7 @@ components: example: 0001 Rcsecflag : type: integer - description: |+ - Differentiate Search By Financial Sectors and Search By Non- Financial Sectors. - Possible values are: - 1 SEARCH BY FINANCIAL SECTORS - 0 SEARCH BY NON FINANCIAL SECTORS + description: Differentiate Search By Financial Sectors and Search By Non- Financial Sectors example: 1 LastUpdateDate : type: datetime @@ -1649,7 +1645,7 @@ components: type: object properties: TOT_ITEMS: - type: integer + type: number example: 1 description: Number of subjects being enquired relating to the Run default: false @@ -1673,12 +1669,12 @@ components: versions: type: object properties: - v0.1: + v0.1.0: type: array items: oneOf: - type: string - example: Published Date - Jul 23, 2019 + example: Published Date - Aug 15, 2019 description: Initial version release securitySchemes: APIAuthorizer: diff --git a/yaml/d&b_business_check_sg.yaml b/yaml/d&b_business_check_sg.yaml index ff1a83428..b18197d15 100644 --- a/yaml/d&b_business_check_sg.yaml +++ b/yaml/d&b_business_check_sg.yaml @@ -3,18 +3,18 @@ info: title: D&B Business Check (SG) description: |+ This Data microservice provides key business information of a Singapore-registered company includes the business name, registration number, registered address and date of change, company status, registered activities, shareholders details (i.e. date of commencement, residing address) capital amount and shares allocated to each shareholders. Updated daily. - version: '0.1' + version: '0.1.0' x-subscribelink: d&b_business_check_sg servers: - url: 'https://api.sentient.io' tags: -- name: "v0.1" - description: "Published Date - Jul 23, 2019" +- name: "v0.1.0" + description: "Published Date - Aug 15, 2019" paths: /dnb/prod/sbc: post: tags: - - v0.1 + - v0.1.0 summary: Adds a new user requestBody: content: @@ -271,15 +271,15 @@ components: REG_ACTIVITY_DESC1: type: string description: Registered Activities Description - example: "N/A" + example: REG_ACTIVITY_DESC2: type: string description: Registered Activities Description - example: "N/A" + example: AUDITOR: type: string description: Auditor Name - example: "N/A" + example: AUDITOR_APPMT_DATE: type: string description: Auditor Appointment Date @@ -357,7 +357,7 @@ components: description: Description example: "Employee Size" AMOUNT: - type: integer + type: string description: Number of employee example: "300" LIST_BIZ_BRANCH : @@ -390,7 +390,7 @@ components: ADDR_BUILDING: type: string description: Building Name - example: "N/A" + example: ADDR_POSTCODE: type: string description: Postcode @@ -460,7 +460,7 @@ components: STATUS_SATISFACTION: type: string description: Status of Satisfaction - example: "N/A" + example: LIST_LIQUIDATOR: type: array description: |+ @@ -689,13 +689,7 @@ components: example: UNITED STATES OF AMERICA, DOLLARS SHAREHOLDER_TYPE : type: string - description: |+ - Indicator for Shareholder type - Possible values are: - 1 Individual - 2 Company - 3 Unregistered foreign company - 4 Unregistered local company + description: Indicator for Shareholder type example: 2 SHARE_TYPE : type: string @@ -836,11 +830,7 @@ components: example: DIRECTOR ADDR_TYPE : type: string - description: |+ - Address Type, indicates if it is Singapore or foreign address. - Possible values are: - S Indicates Singapore address - - Indicates foreign address + description: Address Type, indicates if it is Singapore or foreign address. example: S CESSATION_DATE : type: string @@ -998,34 +988,25 @@ components: description: Count for December example: 1 Rcid : - type: string - description: |+ - Internal database value, respond value from table Primary Key ID - It is for (For internal use) - example: N/A + type: integer + description: Internal database value + example: Rcreg : type: string description: Company Registration Number example: Rcrptyid : type: string - description: |+ - Product Type. Possible values are: - 1. Biz Check: 0001 - 2. Biz Check Plus: 0002 - example: 0001 + description: Product Type + example: Rcsecflag : type: integer - description: |+ - Differentiate Search By Financial Sectors and Search By Non- Financial Sectors. - Possible values are: - 1 SEARCH BY FINANCIAL SECTORS - 0 SEARCH BY NON FINANCIAL SECTORS + description: Differentiate Search By Financial Sectors and Search By Non- Financial Sectors example: 1 LastUpdateDate : type: string description: Last update date - example: YYYY-MM-DD 00:00:00.0 + example: unauthorized: type: object properties: @@ -1102,7 +1083,7 @@ components: type: object properties: TOT_ITEMS: - type: integer + type: number example: 1 description: Number of subjects being enquired relating to the Run default: false @@ -1126,12 +1107,12 @@ components: versions: type: object properties: - v0.1: + v0.1.0: type: array items: oneOf: - type: string - example: Published Date - Jul 23, 2019 + example: Published Date - Aug 15, 2019 description: Initial version release securitySchemes: APIAuthorizer: diff --git a/yaml/decryption_using_pki_key.yaml b/yaml/decryption_using_pki_key.yaml index bab372aa9..71cceb45e 100644 --- a/yaml/decryption_using_pki_key.yaml +++ b/yaml/decryption_using_pki_key.yaml @@ -5,18 +5,20 @@ info: This Utiltiy microservice decrypts the input text using the input key string. This can be use with PKI Key Generator. - version: '0.1' + + Do ensure that your text is **within 512 characters**. + version: '0.1.0' x-subscribelink: decryption_using_pki_key servers: - url: 'https://apis.sentient.io' tags: -- name: "v0.1" +- name: "v0.1.0" description: "Published Date - Aug 30, 2019" paths: /microservices/utility/rsa_decode/v0.1/getresults: post: tags: - - v0.1 + - v0.1.0 responses: '200': description: success response @@ -176,7 +178,7 @@ components: versions: type: object properties: - v0.1: + v0.1.0: type: array items: oneOf: diff --git a/yaml/demographics_hdb_sg.yaml b/yaml/demographics_hdb_sg.yaml index 27388d0b6..b33449416 100644 --- a/yaml/demographics_hdb_sg.yaml +++ b/yaml/demographics_hdb_sg.yaml @@ -77,17 +77,17 @@ info: Using a filterdata only: > {"filter":[{"terms":{"postalcode":["050034","050532"]}},{"match":{"gender":"female"}},{"terms":{"age_group_id":[6]}}]} - version: '0.1' + version: '0.1.0' servers: - url: 'https://api.sentient.io' tags: -- name: "v0.1" - description: "Published Date - Apr 24, 2020" +- name: "v0.1.0" + description: "Published Date - May 15, 2020" paths: /DaaS/prod/hdb/demographics: get: tags: - - v0.1 + - v0.1.0 parameters: - in: query name: querystring @@ -223,11 +223,11 @@ components: description: Json Object of returned results properties: total: - type: integer + type: number example: 986 description: Total number of records max_score: - type: integer + type: number example: 17.995623 description: The highest score value hits: @@ -250,7 +250,7 @@ components: description: Document ID example: "K7scqWgBv3dNEHq2WvMo" _score: - type: integer + type: number description: The document score for the search request example: 17.995623 _source: @@ -271,7 +271,7 @@ components: description: Range of age groups example: "50 to 59" age_group_id: - type: integer + type: number description: |+ Age group ID represents a certain age range: 1 (<10 years) @@ -284,7 +284,7 @@ components: 8 (>70 years) example: 6 residents: - type: integer + type: number description: Number of residents example: 54 block: @@ -415,12 +415,12 @@ components: versions: type: object properties: - v0.1: + v0.1.0: type: array items: oneOf: - type: string - example: Published Date - Apr 24,2020 + example: Published Date - May 15,2020 description: Initial version release securitySchemes: APIAuthorizer: diff --git a/yaml/directory_of_singapore_startups.yaml b/yaml/directory_of_singapore_startups.yaml index fa9131657..84f758f9f 100644 --- a/yaml/directory_of_singapore_startups.yaml +++ b/yaml/directory_of_singapore_startups.yaml @@ -74,17 +74,17 @@ info: > "should":[{"match":{"status.e27":"active"}}], > "must_not":[{"match":{"yearestablished.e27":"2016"}}] > } - version: '0.1' + version: '0.1.0' servers: - url: 'https://api.sentient.io' tags: -- name: "v0.1" - description: "Published Date - Nov 15, 2019" +- name: "v0.1.0" + description: "Published Date - Dec 26, 2018" paths: /DaaS/prod/directories/searchdir: get: tags: - - v0.1 + - v0.1.0 parameters: - in: query name: querystring @@ -245,11 +245,11 @@ components: description: Json Object of returned results properties: total: - type: integer + type: number example: 986 description: Total number of records max_score: - type: integer + type: number example: 1 description: The highest score value hits: @@ -514,12 +514,12 @@ components: versions: type: object properties: - v0.1: + v0.1.0: type: array items: oneOf: - type: string - example: Published Date - Nov 15, 2019 + example: Published Date - Dec 26, 2018 description: Initial version release securitySchemes: APIAuthorizer: diff --git a/yaml/document_convertor_eng.yaml b/yaml/document_convertor_eng.yaml index 6001c2bcc..edc12df21 100644 --- a/yaml/document_convertor_eng.yaml +++ b/yaml/document_convertor_eng.yaml @@ -3,18 +3,20 @@ info: title: Document Convertor ENG description: |+ This Utility microservice extracts the English text content of singular input Microsoft Word, HTML or PDF documents and outputs into plain text format. - version: '1.0' + + The size of your document file should **not exceed 7 MB**. + version: '1.0.0' x-subscribelink: document_convertor_eng servers: - url: 'https://apis.sentient.io' tags: -- name: "v1.0" +- name: "v1.0.0" description: "Published Date - Jul 30, 2020" paths: /microservices/utility/docconversion/v1.0/getresults: post: tags: - - v1.0 + - v1.0.0 responses: '200': description: success response @@ -177,12 +179,19 @@ components: versions: type: object properties: - v1.0: + v1.0.0: type: array items: oneOf: - type: string example: Published Date - Jul 30, 2020 + description: Change libary for PDF reader + v0.1.0: + type: array + items: + oneOf: + - type: string + example: Published Date - Apr 16, 2018 description: Initial version release input: type: object @@ -193,8 +202,10 @@ components: type: string format: binary default: true - example: file upload - description: The file object. Supported formats - docx,txt,pdf.Maximum file size up to - 7MB + example: sample.txt + description: The file object. + + Supported formats: docx, pdf, txt. securitySchemes: APIAuthorizer: type: apiKey diff --git a/yaml/download_dataset.yaml b/yaml/download_dataset.yaml index 39d123a41..34c1dc112 100644 --- a/yaml/download_dataset.yaml +++ b/yaml/download_dataset.yaml @@ -1,9 +1,9 @@ info: title: Data Alliance - Download Dataset API - version: '0.1' + version: '0.1.0' # tags must include in to the documentation, to read the description text for published date tags: -- name: "v0.1" +- name: "v0.1.0" description: " " html: |+ diff --git a/yaml/page_profiler_eng.yaml b/yaml/page_profiler_eng.yaml index 17ebd00c8..c7dbf513a 100644 --- a/yaml/page_profiler_eng.yaml +++ b/yaml/page_profiler_eng.yaml @@ -7,18 +7,21 @@ From the web content, the microservice then applies natural language processing to extracts named-entities and returns the output. The named-entity classes extracted are persons, locations, organisations and miscellaneous.

This microservice automatically extracts structured information from unstructured text data such as chatlogs, emails, news articles, etc. - version: '1.0' + + Do ensure that your URL text is in the **ASCII format**. + version: '1.0.0' x-subscribelink: page_profiler_eng + x-depreciated: "Oct 15, 2020" servers: - url: 'https://apis.sentient.io' tags: - - name: "v1.0" + - name: "v1.0.0" description: "Published Date - May 15, 2020" paths: /microservices/nlp/pageprofiler/v1.0/getpredictions: post: tags: - - v1.0 + - v1.0.0 responses: '200': description: success response @@ -180,13 +183,34 @@ versions: type: object properties: - v1.0: + v2.1.0: + type: array + items: + oneOf: + - type: string + example: Published Date - Oct 30, 2020 + description: Partial URL support + v2.0.0: + type: array + items: + oneOf: + - type: string + example: Published Date - Sep 30, 2020 + description: Standardizing Output JSON + v1.0.0: type: array items: oneOf: - type: string - example: Published Date - May 15, 2020 - description: Initial version release + example: Published Date - May 15, 2018 + description: Swaping the NLP with Named-Entity Recognition ENG + v0.1.0: + type: array + items: + oneOf: + - type: string + example: Published Date - Apr 16, 2018 + description: Initial version release input: type: object required: @@ -198,7 +222,9 @@ default: true example: https://www.sentient.io/en/ description: |+ - The URL of the page to be profile. Kindly note that the URL has to be spelt in full, including "https://www." + The URL of the page to be profiled. + + Note that the URL has to be spelt in full, including "https://www." securitySchemes: APIAuthorizer: diff --git a/yaml/page_profiler_eng_v2.1.yaml b/yaml/page_profiler_eng_v2.1.yaml new file mode 100644 index 000000000..5665e4820 --- /dev/null +++ b/yaml/page_profiler_eng_v2.1.yaml @@ -0,0 +1,243 @@ + openapi: 3.0.1 + info: + title: Page Profiler ENG + description: |+ + This NLP microservice retrieves web content in English from the input URL. + + From the web content, the microservice then applies natural language processing to extracts named-entities and returns the output. + + The named-entity classes extracted are persons, locations, organisations and miscellaneous.

This microservice automatically extracts structured information from unstructured text data such as chatlogs, emails, news articles, etc. + x-subscribelink: page_profiler_eng + version: '2.1.0' + servers: + - url: 'https://apis.sentient.io' + tags: + - name: "v2.1.0" + description: "Published Date - Oct 30, 2020" + paths: + /microservices/nlp/pageprofiler/v2/getpredictions: + post: + tags: + - v2.1.0 + responses: + '200': + description: success response + content: + application/json: + schema: + $ref: '#/components/schemas/success' + example: {"message":"SuccessfullyProcessed","results":{"loc":["Hubei","Singapore","SINGAPORE","China","Immigration"],"misc":["ICA.They"],"org":["ImmigrationandCheckpointsAuthority","ICA","LOA"]},"status":"Success"} + '401': + description: Unauthorized + content: + application/json: + schema: + $ref: '#/components/schemas/unauthorized' + '402': + description: Payment Required + content: + application/json: + schema: + $ref: '#/components/schemas/paymentrequired' + '403': + description: Forbidden + content: + application/json: + schema: + $ref: '#/components/schemas/forbidden' + '404': + description: Not Found + content: + application/json: + schema: + $ref: '#/components/schemas/notfound' + '419': + description: Not Found + content: + application/json: + schema: + $ref: '#/components/schemas/inputfieldmissing' + '420': + description: Not Found + content: + application/json: + schema: + $ref: '#/components/schemas/inputlimitexceeded' + '500': + description: Internal Server Error + content: + application/json: + schema: + $ref: '#/components/schemas/servererror' + '504': + description: Gateway Timeout + content: + application/json: + schema: + $ref: '#/components/schemas/gatewaytimeout' + security: + - APIAuthorizer: [] + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/input' + required: true + components: + schemas: + success: + type: object + properties: + results: + type: object + example: { "" } + description: Json Object of returned results + properties: + loc: + type: array + example: ["Nat","Sentient.io","Home","Inte","CONTACT","Join"] + description: "name of location found in the text string" + misc: + type: array + example: ["Sentient.io","English"] + description: "name of misc found in the text string" + org: + type: array + example: ["Our Clients","AI","APIs","Sentient.io","Our Technology Partners","Named Entity Recognition","Our Investors"] + description: "name of org found in the text string" + per: + type: array + example: ["Sentient.io","Speech","LinkedIn"] + description: "name of persons found in the text string" + message: + type: string + example: Successfully Processed + description: Detail description on the API status + status: + type: string + example: Success + description: The status of the API call success/failure + unauthorized: + type: object + properties: + message: + type: string + example: Missing Authentication Token + status: + type: string + example: Failure + forbidden: + type: object + properties: + message: + type: string + example: Access Denied Unauthorized User + status: + type: string + example: Failure + paymentrequired: + type: object + properties: + message: + type: string + example: Insufficient Credits Kindly Top Up + status: + type: string + example: Failure + notfound: + type: object + properties: + message: + type: string + example: Invalid Request URL + status: + type: string + example: Failure + servererror: + type: object + properties: + message: + type: string + example: Internal Server Error + status: + type: string + example: Failure + gatewaytimeout: + type: object + properties: + message: + type: string + example: Request Timeout + status: + type: string + example: Failure + inputfieldmissing: + type: object + properties: + message: + type: string + example: Input Field Missing + status: + type: string + example: Failure + inputlimitexceeded: + type: object + properties: + message: + type: string + example: Input Limit Exceeded + status: + type: string + example: Failure + versions: + type: object + properties: + v2.1.0: + type: array + items: + oneOf: + - type: string + example: Published Date - Oct 30, 2020 + description: Partial URL support + v2.0.0: + type: array + items: + oneOf: + - type: string + example: Published Date - Sep 30, 2020 + description: Standardizing Output JSON + v1.0.0: + type: array + items: + oneOf: + - type: string + example: Published Date - May 15, 2018 + description: Swap the NLP with Named-Entity Recognition ENG + v0.1.0: + type: array + items: + oneOf: + - type: string + example: Published Date - Apr 16, 2018 + description: Initial version release + input: + type: object + required: + - url + properties: + url: + x-name: url + type: string + default: true + example: https://www.sentient.io/en/ + description: |+ + The URL of the page to be profiled. + + Supported formats: ASCII only + securitySchemes: + APIAuthorizer: + type: apiKey + name: x-api-key + in: header + x-amazon-apigateway-authtype: custom + description: Authentication is done using the x-api-key in the request header diff --git a/yaml/page_profiler_jp.yaml b/yaml/page_profiler_jp.yaml index d8e159466..a880b8999 100644 --- a/yaml/page_profiler_jp.yaml +++ b/yaml/page_profiler_jp.yaml @@ -7,18 +7,18 @@ The named-entity classes extracted are persons, locations, organisations and miscellaneous. This microservice automatically extracts structured information from unstructured text data such as chatlogs, emails, news articles, etc. - version: '0.1' + version: '1.0.0' x-subscribelink: page_profiler_jp servers: - url: 'https://apis.sentient.io' tags: - - name: "v0.1" - description: "Published Date - Sep 30, 2020" + - name: "v1.0.0" + description: "Published Date - Oct 30, 2020" paths: /microservices/nlp/pageprofilerjp/v1/getpredictions: post: tags: - - v0.1 + - v1.0.0 responses: '200': description: success response @@ -215,7 +215,14 @@ versions: type: object properties: - v0.1: + v1.0.0: + type: array + items: + oneOf: + - type: string + example: Published Date - Oct 30, 2020 + description: Partial URL support + v0.1.0: type: array items: oneOf: @@ -233,7 +240,9 @@ default: true example: https://www.bbc.com/japanese description: |+ - The URL of the page to be profile. Kindly note that the URL has to be spelt in full, including "https://www." + The URL of the page to be profiled. + + Supported formats: ASCII only securitySchemes: APIAuthorizer: type: apiKey diff --git a/yaml/page_profiler_thai.yaml b/yaml/page_profiler_thai.yaml index e777d3bda..8204d9e9e 100644 --- a/yaml/page_profiler_thai.yaml +++ b/yaml/page_profiler_thai.yaml @@ -7,18 +7,18 @@ The named-entity classes extracted are persons, locations, organisations and miscellaneous. This microservice automatically extracts structured information from unstructured text data such as chatlogs, emails, news articles, etc. - version: '1.0' + version: '1.0.0' x-subscribelink: page_profiler_thai servers: - url: 'https://apis.sentient.io' tags: - - name: "v0.1" - description: "Published Date - Sep 30, 2020" + - name: "v1.0.0" + description: "Published Date - Oct 30, 2020" paths: /microservices/nlp/pageprofilerthai/v1/getpredictions: post: tags: - - v0.1 + - v1.0.0 responses: '200': description: success response @@ -227,7 +227,14 @@ versions: type: object properties: - v0.1: + v1.0.0: + type: array + items: + oneOf: + - type: string + example: Published Date - Oct 30, 2020 + description: Partial URL support + v0.1.0: type: array items: oneOf: @@ -243,9 +250,11 @@ x-name: url type: string default: true - example: https://www.komchadluek.net/ + example: https://www.naewna.com/entertain/527527 description: |+ - The URL of the page to be profile. Kindly note that the URL has to be spelt in full, including "https://www." + The URL of the page to be profiled. + + Supported formats: ASCII only securitySchemes: APIAuthorizer: type: apiKey diff --git a/yaml/pdf_extractor.yaml b/yaml/pdf_extractor.yaml index d2577bf29..92c52f143 100644 --- a/yaml/pdf_extractor.yaml +++ b/yaml/pdf_extractor.yaml @@ -5,22 +5,24 @@ info: This Utility microservice extracts the text content of the input PDF document with the options to extract specific pages. It also extracts from password-protected PDFs, if the correct password is provided. - + Output format supported: plain text or HTML. Supported languages: Hindi, German, Spanish, Portuguese, French, Turkish, Italian, Russian, Arabic, Indonesian, Chinese, Japanese and Korean. - version: '1.0' + + The size of your PDF file should **not exceed 7 MB**. + version: '1.0.0' x-subscribelink: pdf_extractor servers: - url: 'https://apis.sentient.io' tags: -- name: "v1.0" +- name: "v1.0.0" description: "Published Date - Jul 30, 2020" paths: /microservices/utility/pdfextractor/v1.0/getresults: post: tags: - - v1.0 + - v1.0.0 responses: '200': description: success response @@ -188,7 +190,7 @@ components: versions: type: object properties: - v1.0: + v1.0.0: type: array items: oneOf: @@ -204,25 +206,25 @@ components: type: string format: binary default: true - example: file upload - description: The file object Max. file size upto - 7MB. *Image pdf not supported + example: sample.pdf + description: Text-only PDF files are supported. Image or mixed PDF files are not recommended. pageNumbers: - type: integer + type: number default: false example: "1,3,6" description: Page numbers, example 1,3,6. Default all pages maxPages: - type: integer + type: number default: false example: "3" description: Maximum of page number. Default all pages startPage: - type: integer + type: number default: false example: "1" description: Starting page number, if used endPage parameter is mandatory endPage: - type: integer + type: number default: false example: "5" description: End of page number, if used startPage parameter is mandatory diff --git a/yaml/people_counting.yaml b/yaml/people_counting.yaml index 486b55b30..47f3e284b 100644 --- a/yaml/people_counting.yaml +++ b/yaml/people_counting.yaml @@ -5,18 +5,21 @@ info: This Computer Vision microservice tracks and counts people appearing in the input video. This microservice returns the number of people detected in that video, the likelihood of overestimation/underestimation, the first appearance and the duration and confidence of each person detected. - version: '0.1' + + The size of your image file should **not exceed 10 MB**, and the image dimension should be **least more than 416x416 pixels**. + + version: '0.1.0' x-subscribelink: people_counting servers: - url: 'https://apis.sentient.io' tags: -- name: "v0.1." +- name: "v0.1.0" description: "Published Date - Jul 30, 2020" paths: /microservices/cv/peoplecounting/v0.1/getpredictions: post: tags: - - v0.1. + - v0.1.0 responses: '200': @@ -196,7 +199,7 @@ components: versions: type: object properties: - v0.1: + v0.1.0: type: array items: oneOf: @@ -214,7 +217,9 @@ components: default: true example: UklGRkbiBABXQVZFZm10IBAAAAABA... description: |+ - Input video in base64 format + Input video in base64 format. + + Supported formats: acm, anm, apc, au, avi, bfi, bmp_pipe, bmv, codec2, dsf, dss, dvd, fifo, genh, gif, gxf, hls, iff, ifv, ipod, jpeg_pipe, jv, m4v, mjpeg, mlp, mlv, mov, mp2, mp3, mp4, pbm_pipe, pmp, png_pipe, psd_pipe, psp, rawvideo, sdp, sds, sdx, tmv, uncodedframecrc, vcd, vidc, vmd, voc, vpk, wav, webm, wsd, wsvqa, wtv, xmv, xpm_pipe. securitySchemes: APIAuthorizer: diff --git a/yaml/pki_key_generator.yaml b/yaml/pki_key_generator.yaml index cdc6ce57f..0cd6d51d6 100644 --- a/yaml/pki_key_generator.yaml +++ b/yaml/pki_key_generator.yaml @@ -3,18 +3,20 @@ info: title: PKI Key Generator description: |+ This Utiltiy microservice generates Public key and Private key pair, useful for encryption purposes. - version: '0.1' + + Do ensure that your text is **within 512 characters**. + version: '0.1.0' x-subscribelink: pki_key_generator servers: - url: 'https://apis.sentient.io' tags: -- name: "v0.1" +- name: "v0.1.0" description: "Published Date - Aug 30, 2019" paths: /microservices/utility/rsa_getkeys/v0.1/getresults: post: tags: - - v0.1 + - v0.1.0 responses: '200': description: success response @@ -174,7 +176,7 @@ components: versions: type: object properties: - v0.1: + v0.1.0: type: array items: oneOf: diff --git a/yaml/residential_sales_and_rental_hdb_sg.yaml b/yaml/residential_sales_and_rental_hdb_sg.yaml index 7f48fca70..b366c71b3 100644 --- a/yaml/residential_sales_and_rental_hdb_sg.yaml +++ b/yaml/residential_sales_and_rental_hdb_sg.yaml @@ -85,17 +85,17 @@ info: > filterdata = {"filter":[{"match_phrase": {"street":"bishan street 24"}},{"range": {"4room_sold":{"gte":1}}}]} - version: '0.1' + version: '0.1.0' servers: - url: 'https://api.sentient.io' tags: -- name: "v0.1" - description: "Published Date - Oct 10, 2019" +- name: "v0.1.0" + description: "Published Date - Nov 25, 2019" paths: /DaaS/prod/hdb/buildinginfo: get: tags: - - v0.1 + - v0.1.0 parameters: - in: query name: querystring @@ -241,11 +241,11 @@ components: description: Json Object of returned results properties: total: - type: integer + type: number example: 12150 description: Total number of records max_score: - type: integer + type: number example: 1 description: The highest score value hits: @@ -268,7 +268,7 @@ components: description: Document ID example: '750405' _score: - type: integer + type: number description: The document score for the search request example: 1 _source: @@ -281,59 +281,59 @@ components: description: Postal code example: '750405' year_completed: - type: integer + type: number description: Completed year of the Building example: 1999 total_dwelling_units: - type: integer + type: number description: Total Dwelling units example: 112 1room_sold: - type: integer + type: number description: No. of one room units sold example: 0 2room_sold: - type: integer + type: number description: No. of two room units sold example: 0 3room_sold: - type: integer + type: number description: No. of three room units sold example: 0 4room_sold: - type: integer + type: number description: No. of four room units sold example: 112 5room_sold: - type: integer + type: number description: No. of five room units sold example: 0 exec_sold: - type: integer + type: number description: No. of executive units sold example: 0 multigen_sold: - type: integer + type: number description: No. of multi generation units sold example: 0 studio_apartment_sold: - type: integer + type: number description: No. of studio units sold example: 0 1room_rental: - type: integer + type: number description: No. of one room units rented example: 0 2room_rental: - type: integer + type: number description: No. of two room units rented example: 0 3room_rental: - type: integer + type: number description: No. of three room units rented example: 0 other_room_rental: - type: integer + type: number description: No. of other units rented example: 0 block: @@ -464,12 +464,12 @@ components: versions: type: object properties: - v0.1: + v0.1.0: type: array items: oneOf: - type: string - example: Published Date - Oct 10,2019 + example: Published Date - Nov 25,2019 description: Initial version release securitySchemes: APIAuthorizer: diff --git a/yaml/script_alignment.yaml b/yaml/script_alignment.yaml index d5062c5e5..552d1423d 100644 --- a/yaml/script_alignment.yaml +++ b/yaml/script_alignment.yaml @@ -5,18 +5,20 @@ info: This NLP microservice aligns the input time-coded transcript with high-quality script. The output is the time-coded high-quality script. - version: '0.1' + + Do ensure that your text is within **5000 characters**. + version: '0.1.0' x-subscribelink: script_alignment servers: - url: 'https://apis.sentient.io' tags: -- name: "v0.1" - description: "Published Date - Jun 18, 2020" +- name: "v0.1.0" + description: "Published Date - Jun 05, 2020" paths: /microservices/nlp/scriptalignment/v0.1/getpredictions: post: tags: - - v0.1 + - v0.1.0 responses: '200': description: success response @@ -185,12 +187,12 @@ components: versions: type: object properties: - v0.1: + v0.1.0: type: array items: oneOf: - type: string - example: Published Date - Jun 18, 2020 + example: Published Date - Jun 05, 2020 description: Initial version release input: type: object @@ -204,7 +206,9 @@ components: default: true example: ["Hello World, This is a test. This is another test."] description: |+ - An ordered array of text. Each element contains a line of the script. + An ordered array of text. Each element contains a line of the script. + + Supported formats: ASCII only transcript: x-name: transcript type: array @@ -218,14 +222,14 @@ components: properties: seqNum: x-name: seqNum - type: integer + type: number default: true example: 1 description: |+ Running sequence. Start from 1. start: x-name: start - type: integer + type: number format: float default: true example: 1.0 @@ -233,7 +237,7 @@ components: Start time of utterance, in seconds. Offset from the start of stream. end: x-name: end - type: integer + type: number format: float default: true example: 4.0 diff --git a/yaml/script_alignment_v1.0.yaml b/yaml/script_alignment_v1.0.yaml new file mode 100644 index 000000000..14e273408 --- /dev/null +++ b/yaml/script_alignment_v1.0.yaml @@ -0,0 +1,284 @@ +openapi: 3.0.1 +info: + title: Script Alignment + description: |+ + This NLP microservice aligns the input time-coded transcript with high-quality script. + + The output is the time-coded high-quality script. + + Do ensure that your text is within **5000 characters**. + version: '1.0.0' + x-subscribelink: script_alignment +servers: + - url: 'https://apis.sentient.io' +tags: +- name: "v1.0.0" + description: "Published Date - Oct 30, 2020" +paths: + /microservices/nlp/scriptalignment/v1/getpredictions: + post: + tags: + - v1.0.0 + responses: + '200': + description: success response + content: + application/json: + schema: + $ref: '#/components/schemas/success' + example: + results: + output: + [{"end": 4,"seqNum": 1,"start": 1,"text": "Hello World"},{"end": 8.2,"seqNum": 2,"start": 4.92,"text": "This is a test"},{"end": 12.04,"seqNum": 3,"start": 8.88,"text": "This is another test"}] + message: Successfully Processed + status: Success + '401': + description: Unauthorized + content: + application/json: + schema: + $ref: '#/components/schemas/unauthorized' + '402': + description: Payment Required + content: + application/json: + schema: + $ref: '#/components/schemas/paymentrequired' + '403': + description: Forbidden + content: + application/json: + schema: + $ref: '#/components/schemas/forbidden' + '404': + description: Not Found + content: + application/json: + schema: + $ref: '#/components/schemas/notfound' + '419': + description: Input Field Missing + content: + application/json: + schema: + $ref: '#/components/schemas/inputfieldmissing' + '420': + description: Input Limit Exceeded + content: + application/json: + schema: + $ref: '#/components/schemas/inputlimitexceeded' + '500': + description: Internal Server Error + content: + application/json: + schema: + $ref: '#/components/schemas/servererror' + '504': + description: Gateway Timeout + content: + application/json: + schema: + $ref: '#/components/schemas/gatewaytimeout' + security: + - APIAuthorizer: [] + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/input' + required: true +components: + schemas: + success: + type: object + properties: + results: + type: object + description: The result of the API call. + example: { "" } + properties: + output: + type: array + example: [{"end": 4,"seqNum": 1,"start": 1,"text": "Hello World"},{"end": 8.2,"seqNum": 2,"start": 4.92,"text": "This is a test"},{"end": 12.04,"seqNum": 3,"start": 8.88,"text": "This is another test"}] + description: The time-coded high-quality script + items: + oneOf: + - type: object + properties: + end: + type: string + example: 4 + description: End time of word, in seconds. Offset from the start of stream. + seqNum: + type: integer + example: 1 + description: Running sequence. Start from 1. + start: + type: string + example: 1 + description: Start time of word, in seconds. Offset from the start of stream. + text: + type: string + example: Hello World + description: Content of the utterance. + message: + type: string + example: Successfully Processed + description: Detail description on the API status + status: + type: string + example: Success + description: The status of the API call success/failure + unauthorized: + type: object + properties: + message: + type: string + example: Missing Authentication Token + status: + type: string + example: Failure + forbidden: + type: object + properties: + message: + type: string + example: Access Denied Unauthorized User + status: + type: string + example: Failure + paymentrequired: + type: object + properties: + message: + type: string + example: Insufficient Credits Kindly Top Up + status: + type: string + example: Failure + notfound: + type: object + properties: + message: + type: string + example: Invalid Request URL + status: + type: string + example: Failure + servererror: + type: object + properties: + message: + type: string + example: Internal Server Error + status: + type: string + example: Failure + gatewaytimeout: + type: object + properties: + message: + type: string + example: Request Timeout + status: + type: string + example: Failure + inputfieldmissing: + type: object + properties: + message: + type: string + example: Input Field Missing + status: + type: string + example: Failure + inputlimitexceeded: + type: object + properties: + message: + type: string + example: Input Limit Exceeded + status: + type: string + example: Failure + versions: + type: object + properties: + v1.0.0: + type: array + items: + oneOf: + - type: string + example: Published Date - Oct 30,2020 + description: Standardizing Output JSON + v0.1.0: + type: array + items: + oneOf: + - type: string + example: Published Date - Jun 05, 2020 + description: Initial version release + input: + type: object + required: + - script + - transcript + properties: + script: + x-name: script + type: array + default: true + example: ["Hello World, This is a test. This is another test."] + description: |+ + An ordered array of text. Each element contains a line of the script. + + Supported formats: ASCII only + transcript: + x-name: transcript + type: array + default: true + example: [{"seqNum":1,"start":1.0,"end":4.0,"text":"HELLO WORLD"}] + description: |+ + An ordered array of utterance struct. + items: + oneOf: + - type: object + properties: + seqNum: + x-name: seqNum + type: number + default: true + example: 1 + description: |+ + Running sequence. Start from 1. + start: + x-name: start + type: number + format: float + default: true + example: 1.0 + description: |+ + Start time of utterance, in seconds. Offset from the start of stream. + end: + x-name: end + type: number + format: float + default: true + example: 4.0 + description: |+ + End time of utterance, in seconds. Offset from the end of stream. + text: + x-name: text + type: string + default: true + example: HELLO WORLD + description: |+ + Content of the utterance. + securitySchemes: + APIAuthorizer: + type: apiKey + name: x-api-key + in: header + x-amazon-apigateway-authtype: custom + description: Authentication is done using the x-api-key in the request header diff --git a/yaml/season_parking_availability_hdb_sg.yaml b/yaml/season_parking_availability_hdb_sg.yaml index 01f33d074..aab96bd73 100644 --- a/yaml/season_parking_availability_hdb_sg.yaml +++ b/yaml/season_parking_availability_hdb_sg.yaml @@ -89,17 +89,17 @@ info: > filterdata = {"filter":[{"match":{"street":"serangoon north avenue 4"}},{"match":{"block":"503"}},{"match":{"vehicle_type":"H"}}]} - version: '0.1' + version: '0.1.0' servers: - url: 'https://api.sentient.io' tags: -- name: "v0.1" - description: "Published Date - Oct 10, 2019" +- name: "v0.1.0" + description: "Published Date - May 15, 2020" paths: /DaaS/prod/hdb/carparkavailability: get: tags: - - v0.1 + - v0.1.0 parameters: - in: query name: querystring @@ -235,11 +235,11 @@ components: description: Json Object of returned results properties: total: - type: integer + type: number example: 1 description: Total number of records max_score: - type: integer + type: number example: 13.663734 description: The highest score value hits: @@ -258,7 +258,7 @@ components: description: Document ID example: "AM/G40/Y/552506" _score: - type: integer + type: number description: The document score for the search request example: 13.663734 _source: @@ -285,7 +285,7 @@ components: S - Season (Car) example: "Y" car_park_availability: - type: integer + type: number description: Car Park Availability example: 15 postalcode: @@ -420,12 +420,12 @@ components: versions: type: object properties: - v0.1: + v0.1.0: type: array items: oneOf: - type: string - example: Published Date - Oct 10,2019 + example: Published Date - May 15,2020 description: Initial version release securitySchemes: APIAuthorizer: diff --git a/yaml/sentiment-analysis-aws.yaml b/yaml/sentiment-analysis-aws.yaml index abcf2de1c..4644772d0 100644 --- a/yaml/sentiment-analysis-aws.yaml +++ b/yaml/sentiment-analysis-aws.yaml @@ -3,14 +3,14 @@ info: title: Sentiment Analysis AWS description: >- The sentiment analysis will help to determine the expressed emotional state of person by using natural language processing to analyse a range of parameters, including tone of voice, choice of words.

This is a passthrough to AWS’s sentiment analyser. - version: '1.0' + version: '0.1.0' servers: - url: 'https://api.sentient.io' paths: /sentimentanalysis/prod/awssa: post: tags: - - v0.1 + - v0.1.0 responses: '200': description: success response @@ -168,4 +168,4 @@ components: type: apiKey name: x-api-key in: header - x-amazon-apigateway-authtype: custom \ No newline at end of file + x-amazon-apigateway-authtype: custom diff --git a/yaml/sentiment-analysis-google.yaml b/yaml/sentiment-analysis-google.yaml index cb66b4eb2..d55a210b5 100644 --- a/yaml/sentiment-analysis-google.yaml +++ b/yaml/sentiment-analysis-google.yaml @@ -3,14 +3,14 @@ info: title: Sentiment Analysis Google description: >- The sentiment analysis will help to determine the expressed emotional state of person by using natural language processing to analyse a range of parameters, including tone of voice, choice of words.

This is a passthrough to Google’s sentiment analyser. - version: '1.0' + version: '0.1.0' servers: - url: 'https://api.sentient.io' paths: /sentimentanalysis/prod/googlesa: post: tags: - - v0.1 + - v0.1.0 responses: '200': description: success response @@ -173,4 +173,4 @@ components: type: apiKey name: x-api-key in: header - x-amazon-apigateway-authtype: custom \ No newline at end of file + x-amazon-apigateway-authtype: custom diff --git a/yaml/spacy_named-entity_recognition_eng.yaml b/yaml/spacy_named-entity_recognition_eng.yaml index 22df577fc..9867b6942 100644 --- a/yaml/spacy_named-entity_recognition_eng.yaml +++ b/yaml/spacy_named-entity_recognition_eng.yaml @@ -7,18 +7,21 @@ info: The named-entity classes extracted include persons, nationalities, religious groups, political groups, buildings and facilities, organisations, geopolitical, locations, products, events, works of art, laws, languages, dates and time, percentages, monetary values, quantities, ordinals and cardinals. This microservice automatically extracts structured information from unstructured text data such as chatlogs, emails, news articles, etc. - version: '0.1' + + Do ensure that your text is **within 5000 characters**. + + version: '0.1.0' x-subscribelink: spacy_ner servers: - url: 'https://apis.sentient.io' tags: -- name: "v0.1" +- name: "v0.1.0" description: "Published Date - Sep 30, 2020" paths: /microservices/nlp/spacyner/v1/getpredictions: post: tags: - - v0.1 + - v0.1.0 responses: '200': description: success response @@ -270,7 +273,7 @@ components: versions: type: object properties: - v0.1: + v0.1.0: type: array items: oneOf: diff --git a/yaml/taxonomy_matcher_eng.yaml b/yaml/taxonomy_matcher_eng.yaml index 083a8ba82..fd69b5241 100644 --- a/yaml/taxonomy_matcher_eng.yaml +++ b/yaml/taxonomy_matcher_eng.yaml @@ -7,18 +7,20 @@ info: The full taxonomy consists of major categories (for e.g. retail, cars, etc.). Each category is stored as a separate taxonomy tree within the Taxonomy instance. Each node in a taxonomy tree is identified using a node_id. It has attributes: name (a human readable string), level (how far it is from the root node) and type (whether it is a root node, leaf node or body node). This microservice can help identify the types of concept that are frequently mentioned in an article. - version: '0.1' + + Do ensure that your text is within **5000 characters**. + version: '0.1.0' x-subscribelink: taxonomy_matcher_eng servers: - url: 'https://apis.sentient.io' tags: -- name: "v0.1" - description: "Published Date - Dec 27, 2019" +- name: "v0.1.0" + description: "Published Date - Jan 24, 2020" paths: /microservices/nlp/taxonomy/v0.1/getpredictions: post: tags: - - v0.1 + - v0.1.0 responses: '200': description: success response @@ -176,12 +178,12 @@ components: versions: type: object properties: - v0.1: + v0.1.0: type: array items: oneOf: - type: string - example: Published Date - Dec 27, 2019 + example: Published Date - Jan 24, 2020 description: Initial version release input: type: object @@ -195,9 +197,11 @@ components: example: ["bus","cars","bike","train","buildings","Audi R8"] description: |+ A list of object names to be classified. Up to a maximum of 20 search terms can be processed each time. + + Supported formats: ASCII only threshold: x-name: threshold - type: integer + type: number default: true example: 1 description: |+ diff --git a/yaml/taxonomy_matcher_eng_v1.0.yaml b/yaml/taxonomy_matcher_eng_v1.0.yaml new file mode 100644 index 000000000..3dcad2387 --- /dev/null +++ b/yaml/taxonomy_matcher_eng_v1.0.yaml @@ -0,0 +1,238 @@ +openapi: 3.0.1 +info: + title: Taxonomy Matcher ENG + description: |+ + This NLP microservice matches the input word with the name of a leaf nodes in the predefined English taxonomy. The entire branch from the matched leaf node to the root of the corresponding taxonomy tree is returned. + + The full taxonomy consists of major categories (for e.g. retail, cars, etc.). Each category is stored as a separate taxonomy tree within the Taxonomy instance. Each node in a taxonomy tree is identified using a node_id. It has attributes: name (a human readable string), level (how far it is from the root node) and type (whether it is a root node, leaf node or body node). + + This microservice can help identify the types of concept that are frequently mentioned in an article. + + Do ensure that your text is within **5000 characters**. + version: '1.0.0' + x-subscribelink: taxonomy_matcher_eng +servers: + - url: 'https://apis.sentient.io' +tags: +- name: "v1.0.0" + description: "Published Date - Oct 30, 2020" +paths: + /microservices/nlp/taxonomy/v1/getpredictions: + post: + tags: + - v1.0.0 + responses: + '200': + description: success response + content: + application/json: + schema: + $ref: '#/components/schemas/success' + example: + results: + bus: + - + - careers/job by industry/travel/bus + - 1 + - + - news/business news/travel/bus + - 1 + message: Successfully Processed + status: Success + + '401': + description: Unauthorized + content: + application/json: + schema: + $ref: '#/components/schemas/unauthorized' + '402': + description: Payment Required + content: + application/json: + schema: + $ref: '#/components/schemas/paymentrequired' + '403': + description: Forbidden + content: + application/json: + schema: + $ref: '#/components/schemas/forbidden' + '404': + description: Not Found + content: + application/json: + schema: + $ref: '#/components/schemas/notfound' + '419': + description: Input Field Missing + content: + application/json: + schema: + $ref: '#/components/schemas/inputfieldmissing' + '420': + description: Input Limit Exceeded + content: + application/json: + schema: + $ref: '#/components/schemas/inputlimitexceeded' + '500': + description: Internal Server Error + content: + application/json: + schema: + $ref: '#/components/schemas/servererror' + '504': + description: Gateway Timeout + content: + application/json: + schema: + $ref: '#/components/schemas/gatewaytimeout' + security: + - APIAuthorizer: [] + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/input' + required: true +components: + schemas: + success: + type: object + properties: + results: + type: object + description: The result of the API call. + example: { "" } + properties: + : + type: array + example: [["news/sport/swimming/bike",1]] + description: List of taxonomy for the requested object name + message: + type: string + example: Successfully Processed + description: Detail description on the API status + status: + type: string + example: Success + description: The status of the API call success/failure + unauthorized: + type: object + properties: + message: + type: string + example: Missing Authentication Token + status: + type: string + example: Failure + forbidden: + type: object + properties: + message: + type: string + example: Access Denied Unauthorized User + status: + type: string + example: Failure + paymentrequired: + type: object + properties: + message: + type: string + example: Insufficient Credits Kindly Top Up + status: + type: string + example: Failure + notfound: + type: object + properties: + message: + type: string + example: Invalid Request URL + status: + type: string + example: Failure + servererror: + type: object + properties: + message: + type: string + example: Internal Server Error + status: + type: string + example: Failure + gatewaytimeout: + type: object + properties: + message: + type: string + example: Request Timeout + status: + type: string + example: Failure + inputfieldmissing: + type: object + properties: + message: + type: string + example: Input Field Missing + status: + type: string + example: Failure + inputlimitexceeded: + type: object + properties: + message: + type: string + example: Input Limit Exceeded + status: + type: string + example: Failure + + versions: + type: object + properties: + v1.0.0: + type: array + items: + oneOf: + - type: string + example: Published Date - Oct 30,2020 + description: Standardizing Output JSON + v0.1.0: + type: array + items: + oneOf: + - type: string + example: Published Date - Jan 24, 2020 + description: Initial version release + input: + type: object + required: + - text + properties: + text: + x-name: text + type: array + default: true + example: ["bus","cars","bike","train","buildings","Audi R8"] + description: |+ + A list of object names to be classified. Up to a maximum of 20 search terms can be processed each time. + + Supported formats: ASCII only + threshold: + x-name: threshold + type: number + default: true + example: 1 + description: |+ + The "threshold" specifies the level of similarity that the search term must match with terms in the taxonomy tree. Values range between 0.0 and 1.0 .It is optional. The default value is 1 (which means an exact match is required). Lowering the threshold will allow matches that are similar but not identical. + securitySchemes: + APIAuthorizer: + type: apiKey + name: x-api-key + in: header + x-amazon-apigateway-authtype: custom + description: Authentication is done using the x-api-key in the request header diff --git a/yaml/text-to-speech_chi.yaml b/yaml/text-to-speech_chi.yaml index 13ff270e0..02f76c99d 100644 --- a/yaml/text-to-speech_chi.yaml +++ b/yaml/text-to-speech_chi.yaml @@ -5,18 +5,20 @@ info: This Voice microservice converts Mandarin text into speech in a female voice. The Text-to-Speech AI generated synthesized voice speaks with native Mandarin accent. - version: '0.1' + + Do ensure that your text is **within 750 characters**. + version: '0.1.0' x-subscribelink: text-to-speech_chi servers: - url: 'https://apis.sentient.io' tags: -- name: "v0.1" - description: "Published Date - Oct 01, 2018" +- name: "v0.1.0" + description: "Published Date - Sep 28, 2018" paths: /microservices/voice/ttssch/v0.1/getpredictions: post: tags: - - v0.1 + - v0.1.0 responses: '200': description: success response @@ -176,12 +178,12 @@ components: versions: type: object properties: - v0.1: + v0.1.0: type: array items: oneOf: - type: string - example: Published Date - Oct 01,2018 + example: Published Date - Sep 28,2018 description: Initial version release input: type: object diff --git a/yaml/text-to-speech_eng.yaml b/yaml/text-to-speech_eng.yaml index cbac86510..a69b2cb03 100644 --- a/yaml/text-to-speech_eng.yaml +++ b/yaml/text-to-speech_eng.yaml @@ -1,22 +1,24 @@ openapi: 3.0.1 info: title: Text-To-Speech ENG - description: |+ + description: | "This Voice microservice converts English text into speech in a female voice. - + The Text-to-Speech AI generated synthesized voice speaks with Singapore English accent. - version: '0.1' + + Do ensure that your text is within **2000 characters**. + version: '0.1.0' x-subscribelink: text-to-speech_eng servers: - url: 'https://apis.sentient.io' tags: -- name: "v0.1" - description: "Published Date - Oct 01, 2018" + - name: v0.1.0 + description: 'Published Date - Sep 28, 2018' paths: /microservices/voice/ttseng/v0.1/getpredictions: post: tags: - - v0.1 + - v0.1.0 responses: '200': description: success response @@ -24,7 +26,7 @@ paths: application/json: schema: $ref: '#/components/schemas/success' - example: + example: audioContent: UklGRiQAAABXQVZFZm10IBAAAAABAAEAgD4AAAB9AAACABAAZGF0YQAAAAA= message: Successfully Processed status: Success @@ -63,7 +65,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/inputlimitexceeded' + $ref: '#/components/schemas/inputlimitexceeded' '500': description: Internal Server Error content: @@ -84,6 +86,123 @@ paths: schema: $ref: '#/components/schemas/input' required: true + x-codeSamples: + - lang: Python + Python3 + source: |- + import http.client + + conn = http.client.HTTPSConnection("apis.sentient.io") + + payload = "{\"text\":\"Testing microservice\"}" + + headers = { + 'content-type': "application/json", + 'x-api-key': "REPLACE_KEY_VALUE" + } + + conn.request("POST", "/microservices/voice/ttseng/v0.1/getpredictions", payload, headers) + + res = conn.getresponse() + data = res.read() + + print(data.decode("utf-8")) + - lang: Csharp + Restsharp + source: |- + var client = new RestClient("https://apis.sentient.io/microservices/voice/ttseng/v0.1/getpredictions"); + var request = new RestRequest(Method.POST); + request.AddHeader("content-type", "application/json"); + request.AddHeader("x-api-key", "REPLACE_KEY_VALUE"); + request.AddParameter("application/json", "{\"text\":\"Testing microservice\"}", ParameterType.RequestBody); + IRestResponse response = client.Execute(request); + - lang: Go + Native + source: "package main\n\nimport (\n\t\"fmt\"\n\t\"strings\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://apis.sentient.io/microservices/voice/ttseng/v0.1/getpredictions\"\n\n\tpayload := strings.NewReader(\"{\\\"text\\\":\\\"Testing microservice\\\"}\")\n\n\treq, _ := http.NewRequest(\"POST\", url, payload)\n\n\treq.Header.Add(\"content-type\", \"application/json\")\n\treq.Header.Add(\"x-api-key\", \"REPLACE_KEY_VALUE\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}" + - lang: Java + Unirest + source: |- + HttpResponse response = Unirest.post("https://apis.sentient.io/microservices/voice/ttseng/v0.1/getpredictions") + .header("content-type", "application/json") + .header("x-api-key", "REPLACE_KEY_VALUE") + .body("{\"text\":\"Testing microservice\"}") + .asString(); + - lang: Node + Native + source: |- + const http = require("https"); + + const options = { + "method": "POST", + "hostname": "apis.sentient.io", + "port": null, + "path": "/microservices/voice/ttseng/v0.1/getpredictions", + "headers": { + "content-type": "application/json", + "x-api-key": "REPLACE_KEY_VALUE" + } + }; + + const req = http.request(options, function (res) { + const chunks = []; + + res.on("data", function (chunk) { + chunks.push(chunk); + }); + + res.on("end", function () { + const body = Buffer.concat(chunks); + console.log(body.toString()); + }); + }); + + req.write(JSON.stringify({text: 'Testing microservice'})); + req.end(); + - lang: Php + Curl + source: |- + "https://apis.sentient.io/microservices/voice/ttseng/v0.1/getpredictions", + CURLOPT_RETURNTRANSFER => true, + CURLOPT_ENCODING => "", + CURLOPT_MAXREDIRS => 10, + CURLOPT_TIMEOUT => 30, + CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, + CURLOPT_CUSTOMREQUEST => "POST", + CURLOPT_POSTFIELDS => "{\"text\":\"Testing microservice\"}", + CURLOPT_HTTPHEADER => [ + "content-type: application/json", + "x-api-key: REPLACE_KEY_VALUE" + ], + ]); + + $response = curl_exec($curl); + $err = curl_error($curl); + + curl_close($curl); + + if ($err) { + echo "cURL Error #:" . $err; + } else { + echo $response; + } + - lang: Ruby + Native + source: |- + require 'uri' + require 'net/http' + require 'openssl' + + url = URI("https://apis.sentient.io/microservices/voice/ttseng/v0.1/getpredictions") + + http = Net::HTTP.new(url.host, url.port) + http.use_ssl = true + http.verify_mode = OpenSSL::SSL::VERIFY_NONE + + request = Net::HTTP::Post.new(url) + request["content-type"] = 'application/json' + request["x-api-key"] = 'REPLACE_KEY_VALUE' + request.body = "{\"text\":\"Testing microservice\"}" + + response = http.request(request) + puts response.read_body components: schemas: success: @@ -172,17 +291,17 @@ components: example: Input Limit Exceeded status: type: string - example: Failure + example: Failure versions: type: object - properties: - v0.1: - type: array - items: - oneOf: - - type: string - example: Published Date - Oct 01,2018 - description: Initial version release + properties: + v0.1.0: + type: array + items: + oneOf: + - type: string + example: 'Published Date - Sep 28,2018' + description: Initial version release input: type: object required: @@ -193,7 +312,7 @@ components: type: string default: true example: Testing microservice - description: |+ + description: | Input text securitySchemes: APIAuthorizer: diff --git a/yaml/urls_retrieval.yaml b/yaml/urls_retrieval.yaml index cd624ac65..116c5f189 100644 --- a/yaml/urls_retrieval.yaml +++ b/yaml/urls_retrieval.yaml @@ -3,18 +3,18 @@ info: title: URLs Retrieval description: |+ This Utility microservice crawls and retrieves their content from the input URLs, up to the specified depth. - version: '0.1' + version: '0.2.0' x-subscribelink: urls_retrieval servers: - url: 'https://apis.sentient.io' tags: -- name: "v0.1" - description: "Published Date - Jun 18, 2018" +- name: "v0.2.0" + description: "Published Date - Oct 30, 2020" paths: - /microservices/utility/crawlurls/v0.1/getresults: + /microservices/utility/crawlurls/v0/getresults: post: tags: - - v0.1 + - v0.2.0 responses: '200': description: success response @@ -203,12 +203,19 @@ components: versions: type: object properties: - v0.1: + v0.2.0: type: array items: oneOf: - type: string - example: Published Date - Jun 18, 2018 + example: Published Date - Oct 30, 2020 + description: Partial URL support + v0.1.0: + type: array + items: + oneOf: + - type: string + example: Published Date - Sep 1, 2020 description: Initial version release input: type: object diff --git a/yaml/video-to-audio_convertor.yaml b/yaml/video-to-audio_convertor.yaml index d370865ad..bf64675d3 100644 --- a/yaml/video-to-audio_convertor.yaml +++ b/yaml/video-to-audio_convertor.yaml @@ -3,18 +3,20 @@ info: title: Video-To-Audio Converter description: |+ This API is used to extract the sound from a video file and save it in an audio file. - version: '0.1' + + The size of your video file should **not exceed 3.5 MB**. + version: '0.1.0' x-subscribelink: video-to-audio_convertor servers: - url: 'https://apis.sentient.io' tags: -- name: "v0.1" - description: "Published Date - Feb 10, 2020" +- name: "v0.1.0" + description: "Published Date - Mar 06, 2020" paths: /microservices/utility/videotoaudio/v0.1/getresults: post: tags: - - v0.1 + - v0.1.0 responses: '200': description: success response @@ -186,9 +188,10 @@ components: filePath: type: string format: binary - example: upload file + example: sample.mp4 default: true - description: The file object. Maximum file size up to - 3.5MB + description: The file object. + Supported formats: 3g2, avi, flv, mkv, mov, mp4, ogv, webm, wmv, m4v. samplerate: type: string example: "16000" @@ -202,12 +205,12 @@ components: versions: type: object properties: - v0.1: + v0.1.0: type: array items: oneOf: - type: string - example: Published Date - Feb 10, 2020 + example: Published Date - Mar 06, 2020 description: Initial version release securitySchemes: APIAuthorizer: diff --git a/yaml/video-to-image_convertor.yaml b/yaml/video-to-image_convertor.yaml index 18a180761..7b98a1bc9 100644 --- a/yaml/video-to-image_convertor.yaml +++ b/yaml/video-to-image_convertor.yaml @@ -4,19 +4,19 @@ info: description: |+ This Utility microservice captures the images from the input video file at frame rate of 1 frame per second. - Supported formats are : 3g2, avi, flv, mkv, mov, mp4, ogv, webm, wmv, m4v with H.264 codec encoded. - version: '0.1' + The size of your video file should **not exceed 10 MB**. + version: '0.1.0' x-subscribelink: video-to-image_convertor servers: - url: 'https://apis.sentient.io' tags: -- name: "v0.1" - description: "Published Date - Aug 04, 2020" +- name: "v0.1.0" + description: "Published Date - Aug 07, 2020" paths: /microservices/utility/videotoimage/v0.1/getresults: post: tags: - - v0.1 + - v0.1.0 responses: '200': description: success response @@ -193,12 +193,12 @@ components: versions: type: object properties: - v0.1: + v0.1.0: type: array items: oneOf: - type: string - example: Published Date - Aug 04, 2020 + example: Published Date - Aug 07, 2020 description: Initial version release input: type: object @@ -209,8 +209,10 @@ components: type: string format: binary default: true - example: upload file - description: The Video file object. Maximum file size up to 10 MB + example: sample.mp4 + description: The Video file object. + + Supported formats are : 3g2, avi, flv, mkv, mov, mp4, ogv, webm, wmv, m4v with H.264 codec encoded. securitySchemes: APIAuthorizer: type: apiKey diff --git a/yaml/voice_activity_detection_eng.yaml b/yaml/voice_activity_detection_eng.yaml index c7f681f46..14163aa52 100644 --- a/yaml/voice_activity_detection_eng.yaml +++ b/yaml/voice_activity_detection_eng.yaml @@ -5,18 +5,18 @@ info: This Voice microservice detects utterances in the input audio and outputs the start and end time of these utterances. An utterance is the smallest unit of speech. It is a continuous piece of speech beginning and ending with a clear pause. - version: '0.1' + version: '0.1.0' x-subscribelink: voice_activity_detection_eng servers: - url: 'https://apis.sentient.io' tags: -- name: "v0.1" - description: "Published Date - July 3, 2020" +- name: "v0.1.0" + description: "Published Date - Jul 03, 2020" paths: /microservices/voice/vad/v0.1/getpredictions: post: tags: - - v0.1 + - v0.1.0 responses: '200': description: success response @@ -97,16 +97,16 @@ components: - type: object properties: end: - type: integer + type: number format: float example: 23.72 description: End time of utterance, in seconds. Offset from the start of stream. seqNum: - type: integer + type: number example: 1 description: Running sequence. Starts from 1. start: - type: integer + type: number format: float example: 0.64 description: Start time of utterance, in seconds. Offset from the start of stream. @@ -196,7 +196,7 @@ components: Required. Input audio file in base64 format threshold: x-name: threshold - type: integer + type: number format: float default: false example: 0.2 @@ -205,7 +205,7 @@ components: versions: type: object properties: - v0.1: + v0.1.0: type: array items: oneOf: diff --git a/yaml/web_scraper.yaml b/yaml/web_scraper.yaml index f6ab43322..83870a30a 100644 --- a/yaml/web_scraper.yaml +++ b/yaml/web_scraper.yaml @@ -3,8 +3,8 @@ info: title: Web Scraper x-subscribelink: web_scraper description: |+ - This API is used to extract content or specific HTML elements from web pages. Supports both HTML and Text output. The web scraper can be instructed to extract HTML elements that match the criteria given in the queryList HTTP request parameter, it can even do navigate down the html tree like get all p tag inside a div class "class":"class_name p" - x-description2: |+ + This API is used to extract content or specific HTML elements from web pages. Supports both HTML and Text output. The web scraper can be instructed to extract HTML elements that match the criteria given in the queryList HTTP request parameter, it can even do navigate down the html tree like get all p tag inside a div class "class":"class_name p". + x-additionalinfo: |+ Examples: To get article content, as text @@ -25,44 +25,44 @@ info: Returns all links/text/html/images matches the class name: queryList:[{"findType":"find_all", "class":,"tag":"a", "attribute":"href"}],{"findType":"find_all", "class":, "tag":"a"},{"findType":"find_all", "class":, "tag":"a", "returnType":"html"},{"findType":"find_all", "class":, "tag":"img", "attribute":"src"}] - Using select in findType, either class/tag/id/nestedclassid is mandatory: + Using select in findType, either class/tag/id/nestedClassId is mandatory: queryList:[{"findType":"select", "class_":, "tag":}] queryList:[{"findType":"select", "class_":}] queryList:[{"findType":"select", "tag":}] queryList:[{"findType":"select", "id":, "tag":}] queryList:[{"findType":"select", "id":}] queryList:[{"findType":"select", "tag":}] - queryList:[{"findType":"select", "nestedclassid":}] - queryList:[{"findType":"select", "nestedclassid":, "returnType":"html"}] - queryList:[{"findType":"select", "nestedclassid":, "attribute":"href"}] - Example using nestedclassid:
<div>
   <h1>This is heading</h1>>
   <p class="strikeout">This is paragraph 1</h1>>
   <p class="strikeout">This is paragraph 2</h1>>
   <p class="strikeout">This is paragraph 3</h1>>
</div>
<div id="div2" class="divclass2">
   <h1>This is another heading 2</h1>>
   <p class="strikeout">This is paragraph 4</p>
   <p class="strikeout">This is paragraph 5</p>
   <p class="strikeout">This is paragraph 6</p>
   <ul>
      <li><a href="      <li class="class3"><a href="      <li><a href="   </ul>
</div>

To get tags that match one or more class names
   "queryList":[{"findType":"select", "nestedclassid":"p.strikeout"}] + queryList:[{"findType":"select", "nestedClassId":}] + queryList:[{"findType":"select", "nestedClassId":, "returnType":"html"}] + queryList:[{"findType":"select", "nestedClassId":, "attribute":"href"}] + Example using nestedClassId:
<div>
   <h1>This is heading</h1>>
   <p class="strikeout">This is paragraph 1</h1>>
   <p class="strikeout">This is paragraph 2</h1>>
   <p class="strikeout">This is paragraph 3</h1>>
</div>
<div id="div2" class="divclass2">
   <h1>This is another heading 2</h1>>
   <p class="strikeout">This is paragraph 4</p>
   <p class="strikeout">This is paragraph 5</p>
   <p class="strikeout">This is paragraph 6</p>
   <ul>
      <li><a href="      <li class="class3"><a href="      <li><a href="   </ul>
</div>

To get tags that match one or more class names
   "queryList":[{"findType":"select", "nestedClassId":"p.strikeout"}] To get h1 tags that match one or more class names -    "queryList":[{"findType":"select", "nestedclassid":"h1"}] +    "queryList":[{"findType":"select", "nestedClassId":"h1"}] To get all p tags that matches element id -    "queryList":[{"findType":"select", "nestedclassid":"div#div2 p"}] - To get all litags that matches the element id
   "queryList":[{"findType":"select", "nestedclassid":"div#div2 ul li"}]
To get links from ul list -    "queryList":[{"findType":"select", "nestedclassid":"ul li a"}] - To get links from ul list that matches one or more class names
   "queryList":[{"findType":"select", "nestedclassid":"ul li.class3 a"}] - To get links a element that matches the element id and class name
   "queryList":[{"findType":"select", "nestedclassid":"div#div2 ul li.class3 a"}] +    "queryList":[{"findType":"select", "nestedClassId":"div#div2 p"}] + To get all litags that matches the element id
   "queryList":[{"findType":"select", "nestedClassId":"div#div2 ul li"}]
To get links from ul list +    "queryList":[{"findType":"select", "nestedClassId":"ul li a"}] + To get links from ul list that matches one or more class names
   "queryList":[{"findType":"select", "nestedClassId":"ul li.class3 a"}] + To get links a element that matches the element id and class name
   "queryList":[{"findType":"select", "nestedClassId":"div#div2 ul li.class3 a"}] Notes: title - is an optional parameter, if title is empty the return json key is "values"
findType - find/find_all/select    • find - returns first matching possibility
   • find_all - returns all matching possibilities -    • select - If you want to search for tags that match two or more CSS classes. either class/tag/id/nestedclassid is mandatory - **return type is not supported alone with attribute. +    • select - If you want to search for tags that match two or more CSS classes. either nestedClassId is mandatory + **returnType is not supported with attribute. The results are returned in JSON format and allow for developers to rapidly retrieve website elements like tables, images, etc. from URL - version: '1.0' + version: '1.1.0' servers: - url: 'https://apis.sentient.io' tags: -- name: "v1.0" - description: "Published Date - Feb 10, 2020" +- name: "v1.1.0" + description: "Published Date - Oct 30, 2020" paths: - /microservices/utility/webscraping/v1.0/getresults: + /microservices/utility/webscraping/v1/getresults: post: tags: - - v1.0 + - v1.1.0 responses: '200': description: success response @@ -71,16 +71,20 @@ paths: schema: $ref: '#/components/schemas/success' example: - url: string - queryList: - - findType: string - tag: string - id: string - class: string - nestedclassid: string - attribute: string - title: string - returnType: string + message: Successfully Processed + results: + data: |- + BBC - HomeBBC HomepageSkip to contentAccessibility Helpsign-inBBC AccountHomeNewsSportReelWorklifeTravelFutureCultureMenuMorecaret-downsearchSearchHomeNewsSportReelWorklifeTravelFutureCultureMusicTVWeatherSoundsnoClose menuWelcome to the BBCBBC HomepagePM warns virus deaths could be 'twice as bad' as springAttributionUKPrince William 'contracted Covid-19 in April'AttributionUKWhich Strictly celeb is the first to leave?AttributionBBC OneMore top storiesBale heads winner to send Spurs secondAttributionFootballWho's ahead in the polls - Trump or Biden?AttributionUS Election 2020Five alternatives to saving money with the bankAttributionBBC ScotlandCoronavirus pandemicnextSpain's funeral homes strike as virus cases riseAttributionEuropeHow many coronavirus cases are there in your area?AttributionUKPolice battle to break up 700-strong illegal raveAttributionEnglandNews headlinesnextScotland's new regional Covid restrictions go liveAttributionScotlandBiden and Trump criss-cross the US as vote nearsAttributionUS Election 2020Veteran journalist Robert Fisk dies aged 74AttributionMiddle EastSport headlinesnextPogba says he made 'stupid mistake'AttributionMan Utd'I don't know the direction Man Utd are going' - MOTD2 analysis. Video'I don't know the direction Man Utd are going' - MOTD2 analysisAttributionMan UtdplayMan City win FA Cup after extra timeAttributionWomen's FootballUS Election 2020nextUS election: Trump is in the fight of his political lifeAttributionUS Election 2020The Asians who want Trump to win re-electionAttributionAsiaThe 750,000 people you didn't know could voteAttributionUS Election 2020Around the UKnextScotland's new regional Covid restrictions go liveAttributionScotlandFollow rules plea ahead of post-lockdown exit planAttributionWalesEight more coronavirus-related deaths in NIAttributionNorthern IrelandThe BBC around the UKScotlandALBAWalesCymruNI3 things we love todayYour pictures on the theme of 'urban living'AttributionIn PicturesCan you guess the celebrity childhood photo?AttributionBBC BitesizeThis Celtic rainforest has the calm vibes we all need. VideoThis Celtic rainforest has the calm vibes we all needAttributionBBC TwoplayPlant powerPlant power, Should you swap that beef burger for a vegan version?Should you swap that beef burger for a vegan version?Watch what might happen if the entire world switched to a plant-based dietAttributionBBC IdeasEntertainment news'This is one of my films of the year'AttributionBBC Radio 5 LiveBill surprises fans with nimble feet (and an elephant)AttributionBBC OneSean Connery's greatest moments on screen - in picturesAttributionEntertainment & ArtsSocietyCouple trolled for intimate wedding photoshootAttributionIndia'I raise £2,000 a month to keep my daughter alive'AttributionEngland'Collaborative effort' needed to help gay players come outAttributionEnglandOur Planet NownextThe BBC’s ongoing focus on the environment and the challenges facing our planetYou've got cheap data, how about cheap power too?Publishedduration2 days agoAttributionScience & EnvironmentThe Repair Shop's Jay Blades: 'Make do and mend' for the planet. Video, 00:03:15The Repair Shop's Jay Blades: 'Make do and mend' for the planetPublishedduration2 days agoplay3:15'You could see avocados growing in Hackney' Video, 00:01:04'You could see avocados growing in Hackney'Publishedduration3 days agoAttributionLondonplay1:04Real-life storiesSteph McGovern on 'toning it down' for TV, Trump and pregnancy. AudioSteph McGovern on 'toning it down' for TV, Trump and pregnancyAttributionBBC Radio 4listen'Nobody would help me until Keanu Reeves turned up!' Video'Nobody would help me until Keanu Reeves turned up!'AttributionBBC OneplayDoctor duped into buying 'Aladdin's lamp' for $41,600AttributionIndiaYou might have missedA magical underwater moment captured on film. VideoA magical underwater moment captured on filmAttributionBBC TwoplayHouse prices climb to record high, says NationwideAttributionBusinessCornwall Poldark house fallen into 'complete disrepair'AttributionEnglandFoodnextPerfect pot-roasts with minimum effortAttributionBBC FoodA super-speedy version of a takeaway classicAttributionBBC FoodHealthy winter warmers to keep you full for longerAttributionBBC FoodLifestyleThree tips to help you through redundancy. VideoThree tips to help you through redundancyAttributionBBC IdeasplayGet your ramble on with Countryfile's top hiking tipsAttributionBBC Children in NeedAwesome autumn activities for younger kidsAttributionTiny Happy PeopleThis week in sportWilder questions Fury gloves in rematchAttributionBoxingTributes after ex-Hearts captain Zaliukas dies aged 36AttributionFootballVerstappen sorry for offensive language during + Portuguese GPAttributionFormula 1Behind the headlinesCharlie Hebdo attack suspect tests positive for Covid-19AttributionEuropeBerlin's new €6bn airport opens... 10 years late. VideoBerlin's new €6bn airport opens... 10 years lateAttributionWorldplayNew York man plunges into rat-infested sinkholeAttributionUS & CanadaTime well spentSam Smith's track-by-track guide to their new album. AudioSam Smith's track-by-track guide to their new albumAttributionBBC Radio 1listenRap Game star shares his Black History Month picksAttributionBBC ThreeThese eerie stories might just keep you awake at nightAttributionBBC Radio 4Modern Slavery StatementRead moreThe BBC around the UKScotlandALBAWalesCymruNIOther servicesComplaintsUS Election 2020A really simple guide to the electionAttributionBBC NewsDisinformation: How to spot it. iPlayerDisinformation: How to spot itAttributionBBC iPlayeriplayerWho do you think will win?AttributionBBC NewsOdd happenings from past US electionsAttributionBBC BitesizeHomeNewsSportReelWorklifeTravelFutureCultureMusicTVWeatherSoundsTerms of UseAbout the BBCPrivacy PolicyCookiesAccessibility HelpParental GuidanceContact the BBCGet Personalised NewslettersWhy you can trust the BBCAdvertise with usAdChoices / Do Not Sell My Info© 2020 BBC. The BBC is not responsible for the content of external sites. Read about our approach to external linking. + dataList: + - imagelinks: + - https://ichef.bbci.co.uk/images/ic/240x135/p08x3gpx.jpg + - https://ichef.bbci.co.uk/curationkit-ichef/240x135/cpsprodpb/16FC3/production/_115174149_063942058.jpg + - https://ichef.bbci.co.uk/images/ic/240x135/p08x2qxp.jpg + - https://ichef.bbci.co.uk/images/ic/240x135/p08x39pc.jpg + - https://ichef.bbci.co.uk/images/ic/240x135/p08wsqty.jpg + - https://ichef.bbci.co.uk/images/ic/240x135/p08vchc7.jpg + status: Success '400': description: Restricted content: @@ -148,55 +152,6 @@ components: success: type: object properties: - results: - type: array - example: [{"title":"imagelinks", "findType":"find_all","tag":"img","attribute":"src"}] - description: The result of the API call - items: - properties: - links: - type: array - items: - oneOf: - - type: string - example: https://www.bbc.co.uk - - type: string - example: https://www.bbc.co.uk/accessibility/ - - type: string - example: https://www.bbc.co.uk/news - - type: string - example: https://www.bbc.co.uk/news - - type: string - example: https://www.bbc.co.uk/news - - type: string - example: https://www.bbc.co.uk/weather - values: - type: array - items: - oneOf: - - type: object - properties: - value: - type: string - example: Home - - type: object - properties: - value: - type: string - example: News - - type: object - properties: - value: - type: string - example: Sport - images: - type: array - items: - oneOf: - - type: string - example: https://ichef.bbci.co.uk/news/320/cpsprodpb/0DDC/production/_112984530_gettyimages-1227286994.jpg - - type: string - example: https://ichef.bbci.co.uk/images/ic/720x405/p08dwhp8.jpg message: type: string example: successfully processed @@ -205,6 +160,19 @@ components: type: string example: success description: The status of the API call success/failure + results: + type: object + example: {"data":"text content of the webpage","dataList": [{ "title": "imagelinks", "findType": "find_all", "tag": "img", "attribute": "src" }]} + description: Json Object of returned results + properties: + data: + type: string + example: "BBC - HomeBBC HomepageSkip to contentAccessibility Helpsign-inBBC AccountHomeNewsSportReelWorklifeTravelFutureCultureMenuMorecaret-downsearchSearchHomeNewsSportReelWorklifeTravelFutureCultureMusicTVWeatherSoundsnoClose menuWelcome to the BBCBBC HomepagePM warns virus deaths could be 'twice as bad' as springAttributionUKPrince William 'contracted Covid-19 in April'AttributionUKWhich Strictly celeb is the first to leave?AttributionBBC OneMore top storiesBale heads winner to send Spurs secondAttributionFootballWho's ahead in the polls - Trump or Biden?AttributionUS Election 2020Five alternatives to saving money with the bankAttributionBBC ScotlandCoronavirus pandemicnextSpain's funeral homes strike as virus cases riseAttributionEuropeHow many coronavirus cases are there in your area?AttributionUKPolice battle to break up 700-strong illegal raveAttributionEnglandNews headlinesnextScotland's new regional Covid restrictions go liveAttributionScotlandBiden and Trump criss-cross the US as vote nearsAttributionUS Election 2020Veteran journalist Robert Fisk dies aged 74AttributionMiddle EastSport headlinesnextPogba says he made 'stupid mistake'AttributionMan Utd'I don't know the direction Man Utd are going' - MOTD2 analysis. Video'I don't know the direction Man Utd are going' - MOTD2 analysisAttributionMan UtdplayMan City win FA Cup after extra timeAttributionWomen's FootballUS Election 2020nextUS election: Trump is in the fight of his political lifeAttributionUS Election 2020The Asians who want Trump to win re-electionAttributionAsiaThe 750,000 people you didn't know could voteAttributionUS Election 2020Around the UKnextScotland's new regional Covid restrictions go liveAttributionScotlandFollow rules plea ahead of post-lockdown exit planAttributionWalesEight more coronavirus-related deaths in NIAttributionNorthern IrelandThe BBC around the UKScotlandALBAWalesCymruNI3 things we love todayYour pictures on the theme of 'urban living'AttributionIn PicturesCan you guess the celebrity childhood photo?AttributionBBC BitesizeThis Celtic rainforest has the calm vibes we all need. VideoThis Celtic rainforest has the calm vibes we all needAttributionBBC TwoplayPlant powerPlant power, Should you swap that beef burger for a vegan version?Should you swap that beef burger for a vegan version?Watch what might happen if the entire world switched to a plant-based dietAttributionBBC IdeasEntertainment news'This is one of my films of the year'AttributionBBC Radio 5 LiveBill surprises fans with nimble feet (and an elephant)AttributionBBC OneSean Connery's greatest moments on screen - in picturesAttributionEntertainment & ArtsSocietyCouple trolled for intimate wedding photoshootAttributionIndia'I raise £2,000 a month to keep my daughter alive'AttributionEngland'Collaborative effort' needed to help gay players come outAttributionEnglandOur Planet NownextThe BBC’s ongoing focus on the environment and the challenges facing our planetYou've got cheap data, how about cheap power too?Publishedduration2 days agoAttributionScience & EnvironmentThe Repair Shop's Jay Blades: 'Make do and mend' for the planet. Video, 00:03:15The Repair Shop's Jay Blades: 'Make do and mend' for the planetPublishedduration2 days agoplay3:15'You could see avocados growing in Hackney' Video, 00:01:04'You could see avocados growing in Hackney'Publishedduration3 days agoAttributionLondonplay1:04Real-life storiesSteph McGovern on 'toning it down' for TV, Trump and pregnancy. AudioSteph McGovern on 'toning it down' for TV, Trump and pregnancyAttributionBBC Radio 4listen'Nobody would help me until Keanu Reeves turned up!' Video'Nobody would help me until Keanu Reeves turned up!'AttributionBBC OneplayDoctor duped into buying 'Aladdin's lamp' for $41,600AttributionIndiaYou might have missedA magical underwater moment captured on film. VideoA magical underwater moment captured on filmAttributionBBC TwoplayHouse prices climb to record high, says NationwideAttributionBusinessCornwall Poldark house fallen into 'complete disrepair'AttributionEnglandFoodnextPerfect pot-roasts with minimum effortAttributionBBC FoodA super-speedy version of a takeaway classicAttributionBBC FoodHealthy winter warmers to keep you full for longerAttributionBBC FoodLifestyleThree tips to help you through redundancy. VideoThree tips to help you through redundancyAttributionBBC IdeasplayGet your ramble on with Countryfile's top hiking tipsAttributionBBC Children in NeedAwesome autumn activities for younger kidsAttributionTiny Happy PeopleThis week in sportWilder questions Fury gloves in rematchAttributionBoxingTributes after ex-Hearts captain Zaliukas dies aged 36AttributionFootballVerstappen sorry for offensive language during\nPortuguese GPAttributionFormula 1Behind the headlinesCharlie Hebdo attack suspect tests positive for Covid-19AttributionEuropeBerlin's new €6bn airport opens... 10 years late. VideoBerlin's new €6bn airport opens... 10 years lateAttributionWorldplayNew York man plunges into rat-infested sinkholeAttributionUS & CanadaTime well spentSam Smith's track-by-track guide to their new album. AudioSam Smith's track-by-track guide to their new albumAttributionBBC Radio 1listenRap Game star shares his Black History Month picksAttributionBBC ThreeThese eerie stories might just keep you awake at nightAttributionBBC Radio 4Modern Slavery StatementRead moreThe BBC around the UKScotlandALBAWalesCymruNIOther servicesComplaintsUS Election 2020A really simple guide to the electionAttributionBBC NewsDisinformation: How to spot it. iPlayerDisinformation: How to spot itAttributionBBC iPlayeriplayerWho do you think will win?AttributionBBC NewsOdd happenings from past US electionsAttributionBBC BitesizeHomeNewsSportReelWorklifeTravelFutureCultureMusicTVWeatherSoundsTerms of UseAbout the BBCPrivacy PolicyCookiesAccessibility HelpParental GuidanceContact the BBCGet Personalised NewslettersWhy you can trust the BBCAdvertise with usAdChoices / Do Not Sell My Info© 2020 BBC. The BBC is not responsible for the content of external sites. Read about our approach to external linking." + description: Text content of the webpage. + dataList: + type: array + example: [{"imagelinks": ["https://ichef.bbci.co.uk/images/ic/240x135/p08x3gpx.jpg","https://ichef.bbci.co.uk/curationkit-ichef/240x135/cpsprodpb/16FC3/production/_115174149_063942058.jpg","https://ichef.bbci.co.uk/images/ic/240x135/p08x2qxp.jpg","https://ichef.bbci.co.uk/images/ic/240x135/p08x39pc.jpg","https://ichef.bbci.co.uk/images/ic/240x135/p08wsqty.jpg","https://ichef.bbci.co.uk/images/ic/240x135/p08vchc7.jpg"]}] + description: Extracted results of queryList in a list format. unauthorized: type: object properties: @@ -289,12 +257,26 @@ components: versions: type: object properties: - v0.1: + v1.1.0: + type: array + items: + oneOf: + - type: string + example: Published Date - Oct 30, 2020 + description: Partial URL support + v1.0.0: + type: array + items: + oneOf: + - type: string + example: Published Date - Jul 03, 2020 + description: Improvised search filters using queryList, now you can even navigate down the html tree like get all p tag inside a div class "class":"class_name p" + v0.1.0: type: array items: oneOf: - type: string - example: Published Date - Feb 10, 2020 + example: Published Date - Jul 18, 2018 description: Initial version release input: type: object @@ -303,30 +285,79 @@ components: type: string default: true example: https://www.bbc.co.uk - description: The absolute input url, i.e exact, full address (URL) to the page + description: Webpage URL. It also support partial URL like bbc.co.uk queryList: type: array default: false example: [{"title":,"findType":"find_all","tag":"h1", "returnType":"html"}] - description: Array object + description: List of extraction conditions. items: - properties: - findType: - type: string - tag: - type: string - id: - type: string - class: - type: string - nestedclassid: - type: string - attribute: - type: string - title: - type: string - returnType: - type: string + oneOf: + - type: object + properties: + findType: + x-name: findType + type: string + default: false + example: |+ + find_all + description: |+ + Extraction Type. Possible values are: + 1. find - returns the first matching possibility + 2. find_all - returns the all matching possibility + 3. select - If you want to search for tags that match two or more CSS classes. either nestedClassId is mandatory + tag: + x-name: tag + type: string + default: false + example: h1 + description: |+ + The HTML tag to extract + id: + x-name: id + type: string + default: false + example: sampleid + description: |+ + The HTML element id to extract + class: + x-name: class + type: string + default: false + example: sampleclass + description: |+ + The HTML element classname to extract + nestedClassId: + x-name: nestedclassid + type: string + default: false + example: p.strikeout + description: |+ + The nested HTML tags. Example: p.strikeout - looks for those matching "strikeout" classname inside the "p" element. + Add additional nesting elments using .(dot) to concatenate + attribute: + x-name: attribute + type: string + default: false + example: src + description: |+ + The HTML element attribute to extract, supported only with tag/id/class/nestedClassId + title: + x-name: title + type: string + default: false + example: mytitle + description: |+ + The key value of the extracted result. By default, the return json key is "values". + returnType: + x-name: returnType + type: string + default: false + example: html + description: |+ + Optional input parameter. If no input parameter is specified, the default return type would be text. + Use “html” to set return type to HTML format + securitySchemes: APIAuthorizer: type: apiKey diff --git a/yaml/wikipedia_retrieval.yaml b/yaml/wikipedia_retrieval.yaml index ceea86ec0..53f5cabb1 100644 --- a/yaml/wikipedia_retrieval.yaml +++ b/yaml/wikipedia_retrieval.yaml @@ -3,18 +3,18 @@ info: title: Wikipedia Retrieval description: |+ It is an API that provides the user with a Wikipedia article based on the input keyword. Refer to this link for the full list of Wikipedias - https://meta.wikimedia.org/wiki/List_of_Wikipedias - version: '0.1' + version: '0.1.0' x-subscribelink: wikipedia_retrieval servers: - url: 'https://apis.sentient.io' tags: -- name: "v0.1" - description: "Published Date - Mar 27, 2020" +- name: "v0.1.0" + description: "Published Date - Apr 23, 2020" paths: /microservices/utility/wikipedia/v0.1/getresults: post: tags: - - v0.1 + - v0.1.0 responses: '200': description: success response @@ -255,12 +255,12 @@ components: versions: type: object properties: - v0.1: + v0.1.0: type: array items: oneOf: - type: string - example: Published Date - Mar 27, 2020 + example: Published Date - Apr 23, 2020 description: Initial version release input: type: object diff --git a/yaml/word_sense_disambiguation_eng.yaml b/yaml/word_sense_disambiguation_eng.yaml index 8d9f76af0..44647fa14 100644 --- a/yaml/word_sense_disambiguation_eng.yaml +++ b/yaml/word_sense_disambiguation_eng.yaml @@ -5,18 +5,21 @@ info: This NLP microservice takes in a text and a target word and identifies the target word's hypernym. Hypernym refers to the specific meaning of the word within the context of the sentence. If the word is determined to be a noun within the sentence context, the microservice returns the potential hypernym, definition, and score. Otherwise, no result will be returned for that context. - version: '0.1' + + Do ensure that your text is within **5000 characters**. + + version: '0.1.0' x-subscribelink: word_sense_disambiguation_eng servers: - url: 'https://apis.sentient.io' tags: -- name: "v0.1" - description: "Published Date - Feb 12, 2020" +- name: "v0.1.0" + description: "Published Date - Mar 06, 2020" paths: /microservices/nlp/wordsensedisambiguation/v0.1/getpredictions: post: tags: - - v0.1 + - v0.1.0 responses: '200': description: success response @@ -156,12 +159,12 @@ components: example: society.n.01 description: The target word name in wordnet library synset_score: - type: integer + type: number format : float example: 0.9870249032974243 description: Is the confidence score from the network token_index: - type: integer + type: number example: 40 description: Is the target word position in the sentence unauthorized: @@ -247,7 +250,9 @@ components: default: true example: An estimated 180,000 people were under mandatory evacuation orders, including parts of Santa Rosa and a large swath of Sonoma County all the way to the Pacific Ocean. description: |+ - Input text. A complete sentence or paragraph + Input text can be a complete sentence or paragraph. + + Supported formats: ASCII only target_word: x-name: target_word type: string @@ -266,12 +271,12 @@ components: versions: type: object properties: - v0.1: + v0.1.0: type: array items: oneOf: - type: string - example: Published Date - Feb 12,2020 + example: Published Date - Mar 06, 2020 description: Initial version release securitySchemes: APIAuthorizer: diff --git a/yaml/word_sense_disambiguation_eng_v1.0.yaml b/yaml/word_sense_disambiguation_eng_v1.0.yaml new file mode 100644 index 000000000..ade581ce7 --- /dev/null +++ b/yaml/word_sense_disambiguation_eng_v1.0.yaml @@ -0,0 +1,307 @@ +openapi: 3.0.1 +info: + title: Word Sense Disambiguation ENG + description: |+ + This NLP microservice takes in a text and a target word and identifies the target word's hypernym. Hypernym refers to the specific meaning of the word within the context of the sentence. + + If the word is determined to be a noun within the sentence context, the microservice returns the potential hypernym, definition, and score. Otherwise, no result will be returned for that context. + + Do ensure that your text is **within 5000 characters**. + version: '1.0.0' + x-subscribelink: word_sense_disambiguation_eng +servers: + - url: 'https://apis.sentient.io' +tags: +- name: "v1.0.0" + description: "Published Date - Oct 30, 2020" +paths: + /microservices/nlp/wordsensedisambiguation/v1/getpredictions: + post: + tags: + - v1.0.0 + responses: + '200': + description: success response + content: + application/json: + schema: + $ref: '#/components/schemas/success' + example: + results: + sentence_index: + '4': 'But our genius for creative storytelling , combined with our inability to + detect our own ignorance , can sometimes lead to situations that are embarrassing + , unfortunate , or downright dangerous – especially in a technologically advanced + , complex democratic societythat occasionally invests mistaken popular beliefs + with immense destructive power ( See : crisis , financial ; war , Iraq ) .' + tokens: + '4': + society: + - token_index: 40 + synset_name: society.n.01 + synset_definition: an extended social group having a distinctive cultural and + economic organization + synset_score: 0.9870249032974243 + hypernyms: + - hypernym_name: social_group.n.01 + hypernym_definition: people sharing some social relation + potential_candidate_score: 1 + message: Successfully Processed + status: Success + '401': + description: Unauthorized + content: + application/json: + schema: + $ref: '#/components/schemas/unauthorized' + '402': + description: Payment Required + content: + application/json: + schema: + $ref: '#/components/schemas/paymentrequired' + '403': + description: Forbidden + content: + application/json: + schema: + $ref: '#/components/schemas/forbidden' + '404': + description: Not Found + content: + application/json: + schema: + $ref: '#/components/schemas/notfound' + '419': + description: Input Field Missing + content: + application/json: + schema: + $ref: '#/components/schemas/inputfieldmissing' + '420': + description: Input Limit Exceeded + content: + application/json: + schema: + $ref: '#/components/schemas/inputlimitexceeded' + '500': + description: Internal Server Error + content: + application/json: + schema: + $ref: '#/components/schemas/servererror' + '504': + description: Gateway Timeout + content: + application/json: + schema: + $ref: '#/components/schemas/gatewaytimeout' + security: + - APIAuthorizer: [] + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/input' + required: true +components: + schemas: + success: + type: object + properties: + results: + type: object + description: The result of the API call. + example: { "" } + properties: + sentence_index: + type: object + example: {"4": "But our genius for creative storytelling , combined with our inability to detect our own ignorance , can sometimes lead to situations that are embarrassing , unfortunate , or downright dangerous \u2013 especially in a technologically advanced , complex democratic society that occasionally invests mistaken popular beliefs with immense destructive power ( See : crisis , financial ; war , Iraq ) .","7": "The society of extraordinary gentlemen has a natural way of overcoming difficulties in tough times to come out stronger , saving society from itself ."} + description: Is a mapping from an index of the sentence in the presented text (say, 0, 1, 2...) to the text of the sentence itself. + properties: + 4: + type: string + example: { 4:But our genius for creative storytelling , combined with our inability to detect our own ignorance , can sometimes lead to situations that are embarrassing , unfortunate , or downright dangerous \u2013 especially in a technologically advanced , complex democratic society that occasionally invests mistaken popular beliefs with immense destructive power} + description: mapping value + tokens: + type: object + example: {"4": {"society": [{"hypernyms": [{"hypernym_definition": "people sharing some social relation","hypernym_name": "social_group.n.01","potential_candidate_score": 1.0}],"synset_definition": "an extended social group having a distinctive cultural and economic organization","synset_name": "society.n.01","synset_score": 0.9870249032974243,"token_index": 40}]}} + description: Is a mapping from the sentence_index to the target word's potential synsets and hypernms. + properties: + 4: + type: object + example: {"society": [{"hypernyms": [{"hypernym_definition": "people sharing some social relation","hypernym_name": "social_group.n.01","potential_candidate_score": 1.0}],"synset_definition": "an extended social group having a distinctive cultural and economic organization","synset_name": "society.n.01","synset_score": 0.9870249032974243,"token_index": 40}]} + description: Mapping value + properties: + : + type: array + example: [{"hypernyms": [{"hypernym_definition": "people sharing some social relation","hypernym_name": "social_group.n.01","potential_candidate_score": 1.0}],"synset_definition": "an extended social group having a distinctive cultural and economic organization","synset_name": "society.n.01","synset_score": 0.9870249032974243,"token_index": 40}] + description: Details about the target word given as input + items: + properties: + hypernyms: + type: array + example: [{"hypernym_definition": "people sharing some social relation","hypernym_name": "social_group.n.01","potential_candidate_score": 1.0}] + description: A hypernym can be thought of as a parent class. For example, "colour" is a hypernym of "red". + items: + properties: + hypernym_definition: + type: string + example: people sharing some social relation + description: Definition of the hypernym + hypernym_name: + type: string + example: social_group.n.01 + description: Describes the category in which the target word belongs to. Eg:car is a transport. car is the target word and transport is the category(hypernym) + potential_candidate_score: + type: integer + example: 1 + description: Is the confidence score from the network + synset_definition: + type: string + example: An extended social group having a distinctive cultural and economic organization + description: A synset is a collection of synonyms, identified using the WordNet synset name. It connects a word to the synset it belongs via a definition. A word can belong to more than one synset. Basically definition of the target_word + synset_name: + type: string + example: society.n.01 + description: The target word name in wordnet library + synset_score: + type: number + format : float + example: 0.9870249032974243 + description: Is the confidence score from the network + token_index: + type: number + example: 40 + description: Is the target word position in the sentence + message: + type: string + example: Successfully Processed + description: Detail description on the API status + status: + type: string + example: Success + description: The status of the API call success/failure + unauthorized: + type: object + properties: + message: + type: string + example: Missing Authentication Token + status: + type: string + example: Failure + forbidden: + type: object + properties: + message: + type: string + example: Access Denied Unauthorized User + status: + type: string + example: Failure + paymentrequired: + type: object + properties: + message: + type: string + example: Insufficient Credits Kindly Top Up + status: + type: string + example: Failure + notfound: + type: object + properties: + message: + type: string + example: Invalid Request URL + status: + type: string + example: Failure + servererror: + type: object + properties: + message: + type: string + example: Internal Server Error + status: + type: string + example: Failure + gatewaytimeout: + type: object + properties: + message: + type: string + example: Request Timeout + status: + type: string + example: Failure + inputfieldmissing: + type: object + properties: + message: + type: string + example: Input Field Missing + status: + type: string + example: Failure + inputlimitexceeded: + type: object + properties: + message: + type: string + example: Input Limit Exceeded + status: + type: string + example: Failure + input: + type: object + required: + - text + properties: + text: + x-name: text + type: string + default: true + example: An estimated 180,000 people were under mandatory evacuation orders, including parts of Santa Rosa and a large swath of Sonoma County all the way to the Pacific Ocean. + description: |+ + Input text. A complete sentence or paragraph + target_word: + x-name: target_word + type: string + default: true + example: County + description: |+ + A noun token that can be found in text + repeat: + x-name: repeat + type: string + default: true + example: "True" + description: |+ + Indicates whether the target_word that was first identified in the input text is to be used alone or all the target_words identified in the text are to be used. + If False, then it uses the first target_word alone in text and ignores the rest. + versions: + type: object + properties: + v1.0.0: + type: array + items: + oneOf: + - type: string + example: Published Date - Oct 30,2020 + description: Standardizing Output JSON + v0.1.0: + type: array + items: + oneOf: + - type: string + example: Published Date - Mar 06, 2020 + description: Initial version release + securitySchemes: + APIAuthorizer: + type: apiKey + name: x-api-key + in: header + x-amazon-apigateway-authtype: custom + description: Authentication is done using the x-api-key in the request header diff --git a/yaml/youtube_video_downloader.yaml b/yaml/youtube_video_downloader.yaml index 173dceba2..ed7a60092 100644 --- a/yaml/youtube_video_downloader.yaml +++ b/yaml/youtube_video_downloader.yaml @@ -3,18 +3,20 @@ info: title: Youtube Video Downloader description: |+ This Utility microservice retrieves the Youtube video of the input URL and output a download link. - version: '0.1' + + Note that the URL has to be **spelt in full**, including "https://www." + version: '0.1.0' x-subscribelink: youtube_video_downloader servers: - url: 'https://apis.sentient.io' tags: -- name: "v0.1" - description: "Published Date - Oct 22, 2019" +- name: "v0.1.0" + description: "Published Date - Nov 25, 2019" paths: /microservices/utility/downloadyoutubevideos/v0.1/getresults: post: tags: - - v0.1 + - v0.1.0 responses: '200': description: success response @@ -185,16 +187,16 @@ components: default: true example: https://www.youtube.com/watch?v=1bumPyvzCyo description: |+ - Youtube URL + Youtube URL. versions: type: object properties: - v0.1: + v0.1.0: type: array items: oneOf: - type: string - example: Published Date - Oct 22, 2019 + example: Published Date - Nov 25, 2019 description: Initial version release securitySchemes: APIAuthorizer: From c39b2abf53acd69f5b96a50962ebc97abe686d87 Mon Sep 17 00:00:00 2001 From: Priyadharshini <57977344+priyadharshini-sent@users.noreply.github.com> Date: Fri, 6 Nov 2020 16:43:28 +0530 Subject: [PATCH 171/792] latest versions update --- yaml/index.yaml | 141 +++++++++++++++++++++++++----------------------- 1 file changed, 74 insertions(+), 67 deletions(-) diff --git a/yaml/index.yaml b/yaml/index.yaml index f76eccbc0..ee5cf6347 100644 --- a/yaml/index.yaml +++ b/yaml/index.yaml @@ -1,243 +1,250 @@ Voice: + + + + Automatic Speech Recognition ENG (SG): - title: Automatic Speech Recognition ENG (SG) + title: automatic_speech_recognition_eng_sg versions: v0.1: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/automatic_speech_recognition_eng_sg.yaml" Automatic Speech Recognition CHI (SG): - title: Automatic Speech Recognition CHI (SG) + title: automatic_speech_recognition_chi_sg versions: v0.1: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/automatic_speech_recognition_chi_sg.yaml" Online Automatic Speech Recognition ENG (SG): - title: Online Automatic Speech Recognition ENG (SG) + title: online_automatic_speech_recognition_eng_sg versions: v0.1: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/online_automatic_speech_recognition_eng_sg.yaml" Online Command Automatic Speech Recognition ENG (SG): - title: Online Command Automatic Speech Recognition ENG (SG) + title: online_command_automatic_speech_recognition_eng_sg versions: v0.1: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/online_command_automatic_speech_recognition_eng_sg.yaml" Text-To-Speech ENG: - title: Text-To-Speech ENG + title: text-to-speech_eng versions: v0.1: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/text-to-speech_eng.yaml" Text-To-Speech CHI: - title: Text-To-Speech CHI + title: text-to-speech_chi versions: v0.1: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/text-to-speech_chi.yaml" ASR with Voice Activity Detection ENG (SG): - title: ASR with Voice Activity Detection ENG (SG) + title: asr_with_voice_activity_detection_eng_sg versions: v0.1: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/asr_with_voice_activity_detection_eng_sg.yaml" Voice Activity Detection ENG: - title: Voice Activity Detection ENG + title: voice_activity_detection_eng versions: v0.1: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/voice_activity_detection_eng.yaml" NLP: Inverse Text Normalisation ENG: - title: Inverse Text Normalisation ENG + title: inverse_text_normalisation_eng versions: + v1.0: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/inverse_text_normalisation_eng_v1.0.yaml" v0.1: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/inverse_text_normalisation_eng.yaml" Named-Entity Recognition ENG: - title: Named-Entity Recognition ENG + title: named-entity_recognition_eng versions: v1.0: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/named-entity_recognition_eng_v1.0.yaml" v0.1: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/named-entity_recognition_eng.yaml" spaCy NER: - title: spaCy NER + title: spacy_ner versions: v0.1: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/spacy_named-entity_recognition_eng.yaml" Page Profiler ENG: - title: Page Profiler ENG + title: page_profiler_eng versions: - v2.0: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/page_profiler_eng_v2.0.yaml" - v1.0: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/page_profiler_eng.yaml" + v2.1: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/page_profiler_eng_v2.1.yaml" Page Profiler JP: - title: Page Profiler JP + title: page_profiler_jp versions: - v0.1: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/page_profiler_jp.yaml" + v1.0: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/page_profiler_jp.yaml" Page Profiler THAI: - title: Page Profiler THAI + title: page_profiler_thai versions: - v0.1: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/page_profiler_thai.yaml" + v1.0: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/page_profiler_thai.yaml" Taxonomy Matcher ENG: - title: Taxonomy Matcher ENG + title: taxonomy_matcher_eng versions: + v1.0: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/taxonomy_matcher_eng_v1.0.yaml" v0.1: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/taxonomy_matcher_eng.yaml" Word Sense Disambiguation ENG: - title: Word Sense Disambiguation ENG + title: word_sense_disambiguation_eng versions: + v1.0: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/word_sense_disambiguation_eng_v1.0.yaml" v0.1: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/word_sense_disambiguation_eng.yaml" Named-Entity Recognition JP: - title: Named-Entity Recognition JP + title: named-entity_recognition_jp versions: v1.0: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/named-entity_recognition_jp_v1.0.yaml" v0.1: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/named-entity_recognition_jp.yaml" Named Entity Recognition THAI: - title: Named Entity Recognition THAI + title: named-entity_recognition_thai versions: v1.0: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/named-entity_recognition_thai_v1.0.yaml" v0.1: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/named-entity_recognition_thai.yaml" Script Alignment: - title: Script Alignment + title: script_alignment versions: + v1.0: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/script_alignment_v1.0.yaml" v0.1: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/script_alignment.yaml" Computer Vision: Object Detection: - title: Object Detection + title: object_detection versions: v0.1: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/object_detection.yaml" Face Recognition Politicians (SG): - title: Face Recognition Politicians (SG) + title: face_recognition_politicians_sg versions: v0.1: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/face_recognition_politicians_sg.yaml" People Counting: - title: People Counting + title: people_counting versions: v0.1: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/people_counting.yaml" Landmark Detection (SG): - title: Landmark Detection (SG) + title: landmark_detection_sg versions: v0.1: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/landmark_detection_sg.yaml" Landmark Detection (JP): - title: Landmark Detection (JP) + title: landmark_detection_jp versions: v0.1: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/landmark_detection_jp.yaml" Utility: Youtube Video Downloader: - title: Youtube Video Downloader + title: youtube_video_downloader versions: v0.1: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/youtube_video_downloader.yaml" Video-To-Audio Convertor: - title: Video-To-Audio Convertor + title: video-to-audio_convertor versions: v0.1: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/video-to-audio_convertor.yaml" Web Scraper: - title: Web Scraper + title: web_scraper versions: - v1.0: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/web_scraper.yaml" + v1.1: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/web_scraper.yaml" Document Convertor ENG: - title: Document Convertor ENG + title: document_convertor_eng versions: v1.0: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/document_convertor_eng.yaml" PDF Extractor: - title: PDF Extractor + title: pdf_extractor versions: v1.0: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/pdf_extractor.yaml" PKI Key Generator: - title: PKI Key Generator + title: pki_key_generator versions: v0.1: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/pki_key_generator.yaml" Encryption using PKI Key: - title: Encryption using PKI Key + title: encryption_using_pki_key versions: v0.1: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/encryption_using_pki_key.yaml" Decryption using PKI Key: - title: Decryption using PKI Key + title: decryption_using_pki_key versions: v0.1: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/decryption_using_pki_key.yaml" Wikipedia Retrieval: - title: Wikipedia Retrieval + title: wikipedia_retrieval versions: v0.1: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/wikipedia_retrieval.yaml" JSON-CSV Convertor: - title: JSON-CSV Convertor + title: json-csv_convertor versions: v1.0: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/json-csv_convertor.yaml" CSV-JSON Convertor: - title: CSV-JSON Convertor + title: csv-json_convertor versions: v1.0: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/csv-json_convertor.yaml" Audio Format Convertor: - title: Audio Format Convertor + title: audio_format_convertor versions: v0.1: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/audio_format_convertor.yaml" Video-to-Image Convertor: - title: Video-to-Image Convertor + title: video-to-image_convertor versions: v0.1: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/video-to-image_convertor.yaml" Newspaper Article Scraper: - title: Newspaper Article Scraper + title: newspaper_article_scraper versions: v0.1: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/newspaper_article_scraper.yaml" URLs Retrieval: - title: URLs Retrieval + title: urls_retrieval versions: - v0.1: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/urls_retrieval.yaml" - Base64 Encoder: - title: Base64 Encoder + v0.2: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/urls_retrieval.yaml" + Base64 File Encode: + title: base64_file_encode versions: v0.1: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/base64-file-encode.yaml" - Base64 Decoder: - title: Base64 Decoder + Base64 File Decode: + title: base64_file_decode versions: v0.1: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/base64-file-decode.yaml" Data: HDB Commercial Directories (SG): - title: HDB Commercial Directories (SG) + title: commercial_directories_hdb_sg versions: v0.1: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/commercial_directories_hdb_sg.yaml" HDB Block Coordinates (SG): - title: HDB Block Coordinates (SG) + title: building_addresses_hdb_sg versions: v0.1: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/building_addresses_hdb_sg.yaml" HDB Residential Occupancy Status (SG): - title: HDB Residential Occupancy Status (SG) + title: residential_sales_and_rental_hdb_sg versions: v0.1: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/residential_sales_and_rental_hdb_sg.yaml" HDB Carpark Locations (SG): - title: HDB Carpark Locations (SG) + title: carpark_hdb_sg versions: - v0.1: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/carpark_hdb_sg.yaml" + v0.2: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/carpark_hdb_sg.yaml" HDB Demographics (SG): - title: HDB Demographics (SG) + title: demographics_hdb_sg versions: v0.1: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/demographics_hdb_sg.yaml" HDB Flat Ownership Duration (SG): - title: HDB Flat Ownership Duration (SG) + title: flat_ownership_hdb_sg versions: v0.1: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/flat_ownership_hdb_sg.yaml" HDB Season Parking Availability (SG): - title: HDB Season Parking Availability (SG) + title: season_parking_availability_hdb_sg versions: v0.1: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/season_parking_availability_hdb_sg.yaml" Directory of Singapore Startups: - title: Directory of Singapore Startups + title: directory_of_singapore_startups versions: v0.1: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/directory_of_singapore_startups.yaml" HDB Fitness Stations and Playgrounds (SG): - title: HDB Fitness Stations and Playgrounds (SG) + title: fitness_stations_and_playgrounds_hdb_sg versions: v0.1: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/fitness_stations_and_playgrounds_hdb_sg.yaml" HDB Lamp Posts Locations (SG): - title: HDB Lamp Posts Locations (SG) + title: amenities_lamp_posts_hdb_sg versions: v0.1: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/amenities_lamp_posts_hdb_sg.yaml" HDB Hardcourts Locations (SG): - title: HDB Hardcourts Locations (SG) + title: amenities_hardcourts_hdb_sg versions: v0.1: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/amenities_hardcourts_hdb_sg.yaml" HDB Shelters Locations (SG): - title: HDB Shelters Locations (SG) + title: amenities_shelters_hdb_sg versions: v0.1: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/amenities_shelters_hdb_sg.yaml" D&B Business Check Plus (SG): - title: D&B Business Check Plus (SG) + title: d&b_business_check_plus_sg versions: v0.1: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/d&b_business_check_plus_sg.yaml" D&B Basic Individual Search (SG): - title: D&B Basic Individual Search (SG) + title: d&b_basic_individual_search_sg versions: v0.1: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/d&b_basic_individual_search_sg.yaml" D&B Business Check (SG): - title: D&B Business Check (SG) + title: d&b_business_check_sg versions: v0.1: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/d&b_business_check_sg.yaml" D&B Brief Financial Information (SG): - title: D&B Brief Financial Information (SG) + title: d&b_brief_financial_information_sg versions: v0.1: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/d&b_brief_financial_information_sg.yaml" Data Alliance: Download Dataset API: - title: Download Dataset API + title: download_dataset_api urlkey: download_dataset_api versions: v0.1: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/download_dataset.yaml" From ecbe681fd7fb146d833c9f9577f05bf8eaec7a17 Mon Sep 17 00:00:00 2001 From: Priyadharshini <57977344+priyadharshini-sent@users.noreply.github.com> Date: Fri, 6 Nov 2020 16:43:48 +0530 Subject: [PATCH 172/792] latest version update --- yaml/index.yaml | 4 ---- 1 file changed, 4 deletions(-) diff --git a/yaml/index.yaml b/yaml/index.yaml index ee5cf6347..5e6b47d83 100644 --- a/yaml/index.yaml +++ b/yaml/index.yaml @@ -1,8 +1,4 @@ Voice: - - - - Automatic Speech Recognition ENG (SG): title: automatic_speech_recognition_eng_sg versions: From 1edf3853dbd8144b4f46eb9b6e920724a43716f8 Mon Sep 17 00:00:00 2001 From: Priyadharshini <57977344+priyadharshini-sent@users.noreply.github.com> Date: Fri, 6 Nov 2020 16:45:04 +0530 Subject: [PATCH 173/792] version update --- yaml/web_scraper.yaml | 18 ++---------------- 1 file changed, 2 insertions(+), 16 deletions(-) diff --git a/yaml/web_scraper.yaml b/yaml/web_scraper.yaml index 83870a30a..a6cb8bf82 100644 --- a/yaml/web_scraper.yaml +++ b/yaml/web_scraper.yaml @@ -257,27 +257,13 @@ components: versions: type: object properties: - v1.1.0: + v1.1: type: array items: oneOf: - type: string example: Published Date - Oct 30, 2020 - description: Partial URL support - v1.0.0: - type: array - items: - oneOf: - - type: string - example: Published Date - Jul 03, 2020 - description: Improvised search filters using queryList, now you can even navigate down the html tree like get all p tag inside a div class "class":"class_name p" - v0.1.0: - type: array - items: - oneOf: - - type: string - example: Published Date - Jul 18, 2018 - description: Initial version release + description: Partial URL support input: type: object properties: From 67d51a625a7a265d3787de3cc8c28ad07d218da2 Mon Sep 17 00:00:00 2001 From: Priyadharshini <57977344+priyadharshini-sent@users.noreply.github.com> Date: Thu, 19 Nov 2020 18:13:17 +0530 Subject: [PATCH 174/792] Update wikipedia_retrieval.yaml --- yaml/wikipedia_retrieval.yaml | 3 +++ 1 file changed, 3 insertions(+) diff --git a/yaml/wikipedia_retrieval.yaml b/yaml/wikipedia_retrieval.yaml index 53f5cabb1..3f2998906 100644 --- a/yaml/wikipedia_retrieval.yaml +++ b/yaml/wikipedia_retrieval.yaml @@ -272,14 +272,17 @@ components: description: The search term, highest match to the title of the Wikipedia page. pageid: type: integer + example: 1 default: true description: The Wikipedia id of the page requested. language: type: string + example: English default: false description: Indicates the language in which the Wikipedia page is written. Default is English, for other languages give the input as ISO 639-1 language code filter_key: type: string + example: all default: false description: Indicates the filter criteria of the output result fields. The default return set includes pageid, url, and summary.“all” - returns all the fields. You can also filter by individual fields using the list value. Possible values are pageid, url, summary, content, links, and images securitySchemes: From 688166fdfef1b3773f02820c9bd08b657f70bf05 Mon Sep 17 00:00:00 2001 From: Priyadharshini <57977344+priyadharshini-sent@users.noreply.github.com> Date: Fri, 20 Nov 2020 15:44:02 +0530 Subject: [PATCH 175/792] Update wikipedia_retrieval.yaml --- yaml/wikipedia_retrieval.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/yaml/wikipedia_retrieval.yaml b/yaml/wikipedia_retrieval.yaml index 3f2998906..9a7efc14b 100644 --- a/yaml/wikipedia_retrieval.yaml +++ b/yaml/wikipedia_retrieval.yaml @@ -277,7 +277,7 @@ components: description: The Wikipedia id of the page requested. language: type: string - example: English + example: ISO 639-1 default: false description: Indicates the language in which the Wikipedia page is written. Default is English, for other languages give the input as ISO 639-1 language code filter_key: From bb7fd2c0633edbd076fb1e552604c8deac9c4484 Mon Sep 17 00:00:00 2001 From: Priyadharshini Date: Fri, 27 Nov 2020 13:27:35 +0530 Subject: [PATCH 176/792] response status code updated --- yaml/Demographics_classification.yaml | 289 +++ yaml/amenities_hardcourts_hdb_sg.yaml | 17 +- yaml/amenities_lamp_posts_hdb_sg.yaml | 17 +- yaml/amenities_shelters_hdb_sg.yaml | 17 +- ..._with_voice_activity_detection_eng_sg.yaml | 15 + ..._voice_activity_detection_eng_sg_v1.0.yaml | 291 +++ yaml/audio_format_convertor.yaml | 17 +- yaml/automatic_speech_recognition_chi_sg.yaml | 15 + yaml/automatic_speech_recognition_eng_sg.yaml | 17 +- ...omatic_speech_recognition_eng_sg_v1.0.yaml | 308 ++++ yaml/automatic_voice_recognition_eng.yaml | 15 + yaml/base64-file-decode.yaml | 19 +- yaml/base64-file-encode.yaml | 19 +- yaml/building_addresses_hdb_sg.yaml | 19 +- yaml/carpark_hdb_sg.yaml | 17 +- yaml/commercial_directories_hdb_sg.yaml | 17 +- yaml/csv-json_convertor.yaml | 17 +- yaml/d&b_basic_individual_search_sg.yaml | 15 + yaml/d&b_brief_financial_information_sg.yaml | 17 +- yaml/d&b_business_check_plus_sg.yaml | 17 +- yaml/d&b_business_check_sg.yaml | 17 +- yaml/decryption_using_pki_key.yaml | 19 +- yaml/demographics_hdb_sg.yaml | 19 +- yaml/directory_of_singapore_startups.yaml | 17 +- yaml/document_convertor_eng.yaml | 17 +- yaml/encryption_using_pki_key.yaml | 19 +- yaml/face_recognition_politicians_sg.yaml | 19 +- .../face_recognition_politicians_sg_v1.0.yaml | 303 ++++ ...tness_stations_and_playgrounds_hdb_sg.yaml | 15 + yaml/flat_ownership_hdb_sg.yaml | 19 +- yaml/inverse_text_normalisation_eng.yaml | 19 +- yaml/inverse_text_normalisation_eng_v1.0.yaml | 21 +- yaml/json-csv_convertor.yaml | 19 +- yaml/landmark_detection_jp.yaml | 17 +- yaml/landmark_detection_sg.yaml | 17 +- yaml/named-entity_recognition_eng.yaml | 19 +- yaml/named-entity_recognition_eng_v1.0.yaml | 17 +- yaml/named-entity_recognition_jp.yaml | 17 +- yaml/named-entity_recognition_jp_v1.0.yaml | 17 +- yaml/named-entity_recognition_thai.yaml | 17 +- yaml/named-entity_recognition_thai_v1.0.yaml | 17 +- yaml/newspaper_article_scraper.yaml | 17 +- yaml/object_detection.yaml | 19 +- yaml/page_profiler_eng.yaml | 15 + yaml/page_profiler_eng_v2.1.yaml | 15 + yaml/page_profiler_jp.yaml | 15 + yaml/page_profiler_thai.yaml | 15 + yaml/pdf_extractor.yaml | 15 + yaml/people_counting.yaml | 17 +- yaml/pki_key_generator.yaml | 17 +- yaml/residential_sales_and_rental_hdb_sg.yaml | 17 +- yaml/script_alignment.yaml | 17 +- yaml/script_alignment_v1.0.yaml | 17 +- yaml/season_parking_availability_hdb_sg.yaml | 17 +- yaml/sentiment-analysis-aws.yaml | 17 +- yaml/spacy_named-entity_recognition_eng.yaml | 18 +- yaml/staple_invoice.yaml | 223 +++ yaml/staple_receipt.yaml | 1573 +++++++++++++++++ yaml/taxonomy_matcher_eng.yaml | 17 +- yaml/taxonomy_matcher_eng_v1.0.yaml | 17 +- yaml/text-to-speech_chi.yaml | 17 +- yaml/text-to-speech_eng.yaml | 15 + yaml/urls_retrieval.yaml | 15 + yaml/video-to-audio_convertor.yaml | 17 +- yaml/video-to-image_convertor.yaml | 15 + yaml/voice_activity_detection_eng.yaml | 17 +- yaml/voice_activity_detection_eng_v1.0.yaml | 259 +++ yaml/web_scraper.yaml | 35 +- yaml/wikipedia_retrieval.yaml | 20 +- yaml/word_sense_disambiguation_eng.yaml | 17 +- yaml/word_sense_disambiguation_eng_v1.0.yaml | 17 +- yaml/youtube_video_downloader.yaml | 17 +- 72 files changed, 4304 insertions(+), 71 deletions(-) create mode 100644 yaml/Demographics_classification.yaml create mode 100644 yaml/asr_with_voice_activity_detection_eng_sg_v1.0.yaml create mode 100644 yaml/automatic_speech_recognition_eng_sg_v1.0.yaml create mode 100644 yaml/face_recognition_politicians_sg_v1.0.yaml create mode 100644 yaml/staple_invoice.yaml create mode 100644 yaml/staple_receipt.yaml create mode 100644 yaml/voice_activity_detection_eng_v1.0.yaml diff --git a/yaml/Demographics_classification.yaml b/yaml/Demographics_classification.yaml new file mode 100644 index 000000000..6c1f1c8d5 --- /dev/null +++ b/yaml/Demographics_classification.yaml @@ -0,0 +1,289 @@ +openapi: 3.0.1 +info: + title: Demographic Classification + description: |+ + This Computer Vision microservice detects for faces from an input image and predicts the demographics of each face (age, gender and race). The image is given as an input encoded using base64. The microservice will a face detector and subsequently models to predict age, gender and race. The results will then be returned back to the user as a JSON output together with bounding box coordinates for each face.Races include: Asian, Indian, White, Black, Middle Eastern and Latino Hispanic + version: v0.1.0 + x-subscribelink: TO FILL MANUALLY +servers: + - url: 'https://dev-apis.sentient.io' +tags: +- name: "v0.1.0" + description: "Published Date - November 30, 2020" +paths: + /microservices/cv/democlass/v0/getpredictions: + post: + tags: + - v0.1.0 + responses: + '200': + description: success response + content: + application/json: + schema: + $ref: '#/components/schemas/success' + example: + results: + persons: + - age: 33.21062944528088 + bbox: + bottom: 459 + left: 82 + right: 393 + top: 0 + gender: Man + race: white + + message: Successfully Processed + status: Success + '401': + description: Unauthorized + content: + application/json: + schema: + $ref: '#/components/schemas/unauthorized' + '402': + description: Payment Required + content: + application/json: + schema: + $ref: '#/components/schemas/paymentrequired' + '403': + description: Forbidden + content: + application/json: + schema: + $ref: '#/components/schemas/forbidden' + '404': + description: Not Found + content: + application/json: + schema: + $ref: '#/components/schemas/notfound' + '419': + description: Input Field Missing + content: + application/json: + schema: + $ref: '#/components/schemas/inputfieldmissing' + '420': + description: Input Limit Exceeded + content: + application/json: + schema: + $ref: '#/components/schemas/inputlimitexceeded' + '422': + description: Invalid Input + content: + application/json: + schema: + $ref: '#/components/schemas/invalidinput' + '500': + description: Internal Server error + content: + application/json: + schema: + $ref: '#/components/schemas/servererror' + '504': + description: Gateway Timeout + content: + application/json: + schema: + $ref: '#/components/schemas/gatewaytimeout' + security: + - APIAuthorizer: [] + + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/input' + required: true + + +components: + schemas: + success: + type: object + properties: + results: + type: object + description: The result of the API call. + example: { "" } + properties: + persons: + description: Demographic details of the detected person + example: + age: 33.21062944528088 + bbox: + bottom: 459 + left: 82 + right: 393 + top: 0 + gender: Man + race: white + items: + properties: + description: Demographic details of the detected person + example: ' ' + properties: + age: + description: Age of the detected person in the input image + example: 33.21062944528088 + type: float + bbox: + description: Bounding box of the detected person in the input image + example: ' ' + properties: + bottom: + description: Bottom coordinate of the box + example: 459 + type: integer + left: + description: Left coordinate of the box + example: 82 + type: integer + right: + description: Right coordinate of the box + example: 393 + type: integer + top: + description: Top coordinate of the box + example: 0 + type: integer + type: object + gender: + description: Gender of the detected person in the input image + example: Man + type: string + race: + description: Race of the detected person in the input image + example: white + type: string + type: object + type: object + type: array + + message: + type: string + example: Successfully Processed + description: Detail description on the API status + status: + type: string + example: Success + description: The status of the API call success/failure + + unauthorized: + type: object + properties: + message: + type: string + example: Missing Authentication Token + status: + type: string + example: Failure + forbidden: + type: object + properties: + message: + type: string + example: Access Denied Unauthorized User + status: + type: string + example: Failure + paymentrequired: + type: object + properties: + message: + type: string + example: Insufficient Credits Kindly Top Up + status: + type: string + example: Failure + notfound: + type: object + properties: + message: + type: string + example: Invalid Request + status: + type: string + example: Failure + servererror: + type: object + properties: + message: + type: string + example: Internal Server error + status: + type: string + example: Failure + gatewaytimeout: + type: object + properties: + message: + type: string + example: Request Timeout + status: + type: string + example: Failure + inputfieldmissing: + type: object + properties: + message: + type: string + example: Input Field Missing + status: + type: string + example: Failure + inputlimitexceeded: + type: object + properties: + message: + type: string + example: Input Limit Exceeded + status: + type: string + example: Failure + invalidinput: + type: object + properties: + message: + type: string + example: Invalid Input + status: + type: string + example: Failure + versions: + type: object + properties: + v0.1.0: + type: array + items: + oneOf: + - type: string + example: Published Date - November 30, 2020 + description: Initial version release + input: + type: object + required: + + - image_base64 + + properties: + image_base64: + x-name: image_base64 + type: string + default: True + example: /9j/4AAQSkZJRgABAQEASABIAAD/2wBDAAMCAgMCAgMDAwMEAwMEBQgFBQQEBQoHBwYIDAoMDAsKCwsNDhIQDQ4RDgsLEBYQERMUFRUVDA8XGBYUG... + description: |+ + input image's base64 string representation + + + securitySchemes: + APIAuthorizer: + type: apiKey + name: x-api-key + in: header + x-amazon-apigateway-authtype: custom + description: Authentication is done using the x-api-key in the request header diff --git a/yaml/amenities_hardcourts_hdb_sg.yaml b/yaml/amenities_hardcourts_hdb_sg.yaml index 41faaa918..47e3a0f6b 100644 --- a/yaml/amenities_hardcourts_hdb_sg.yaml +++ b/yaml/amenities_hardcourts_hdb_sg.yaml @@ -90,7 +90,13 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/inputlimitexceeded' + $ref: '#/components/schemas/inputlimitexceeded' + '422': + description: Invalid Input + content: + application/json: + schema: + $ref: '#/components/schemas/invalidinput' '500': description: Internal Server Error content: @@ -199,6 +205,15 @@ components: status: type: string example: Failure + invalidinput: + type: object + properties: + message: + type: string + example: Invalid Input + status: + type: string + example: Failure versions: type: object properties: diff --git a/yaml/amenities_lamp_posts_hdb_sg.yaml b/yaml/amenities_lamp_posts_hdb_sg.yaml index 7aad87823..21e1816c0 100644 --- a/yaml/amenities_lamp_posts_hdb_sg.yaml +++ b/yaml/amenities_lamp_posts_hdb_sg.yaml @@ -92,7 +92,13 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/inputlimitexceeded' + $ref: '#/components/schemas/inputlimitexceeded' + '422': + description: Invalid Input + content: + application/json: + schema: + $ref: '#/components/schemas/invalidinput' '500': description: Internal Server Error content: @@ -201,6 +207,15 @@ components: status: type: string example: Failure + invalidinput: + type: object + properties: + message: + type: string + example: Invalid Input + status: + type: string + example: Failure versions: type: object properties: diff --git a/yaml/amenities_shelters_hdb_sg.yaml b/yaml/amenities_shelters_hdb_sg.yaml index d41b3f772..e7614f957 100644 --- a/yaml/amenities_shelters_hdb_sg.yaml +++ b/yaml/amenities_shelters_hdb_sg.yaml @@ -91,7 +91,13 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/inputlimitexceeded' + $ref: '#/components/schemas/inputlimitexceeded' + '422': + description: Invalid Input + content: + application/json: + schema: + $ref: '#/components/schemas/invalidinput' '500': description: Internal Server Error content: @@ -200,6 +206,15 @@ components: status: type: string example: Failure + invalidinput: + type: object + properties: + message: + type: string + example: Invalid Input + status: + type: string + example: Failure versions: type: object properties: diff --git a/yaml/asr_with_voice_activity_detection_eng_sg.yaml b/yaml/asr_with_voice_activity_detection_eng_sg.yaml index ce6cdbf0d..ee319ca1d 100644 --- a/yaml/asr_with_voice_activity_detection_eng_sg.yaml +++ b/yaml/asr_with_voice_activity_detection_eng_sg.yaml @@ -67,6 +67,12 @@ paths: application/json: schema: $ref: '#/components/schemas/inputlimitexceeded' + '422': + description: Invalid Input + content: + application/json: + schema: + $ref: '#/components/schemas/invalidinput' '500': description: Internal Server Error content: @@ -180,6 +186,15 @@ components: status: type: string example: Failure + invalidinput: + type: object + properties: + message: + type: string + example: Invalid Input + status: + type: string + example: Failure input: type: object required: diff --git a/yaml/asr_with_voice_activity_detection_eng_sg_v1.0.yaml b/yaml/asr_with_voice_activity_detection_eng_sg_v1.0.yaml new file mode 100644 index 000000000..a31a86d35 --- /dev/null +++ b/yaml/asr_with_voice_activity_detection_eng_sg_v1.0.yaml @@ -0,0 +1,291 @@ +openapi: 3.0.1 +info: + title: ASR with Voice Activity Detection ENG (SG) + description: |+ + This Voice microservice combines Voice Activity Detection feature and Automatic Speech Recognition capability. It detects speech in an audio file (.wav format) and transcribes English speech content from the audio stream into text. The transcript text is timestamped for each utterance. An utterance is a continuous piece of speech beginning and ending with a clear pause. + + This Voice microservice performs well on Singapore-accented English speech. For best performance, select the model which best matches the use-case: news_parliament, nsc_parliament, nscfull_8k. + + The size of your audio file should be **between 3 KB to 10 MB**. + version: '1.0.0' + x-subscribelink: asr_with_voice_activity_detection_eng_sg +servers: + - url: 'https://dev-apis.sentient.io' +tags: +- name: "v1.0.0" + description: "Published Date - Nov 30, 2020" +paths: + /microservices/voice/vadasr/v1/getpredictions: + post: + tags: + - v1.0.0 + responses: + '200': + description: success response + content: + application/json: + schema: + $ref: '#/components/schemas/success' + example: + results: + results: + - seqNum: 1 + start: 0.64 + end: 23.72 + text: HELLO WORLD + message: Successfully Processed + status: Success + '401': + description: Unauthorized + content: + application/json: + schema: + $ref: '#/components/schemas/unauthorized' + '402': + description: Payment Required + content: + application/json: + schema: + $ref: '#/components/schemas/paymentrequired' + '403': + description: Forbidden + content: + application/json: + schema: + $ref: '#/components/schemas/forbidden' + '404': + description: Not Found + content: + application/json: + schema: + $ref: '#/components/schemas/notfound' + '419': + description: Input Field Missing + content: + application/json: + schema: + $ref: '#/components/schemas/inputfieldmissing' + '420': + description: Input Limit Exceeded + content: + application/json: + schema: + $ref: '#/components/schemas/inputlimitexceeded' + '422': + description: Invalid Input + content: + application/json: + schema: + $ref: '#/components/schemas/invalidinput' + '500': + description: Internal Server Error + content: + application/json: + schema: + $ref: '#/components/schemas/servererror' + '504': + description: Gateway Timeout + content: + application/json: + schema: + $ref: '#/components/schemas/gatewaytimeout' + security: + - APIAuthorizer: [] + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/input' + required: true +components: + schemas: + success: + type: object + properties: + results: + type: object + description: The result of the API call. + example: { "" } + properties: + results: + type: array + example: [{end: 23.72,seqNum: 1,start: 0.64,text: HELLO WORLD }] + description: List of details of start and end time of utterances in the input audio + items: + oneOf: + - type: object + properties: + end: + type: string + example: 23.72 + description: End time of utterance + seqNum: + type: string + example: 1 + description: Running sequence number starts from 1. + start: + type: integer + example: 0.64 + description: Start time of utterance + text: + type: string + description: Converted text from the input audio file + example: THE COMING YEAR LIFE FOR A REASON A CITIZEN OR A LIFETIME LIKE YOU WHEN SOMEONE IS IN YOUR LIFE A REASON IT USUALLY TO MEET IN NEED WITHIN YOU HAVE NEVER MET YOU BUT I LIKE YOU WHEN SOMEONE IS IN YOUR LIFE FOR A SEASON IS BECAUSE IT IS YOUR TURN TO SHARE LEARN AND GROW AND WANT SOMEONE IN YOUR LIFE FOR A LIFETIME IT CITY THROUGH LESSONS AND IF NOT WHAT THE PEOPLE + message: + type: string + example: Successfully Processed + description: Detail description on the API status + status: + type: string + example: Success + description: The status of the API call success/failure + unauthorized: + type: object + properties: + message: + type: string + example: Missing Authentication Token + status: + type: string + example: Failure + forbidden: + type: object + properties: + message: + type: string + example: Access Denied Unauthorized User + status: + type: string + example: Failure + paymentrequired: + type: object + properties: + message: + type: string + example: Insufficient Credits Kindly Top Up + status: + type: string + example: Failure + notfound: + type: object + properties: + message: + type: string + example: Invalid Request URL + status: + type: string + example: Failure + servererror: + type: object + properties: + message: + type: string + example: Internal Server Error + status: + type: string + example: Failure + gatewaytimeout: + type: object + properties: + message: + type: string + example: Request Timeout + status: + type: string + example: Failure + inputfieldmissing: + type: object + properties: + message: + type: string + example: Input Field Missing + status: + type: string + example: Failure + inputlimitexceeded: + type: object + properties: + message: + type: string + example: Input Limit Exceeded + status: + type: string + example: Failure + invalidinput: + type: object + properties: + message: + type: string + example: Invalid Input + status: + type: string + example: Failure + input: + type: object + required: + - model + - wav_base64 + properties: + model: + x-name: model + type: string + default: true + example: news_parliament + description: |+ + Model selection. For best performance, select the model which best matches the use-case: + + 1. news_parliament - 16 kHz, mono channel, .wav format. Trained on Singapore news and parliament corpus. + 2. nsc_parliament - 16 kHz, mono channel, .wav format. Trained on National Speech Corpus and parliament corpus. + 3. nscfull_8k - 8 kHz, mono channel, .wav format. Trained on National Speech Corpus. Trained on Full National Speech Corpus corpus. + wav_base64: + x-name: wav_base64 + type: string + default: true + example: UklGRpxNHQBXQVZFZm10IBAAAAABAAEAgD4AAAB9AAACABAAT ... + description: |+ + Input audio wav file in base64 format. + + Mono channel, 8kHz / 16kHz sampling rate. + file_type: + x-name: file_type + type: string + default: true + example: wav + description: |+ + Input file extension. + + Currently supported formats: .wav + threshold: + x-name: threshold + type: number + format: float + default: true + example: 0.4 + description: |+ + 0.0 to 1.0. Lower will result in more sentence splits. Recommended value is 0.25. + versions: + type: object + properties: + v1.0.0: + type: array + items: + oneOf: + - type: string + example: Published Date - Nov 30,2020 + description: Standardizing Output JSON + + v0.1.0: + type: array + items: + oneOf: + - type: string + example: Published Date - Dec 14,2019 + description: Initial version release + + securitySchemes: + APIAuthorizer: + type: apiKey + name: x-api-key + in: header + x-amazon-apigateway-authtype: custom + description: Authentication is done using the x-api-key in the request header diff --git a/yaml/audio_format_convertor.yaml b/yaml/audio_format_convertor.yaml index eaa54cf06..7aa999b33 100644 --- a/yaml/audio_format_convertor.yaml +++ b/yaml/audio_format_convertor.yaml @@ -64,7 +64,13 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/inputlimitexceeded' + $ref: '#/components/schemas/inputlimitexceeded' + '422': + description: Invalid Input + content: + application/json: + schema: + $ref: '#/components/schemas/invalidinput' '500': description: Internal Server error content: @@ -175,6 +181,15 @@ components: status: type: string example: Failure + invalidinput: + type: object + properties: + message: + type: string + example: Invalid Input + status: + type: string + example: Failure versions: type: object properties: diff --git a/yaml/automatic_speech_recognition_chi_sg.yaml b/yaml/automatic_speech_recognition_chi_sg.yaml index 1a10ed1c6..3d773a61b 100644 --- a/yaml/automatic_speech_recognition_chi_sg.yaml +++ b/yaml/automatic_speech_recognition_chi_sg.yaml @@ -65,6 +65,12 @@ paths: application/json: schema: $ref: '#/components/schemas/inputlimitexceeded' + '422': + description: Invalid Input + content: + application/json: + schema: + $ref: '#/components/schemas/invalidinput' '500': description: Internal Server Error content: @@ -170,6 +176,15 @@ components: status: type: string example: Failure + invalidinput: + type: object + properties: + message: + type: string + example: Invalid Input + status: + type: string + example: Failure input: type: object required: diff --git a/yaml/automatic_speech_recognition_eng_sg.yaml b/yaml/automatic_speech_recognition_eng_sg.yaml index 6e64f6eca..511a1bcdf 100644 --- a/yaml/automatic_speech_recognition_eng_sg.yaml +++ b/yaml/automatic_speech_recognition_eng_sg.yaml @@ -67,7 +67,13 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/inputlimitexceeded' + $ref: '#/components/schemas/inputlimitexceeded' + '422': + description: Invalid Input + content: + application/json: + schema: + $ref: '#/components/schemas/invalidinput' '500': description: Internal Server Error content: @@ -192,6 +198,15 @@ components: status: type: string example: Failure + invalidinput: + type: object + properties: + message: + type: string + example: Invalid Input + status: + type: string + example: Failure input: type: object required: diff --git a/yaml/automatic_speech_recognition_eng_sg_v1.0.yaml b/yaml/automatic_speech_recognition_eng_sg_v1.0.yaml new file mode 100644 index 000000000..81a10b99c --- /dev/null +++ b/yaml/automatic_speech_recognition_eng_sg_v1.0.yaml @@ -0,0 +1,308 @@ +openapi: 3.0.1 +info: + title: Automatic Speech Recognition ENG (SG) + description: |+ + This Voice microservice transcribes the input audio stream into text. + + This microservice performs well on Singaporean-accented English speech. For best performance, select the model which best matches the use-case: news_parliament, nsc_parliament and nscfull_8k. + + The size of your audio file should be **between 3 KB to 10 MB**. + version: '1.0.0' + x-subscribelink: automatic_speech_recognition_eng_sg +servers: + - url: 'https://dev-apis.sentient.io' +tags: +- name: "v1.0.0" + description: "Published Date - Nov 30, 2020" +paths: + /microservices/voice/asr/v1/getpredictions: + post: + tags: + - v1.0.0 + responses: + '200': + description: success response + content: + application/json: + schema: + $ref: '#/components/schemas/success' + example: + results: + results: + - seqNum: 1 + start: 0.64 + end: 23.72 + text: HELLO WORLD + message: Successfully Processed + status: Success + '401': + description: Unauthorized + content: + application/json: + schema: + $ref: '#/components/schemas/unauthorized' + '402': + description: Payment Required + content: + application/json: + schema: + $ref: '#/components/schemas/paymentrequired' + '403': + description: Forbidden + content: + application/json: + schema: + $ref: '#/components/schemas/forbidden' + '404': + description: Not Found + content: + application/json: + schema: + $ref: '#/components/schemas/notfound' + '419': + description: Input Field Missing + content: + application/json: + schema: + $ref: '#/components/schemas/inputfieldmissing' + '420': + description: Input Limit Exceeded + content: + application/json: + schema: + $ref: '#/components/schemas/inputlimitexceeded' + '422': + description: Invalid Input + content: + application/json: + schema: + $ref: '#/components/schemas/invalidinput' + '500': + description: Internal Server Error + content: + application/json: + schema: + $ref: '#/components/schemas/servererror' + '504': + description: Gateway Timeout + content: + application/json: + schema: + $ref: '#/components/schemas/gatewaytimeout' + security: + - APIAuthorizer: [] + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/input' + required: true +components: + schemas: + success: + type: object + properties: + results: + type: object + description: The result of the API call. + example: { "" } + properties: + results: + type: array + example: [{ "" }] + description: List of Json Objects + items: + oneOf: + - type: object + example: {seqNum: 1,start: 1.0,end: 4.0,text: HELLO WORLD} + properties: + end: + type: number + format: float + example: 23.72 + description: End time of utterance in seconds + seqNum: + type: number + example: 1 + description: Running sequence. Starts from 1. + start: + type: number + format: float + example: 0.64 + description: Start time of utterance in seconds + text: + type: string + description: Converted text from the input audio file + example: THE COMING YEAR LIFE FOR A REASON A CITIZEN OR A LIFETIME LIKE YOU WHEN SOMEONE IS IN YOUR LIFE A REASON IT USUALLY TO MEET IN NEED WITHIN YOU HAVE NEVER MET YOU BUT I LIKE YOU WHEN SOMEONE IS IN YOUR LIFE FOR A SEASON IS BECAUSE IT IS YOUR TURN TO SHARE LEARN AND GROW AND WANT SOMEONE IN YOUR LIFE FOR A LIFETIME IT CITY THROUGH LESSONS AND IF NOT WHAT THE PEOPLE + message: + type: string + example: Successfully Processed + description: Detail description on the API status + status: + type: string + example: Success + description: The status of the API call success/failure + unauthorized: + type: object + properties: + message: + type: string + example: Missing Authentication Token + status: + type: string + example: Failure + forbidden: + type: object + properties: + message: + type: string + example: Access Denied Unauthorized User + status: + type: string + example: Failure + paymentrequired: + type: object + properties: + message: + type: string + example: Insufficient Credits Kindly Top Up + status: + type: string + example: Failure + notfound: + type: object + properties: + message: + type: string + example: Invalid Request URL + status: + type: string + example: Failure + servererror: + type: object + properties: + message: + type: string + example: Internal Server Error + status: + type: string + example: Failure + gatewaytimeout: + type: object + properties: + message: + type: string + example: Request Timeout + status: + type: string + example: Failure + inputfieldmissing: + type: object + properties: + message: + type: string + example: Input Field Missing + status: + type: string + example: Failure + inputlimitexceeded: + type: object + properties: + message: + type: string + example: Input Limit Exceeded + status: + type: string + example: Failure + invalidinput: + type: object + properties: + message: + type: string + example: Invalid Input + status: + type: string + example: Failure + input: + type: object + required: + - model + - wav_base64 + properties: + model: + x-name: model + type: string + default: true + example: nsc_parliament + description: |+ + Model selection. For best performance, select the model which best matches the use-case: + + 1. news_parliament - 16 kHz, mono channel, .wav format. Trained on Singapore news and parliament corpus. + 2. nsc_parliament - 16 kHz, mono channel, .wav format. Trained on National Speech Corpus and parliament corpus. + 3. nscfull_8k - 8 kHz, mono channel, .wav format. Trained on National Speech Corpus. Trained on Full National Speech Corpus corpus. + wav_base64: + x-name: wav_base64 + type: string + default: true + example: UklGRkbiBABXQVZFZm10IBAAAAABA... + description: |+ + Input wav file in base64 format. + srt: + x-name: srt + type: array + default: false + example: [{seqNum: 1,start: 1.0,end: 4.0}] + description: |+ + Optional. An ordered array of utterance struct. Used for time-coding. + items: + oneOf: + - type: object + properties: + end: + x-name: end + type: number + format: float + default: false + example: "4.0" + description: |+ + "End time of utterance, in seconds. Offset from the start of stream." + seqNum: + x-name: seqNum + type: number + default: false + example: "1" + description: |+ + "Running sequence. Starts from 1." + start: + x-name: start + type: number + format: float + default: false + example: "1.0" + description: |+ + "Start time of utterance, in seconds. Offset from the start of stream." + versions: + type: object + properties: + v1.0.0: + type: array + items: + oneOf: + - type: string + example: Published Date - Nov 30,2020 + description: Standardizing Output JSON + + v0.1.0: + type: array + items: + oneOf: + - type: string + example: Published Date - Jul 03,2020 + description: Initial version release + securitySchemes: + APIAuthorizer: + type: apiKey + name: x-api-key + in: header + x-amazon-apigateway-authtype: custom + description: Authentication is done using the x-api-key in the request header. diff --git a/yaml/automatic_voice_recognition_eng.yaml b/yaml/automatic_voice_recognition_eng.yaml index 9a3645a81..9f6dce44b 100644 --- a/yaml/automatic_voice_recognition_eng.yaml +++ b/yaml/automatic_voice_recognition_eng.yaml @@ -64,6 +64,12 @@ paths: application/json: schema: $ref: '#/components/schemas/inputlimitexceeded' + '422': + description: Invalid Input + content: + application/json: + schema: + $ref: '#/components/schemas/invalidinput' '500': description: Internal Server Error content: @@ -171,6 +177,15 @@ components: status: type: string example: Failure + invalidinput: + type: object + properties: + message: + type: string + example: Invalid Input + status: + type: string + example: Failure input: type: object required: diff --git a/yaml/base64-file-decode.yaml b/yaml/base64-file-decode.yaml index 10c7cf266..dc1ce2661 100644 --- a/yaml/base64-file-decode.yaml +++ b/yaml/base64-file-decode.yaml @@ -61,7 +61,13 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/inputlimitexceeded' + $ref: '#/components/schemas/inputlimitexceeded' + '422': + description: Invalid Input + content: + application/json: + schema: + $ref: '#/components/schemas/invalidinput' '500': description: Internal Server Error content: @@ -170,7 +176,16 @@ components: example: Input Limit Exceeded status: type: string - example: Failure + example: Failure + invalidinput: + type: object + properties: + message: + type: string + example: Invalid Input + status: + type: string + example: Failure versions: type: object properties: diff --git a/yaml/base64-file-encode.yaml b/yaml/base64-file-encode.yaml index 27d1119fa..bf5a9d699 100644 --- a/yaml/base64-file-encode.yaml +++ b/yaml/base64-file-encode.yaml @@ -62,7 +62,13 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/inputlimitexceeded' + $ref: '#/components/schemas/inputlimitexceeded' + '422': + description: Invalid Input + content: + application/json: + schema: + $ref: '#/components/schemas/invalidinput' '500': description: Internal Server Error content: @@ -177,7 +183,16 @@ components: example: Input Limit Exceeded status: type: string - example: Failure + example: Failure + invalidinput: + type: object + properties: + message: + type: string + example: Invalid Input + status: + type: string + example: Failure input: type: object required: diff --git a/yaml/building_addresses_hdb_sg.yaml b/yaml/building_addresses_hdb_sg.yaml index aadb938ab..281883ad3 100644 --- a/yaml/building_addresses_hdb_sg.yaml +++ b/yaml/building_addresses_hdb_sg.yaml @@ -200,7 +200,13 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/inputlimitexceeded' + $ref: '#/components/schemas/inputlimitexceeded' + '422': + description: Invalid Input + content: + application/json: + schema: + $ref: '#/components/schemas/invalidinput' '500': description: Internal Server Error content: @@ -377,7 +383,16 @@ components: example: Input Limit Exceeded status: type: string - example: Failure + example: Failure + invalidinput: + type: object + properties: + message: + type: string + example: Invalid Input + status: + type: string + example: Failure versions: type: object properties: diff --git a/yaml/carpark_hdb_sg.yaml b/yaml/carpark_hdb_sg.yaml index e5f01e595..4f67ca45f 100644 --- a/yaml/carpark_hdb_sg.yaml +++ b/yaml/carpark_hdb_sg.yaml @@ -247,7 +247,13 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/inputlimitexceeded' + $ref: '#/components/schemas/inputlimitexceeded' + '422': + description: Invalid Input + content: + application/json: + schema: + $ref: '#/components/schemas/invalidinput' '500': description: Internal Server Error content: @@ -457,6 +463,15 @@ components: status: type: string example: Failure + invalidinput: + type: object + properties: + message: + type: string + example: Invalid Input + status: + type: string + example: Failure versions: type: object properties: diff --git a/yaml/commercial_directories_hdb_sg.yaml b/yaml/commercial_directories_hdb_sg.yaml index df9b6e5e1..cd456aa63 100644 --- a/yaml/commercial_directories_hdb_sg.yaml +++ b/yaml/commercial_directories_hdb_sg.yaml @@ -231,7 +231,13 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/inputlimitexceeded' + $ref: '#/components/schemas/inputlimitexceeded' + '422': + description: Invalid Input + content: + application/json: + schema: + $ref: '#/components/schemas/invalidinput' '500': description: Internal Server Error content: @@ -484,6 +490,15 @@ components: status: type: string example: Failure + invalidinput: + type: object + properties: + message: + type: string + example: Invalid Input + status: + type: string + example: Failure versions: type: object properties: diff --git a/yaml/csv-json_convertor.yaml b/yaml/csv-json_convertor.yaml index 618a431f5..4d8abd8bc 100644 --- a/yaml/csv-json_convertor.yaml +++ b/yaml/csv-json_convertor.yaml @@ -65,7 +65,13 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/inputlimitexceeded' + $ref: '#/components/schemas/inputlimitexceeded' + '422': + description: Invalid Input + content: + application/json: + schema: + $ref: '#/components/schemas/invalidinput' '500': description: Internal Server Error content: @@ -194,6 +200,15 @@ components: - type: string example: Published Date - May 15, 2020 description: Initial version release + invalidinput: + type: object + properties: + message: + type: string + example: Invalid Input + status: + type: string + example: Failure input: type: object required: diff --git a/yaml/d&b_basic_individual_search_sg.yaml b/yaml/d&b_basic_individual_search_sg.yaml index d9cf0ef93..bffa806a8 100644 --- a/yaml/d&b_basic_individual_search_sg.yaml +++ b/yaml/d&b_basic_individual_search_sg.yaml @@ -132,6 +132,12 @@ paths: application/json: schema: $ref: '#/components/schemas/inputlimitexceeded' + '422': + description: Invalid Input + content: + application/json: + schema: + $ref: '#/components/schemas/invalidinput' '500': description: Internal Server Error content: @@ -1243,6 +1249,15 @@ components: status: type: string example: Failure + invalidinput: + type: object + properties: + message: + type: string + example: Invalid Input + status: + type: string + example: Failure REQUEST: type: object properties: diff --git a/yaml/d&b_brief_financial_information_sg.yaml b/yaml/d&b_brief_financial_information_sg.yaml index e921954c9..696216211 100644 --- a/yaml/d&b_brief_financial_information_sg.yaml +++ b/yaml/d&b_brief_financial_information_sg.yaml @@ -90,7 +90,13 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/inputlimitexceeded' + $ref: '#/components/schemas/inputlimitexceeded' + '422': + description: Invalid Input + content: + application/json: + schema: + $ref: '#/components/schemas/invalidinput' '500': description: Internal Server Error content: @@ -1340,6 +1346,15 @@ components: status: type: string example: Failure + invalidinput: + type: object + properties: + message: + type: string + example: Invalid Input + status: + type: string + example: Failure REQUEST: type: object properties: diff --git a/yaml/d&b_business_check_plus_sg.yaml b/yaml/d&b_business_check_plus_sg.yaml index abd4f3e57..2053894c8 100644 --- a/yaml/d&b_business_check_plus_sg.yaml +++ b/yaml/d&b_business_check_plus_sg.yaml @@ -255,7 +255,13 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/inputlimitexceeded' + $ref: '#/components/schemas/inputlimitexceeded' + '422': + description: Invalid Input + content: + application/json: + schema: + $ref: '#/components/schemas/invalidinput' '500': description: Internal Server Error content: @@ -1641,6 +1647,15 @@ components: status: type: string example: Failure + invalidinput: + type: object + properties: + message: + type: string + example: Invalid Input + status: + type: string + example: Failure REQUEST: type: object properties: diff --git a/yaml/d&b_business_check_sg.yaml b/yaml/d&b_business_check_sg.yaml index b18197d15..6ed27c1ba 100644 --- a/yaml/d&b_business_check_sg.yaml +++ b/yaml/d&b_business_check_sg.yaml @@ -69,7 +69,13 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/inputlimitexceeded' + $ref: '#/components/schemas/inputlimitexceeded' + '422': + description: Invalid Input + content: + application/json: + schema: + $ref: '#/components/schemas/invalidinput' '500': description: Internal Server Error content: @@ -1079,6 +1085,15 @@ components: status: type: string example: Failure + invalidinput: + type: object + properties: + message: + type: string + example: Invalid Input + status: + type: string + example: Failure REQUEST: type: object properties: diff --git a/yaml/decryption_using_pki_key.yaml b/yaml/decryption_using_pki_key.yaml index 71cceb45e..27b337bd9 100644 --- a/yaml/decryption_using_pki_key.yaml +++ b/yaml/decryption_using_pki_key.yaml @@ -65,7 +65,13 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/inputlimitexceeded' + $ref: '#/components/schemas/inputlimitexceeded' + '422': + description: Invalid Input + content: + application/json: + schema: + $ref: '#/components/schemas/invalidinput' '500': description: Internal Server Error content: @@ -174,7 +180,16 @@ components: example: Input Limit Exceeded status: type: string - example: Failure + example: Failure + invalidinput: + type: object + properties: + message: + type: string + example: Invalid Input + status: + type: string + example: Failure versions: type: object properties: diff --git a/yaml/demographics_hdb_sg.yaml b/yaml/demographics_hdb_sg.yaml index b33449416..d1e209809 100644 --- a/yaml/demographics_hdb_sg.yaml +++ b/yaml/demographics_hdb_sg.yaml @@ -197,7 +197,13 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/inputlimitexceeded' + $ref: '#/components/schemas/inputlimitexceeded' + '422': + description: Invalid Input + content: + application/json: + schema: + $ref: '#/components/schemas/invalidinput' '500': description: Internal Server Error content: @@ -411,7 +417,16 @@ components: example: Input Limit Exceeded status: type: string - example: Failure + example: Failure + invalidinput: + type: object + properties: + message: + type: string + example: Invalid Input + status: + type: string + example: Failure versions: type: object properties: diff --git a/yaml/directory_of_singapore_startups.yaml b/yaml/directory_of_singapore_startups.yaml index 84f758f9f..0025a8d8f 100644 --- a/yaml/directory_of_singapore_startups.yaml +++ b/yaml/directory_of_singapore_startups.yaml @@ -219,7 +219,13 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/inputlimitexceeded' + $ref: '#/components/schemas/inputlimitexceeded' + '422': + description: Invalid Input + content: + application/json: + schema: + $ref: '#/components/schemas/invalidinput' '500': description: Internal Server Error content: @@ -511,6 +517,15 @@ components: status: type: string example: Failure + invalidinput: + type: object + properties: + message: + type: string + example: Invalid Input + status: + type: string + example: Failure versions: type: object properties: diff --git a/yaml/document_convertor_eng.yaml b/yaml/document_convertor_eng.yaml index edc12df21..6a1c177c3 100644 --- a/yaml/document_convertor_eng.yaml +++ b/yaml/document_convertor_eng.yaml @@ -68,6 +68,12 @@ paths: application/json: schema: $ref: '#/components/schemas/inputlimitexceeded' + '422': + description: Invalid Input + content: + application/json: + schema: + $ref: '#/components/schemas/invalidinput' '500': description: Internal Server Error content: @@ -175,7 +181,16 @@ components: example: Input Limit Exceeded status: type: string - example: Failure + example: Failure + invalidinput: + type: object + properties: + message: + type: string + example: Invalid Input + status: + type: string + example: Failure versions: type: object properties: diff --git a/yaml/encryption_using_pki_key.yaml b/yaml/encryption_using_pki_key.yaml index d42324023..32d3e90e0 100644 --- a/yaml/encryption_using_pki_key.yaml +++ b/yaml/encryption_using_pki_key.yaml @@ -65,7 +65,13 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/inputlimitexceeded' + $ref: '#/components/schemas/inputlimitexceeded' + '422': + description: Invalid Input + content: + application/json: + schema: + $ref: '#/components/schemas/invalidinput' '500': description: Internal Server Error content: @@ -174,7 +180,16 @@ components: example: Input Limit Exceeded status: type: string - example: Failure + example: Failure + invalidinput: + type: object + properties: + message: + type: string + example: Invalid Input + status: + type: string + example: Failure input: type: object properties: diff --git a/yaml/face_recognition_politicians_sg.yaml b/yaml/face_recognition_politicians_sg.yaml index 0c058b761..dcf5cf2a3 100644 --- a/yaml/face_recognition_politicians_sg.yaml +++ b/yaml/face_recognition_politicians_sg.yaml @@ -6,7 +6,7 @@ info: This microservice returns the identity of the person, the bounding box in image coordinates, and the confidence of the prediction. - The size of your image file should **not exceed 5 MB**, and the image dimension should be **least more than 416x416 pixels**. + The size of your image file should **not exceed 5 MB**, and the image dimension should be **at least 416x416 pixels**. version: '0.1.0' x-subscribelink: face_recognition_politicians_sg servers: @@ -63,7 +63,13 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/inputlimitexceeded' + $ref: '#/components/schemas/inputlimitexceeded' + '422': + description: Invalid Input + content: + application/json: + schema: + $ref: '#/components/schemas/invalidinput' '500': description: Internal Server Error content: @@ -206,6 +212,15 @@ components: - type: string example: Published Date - Jul 03,2020 description: Initial version release + invalidinput: + type: object + properties: + message: + type: string + example: Invalid Input + status: + type: string + example: Failure input: type: object required: diff --git a/yaml/face_recognition_politicians_sg_v1.0.yaml b/yaml/face_recognition_politicians_sg_v1.0.yaml new file mode 100644 index 000000000..2eda9f146 --- /dev/null +++ b/yaml/face_recognition_politicians_sg_v1.0.yaml @@ -0,0 +1,303 @@ +openapi: 3.0.1 +info: + title: Face Recognition Politicians (SG) + description: |+ + This Computer Vision microservice recognises faces from input image files of Singapore Members of Parliament and Japan Public figures. + + This microservice returns the identity of the person, the bounding box in image coordinates, and the confidence of the prediction. + Some models also provide the option to filter the returned identity based on predefined attributes" + + The size of your image file should **not exceed 5 MB**, and the image dimension should be **at least 416x416 pixels**. + version: '1.0.0' + x-subscribelink: face_recognition_politicians_sg +servers: + - url: 'https://dev-apis.sentient.io' +tags: +- name: "v1.0.0" + description: "Published Date - Nov 30, 2020" +paths: + /microservices/cv/facerecognition/v1/getpredictions: + post: + tags: + - v1.0.0 + responses: + '200': + description: success response + content: + application/json: + schema: + $ref: '#/components/schemas/success' + example: + results: + results: {conf: 0.6588699206768599,identity: "Lee Hsien Loong",location: [67,339,196,210]} + message: Successfully Processed + status: Success + '401': + description: Unauthorized + content: + application/json: + schema: + $ref: '#/components/schemas/unauthorized' + '402': + description: Payment Required + content: + application/json: + schema: + $ref: '#/components/schemas/paymentrequired' + '403': + description: Forbidden + content: + application/json: + schema: + $ref: '#/components/schemas/forbidden' + '404': + description: Not Found + content: + application/json: + schema: + $ref: '#/components/schemas/notfound' + '419': + description: Input Field Missing + content: + application/json: + schema: + $ref: '#/components/schemas/inputfieldmissing' + '420': + description: Input Limit Exceeded + content: + application/json: + schema: + $ref: '#/components/schemas/inputlimitexceeded' + '422': + description: Invalid Input + content: + application/json: + schema: + $ref: '#/components/schemas/invalidinput' + '500': + description: Internal Server Error + content: + application/json: + schema: + $ref: '#/components/schemas/servererror' + '504': + description: Gateway Timeout + content: + application/json: + schema: + $ref: '#/components/schemas/gatewaytimeout' + security: + - APIAuthorizer: [] + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/input' + required: true +components: + schemas: + success: + type: object + properties: + results: + type: object + description: The result of the API call. + example: { "" } + properties: + results: + type: array + example: {conf: 0.6588699206768599,identity: "Lee Hsien Loong",location: [67,339,196,210]} + description: Details of the face recognised from the image + items: + oneOf: + - type: object + properties: + conf: + type: number + format: float + example: 0.6588699206768599 + description: 0.0 to 1.0. Confidence score of identification. Higher is more confidence. + identity: + type: string + example: Lee Hsien Loong + description: Person's formal name. If identity is not known, "UNKNOWN" is returned + location: + type: array + example: [67,339,196,210] + description: bounding box of the face in pixel coordinates of top, right, bottom, left. + items: + oneOf: + - type: number + example: 67 + message: + type: string + example: Successfully Processed + description: Detail description on the API status + status: + type: string + example: Success + description: The status of the API call success/failure + + unauthorized: + type: object + properties: + message: + type: string + example: Missing Authentication Token + status: + type: string + example: Failure + restricted: + type: object + properties: + message: + type: string + example: The content is restricted + status: + type: string + example: Failure + forbidden: + type: object + properties: + message: + type: string + example: Access Denied Unauthorized User + status: + type: string + example: Failure + paymentrequired: + type: object + properties: + message: + type: string + example: Insufficient Credits Kindly Top Up + status: + type: string + example: Failure + notfound: + type: object + properties: + message: + type: string + example: Invalid Request + status: + type: string + example: Failure + servererror: + type: object + properties: + message: + type: string + example: Internal Server Error + status: + type: string + example: Failure + gatewaytimeout: + type: object + properties: + message: + type: string + example: Request Timeout + status: + type: string + example: Failure + inputfieldmissing: + type: object + properties: + message: + type: string + example: Input Field Missing + status: + type: string + example: Failure + inputlimitexceeded: + type: object + properties: + message: + type: string + example: Input Limit Exceeded + status: + type: string + example: Failure + invalidinput: + type: object + properties: + message: + type: string + example: Invalid Input + status: + type: string + example: Failure + versions: + type: object + properties: + v1.0.0: + type: array + items: + oneOf: + - type: string + example: Published Date - Nov 30,2020 + description: Standardizing Output JSON and model update + + v0.1.0: + type: array + items: + oneOf: + - type: string + example: Published Date - Jul 03,2020 + description: Initial version release + input: + type: object + required: + - model + - image_base64 + properties: + model: + x-name: model + type: string + default: true + example: sg-parliament-2019 + description: |+ + Model names. + sg-parliament-2019 is trained on Singapore Members of Parliament - 2019. + sg-parliament-2020 is trained on Singapore Members of Parliament - 2020. + sg-jp-2020 is trained on Singapore and Japan public figures - 2020. + image_base64: + x-name: image_base64 + type: string + default: true + example: UklGRkbiBABXQVZFZm10IBAAAAABA... + description: |+ + Input image file in base64 format + file_type: + x-name: file_type + type: string + default: false + example: jpg + description: |+ + Type of image file. If not specified, the type of file is detected and processed. + + Refer to Python Imaging Library (PIL) for supported formats: bmp, gif, jpg/jpeg, png. + threshold: + x-name: threshold + type: integer + format: float + default: false + example: 0.5 + description: |+ + 0.0 to 1.0. Default is 0.4. Higher threshold will return results with higher confidence. + filter: + x-name: filter + type: array + default: false + example: ["Japan", "television_actors"] + description: |+ + Filter list of attributes to reduce wrong matches. Supported attributes are model-dependent. + + securitySchemes: + APIAuthorizer: + type: apiKey + name: x-api-key + in: header + x-amazon-apigateway-authtype: custom + description: Authentication is done using the x-api-key in the request header diff --git a/yaml/fitness_stations_and_playgrounds_hdb_sg.yaml b/yaml/fitness_stations_and_playgrounds_hdb_sg.yaml index d112d3441..745a5833a 100644 --- a/yaml/fitness_stations_and_playgrounds_hdb_sg.yaml +++ b/yaml/fitness_stations_and_playgrounds_hdb_sg.yaml @@ -92,6 +92,12 @@ paths: application/json: schema: $ref: '#/components/schemas/inputlimitexceeded' + '422': + description: Invalid Input + content: + application/json: + schema: + $ref: '#/components/schemas/invalidinput' '500': description: Internal Server Error content: @@ -200,6 +206,15 @@ components: status: type: string example: Failure + invalidinput: + type: object + properties: + message: + type: string + example: Invalid Input + status: + type: string + example: Failure versions: type: object properties: diff --git a/yaml/flat_ownership_hdb_sg.yaml b/yaml/flat_ownership_hdb_sg.yaml index 8a4e17d8d..da8584d10 100644 --- a/yaml/flat_ownership_hdb_sg.yaml +++ b/yaml/flat_ownership_hdb_sg.yaml @@ -203,7 +203,13 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/inputlimitexceeded' + $ref: '#/components/schemas/inputlimitexceeded' + '422': + description: Invalid Input + content: + application/json: + schema: + $ref: '#/components/schemas/invalidinput' '500': description: Internal Server Error content: @@ -412,7 +418,16 @@ components: example: Input Limit Exceeded status: type: string - example: Failure + example: Failure + invalidinput: + type: object + properties: + message: + type: string + example: Invalid Input + status: + type: string + example: Failure versions: type: object properties: diff --git a/yaml/inverse_text_normalisation_eng.yaml b/yaml/inverse_text_normalisation_eng.yaml index e9f8a84bf..bc50418e8 100644 --- a/yaml/inverse_text_normalisation_eng.yaml +++ b/yaml/inverse_text_normalisation_eng.yaml @@ -73,7 +73,13 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/inputlimitexceeded' + $ref: '#/components/schemas/inputlimitexceeded' + '422': + description: Invalid Input + content: + application/json: + schema: + $ref: '#/components/schemas/invalidinput' '500': description: Internal Server Error content: @@ -174,7 +180,16 @@ components: example: Input Limit Exceeded status: type: string - example: Failure + example: Failure + invalidinput: + type: object + properties: + message: + type: string + example: Invalid Input + status: + type: string + example: Failure versions: type: object properties: diff --git a/yaml/inverse_text_normalisation_eng_v1.0.yaml b/yaml/inverse_text_normalisation_eng_v1.0.yaml index 6d5cb2e3f..5779a4b2b 100644 --- a/yaml/inverse_text_normalisation_eng_v1.0.yaml +++ b/yaml/inverse_text_normalisation_eng_v1.0.yaml @@ -5,6 +5,8 @@ info: This NLP microservice recovers the missing punctuations such as full stop, comma, exclamation mark, and question mark from the input text. It converts pre-defined abbreviations from lower case to upper case and also first letters of sentences to upper case. + + Do ensure that your text is within **5000 characters**. version: '1.0.0' x-subscribelink: inverse_text_normalisation_eng servers: @@ -74,7 +76,13 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/inputlimitexceeded' + $ref: '#/components/schemas/inputlimitexceeded' + '422': + description: Invalid Input + content: + application/json: + schema: + $ref: '#/components/schemas/invalidinput' '500': description: Internal Server Error content: @@ -189,7 +197,16 @@ components: example: Input Limit Exceeded status: type: string - example: Failure + example: Failure + invalidinput: + type: object + properties: + message: + type: string + example: Invalid Input + status: + type: string + example: Failure versions: type: object properties: diff --git a/yaml/json-csv_convertor.yaml b/yaml/json-csv_convertor.yaml index 2ce5da149..d3878813d 100644 --- a/yaml/json-csv_convertor.yaml +++ b/yaml/json-csv_convertor.yaml @@ -62,7 +62,13 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/inputlimitexceeded' + $ref: '#/components/schemas/inputlimitexceeded' + '422': + description: Invalid Input + content: + application/json: + schema: + $ref: '#/components/schemas/invalidinput' '500': description: Internal Server Error content: @@ -178,7 +184,16 @@ components: example: Input Limit Exceeded status: type: string - example: Failure + example: Failure + invalidinput: + type: object + properties: + message: + type: string + example: Invalid Input + status: + type: string + example: Failure input1: type: object properties: diff --git a/yaml/landmark_detection_jp.yaml b/yaml/landmark_detection_jp.yaml index 73500f37e..cb741ff3a 100644 --- a/yaml/landmark_detection_jp.yaml +++ b/yaml/landmark_detection_jp.yaml @@ -64,7 +64,13 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/inputlimitexceeded' + $ref: '#/components/schemas/inputlimitexceeded' + '422': + description: Invalid Input + content: + application/json: + schema: + $ref: '#/components/schemas/invalidinput' '500': description: Internal Server Error content: @@ -187,6 +193,15 @@ components: status: type: string example: Failure + invalidinput: + type: object + properties: + message: + type: string + example: Invalid Input + status: + type: string + example: Failure versions: type: object properties: diff --git a/yaml/landmark_detection_sg.yaml b/yaml/landmark_detection_sg.yaml index 55ea983f4..23e60a22b 100644 --- a/yaml/landmark_detection_sg.yaml +++ b/yaml/landmark_detection_sg.yaml @@ -66,7 +66,13 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/inputlimitexceeded' + $ref: '#/components/schemas/inputlimitexceeded' + '422': + description: Invalid Input + content: + application/json: + schema: + $ref: '#/components/schemas/invalidinput' '500': description: Internal Server Error content: @@ -189,6 +195,15 @@ components: status: type: string example: Failure + invalidinput: + type: object + properties: + message: + type: string + example: Invalid Input + status: + type: string + example: Failure versions: type: object properties: diff --git a/yaml/named-entity_recognition_eng.yaml b/yaml/named-entity_recognition_eng.yaml index ffa31aea2..235af98ed 100644 --- a/yaml/named-entity_recognition_eng.yaml +++ b/yaml/named-entity_recognition_eng.yaml @@ -83,7 +83,13 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/inputlimitexceeded' + $ref: '#/components/schemas/inputlimitexceeded' + '422': + description: Invalid Input + content: + application/json: + schema: + $ref: '#/components/schemas/invalidinput' '500': description: Internal Server Error content: @@ -201,7 +207,16 @@ components: example: Input Limit Exceeded status: type: string - example: Failure + example: Failure + invalidinput: + type: object + properties: + message: + type: string + example: Invalid Input + status: + type: string + example: Failure versions: type: object properties: diff --git a/yaml/named-entity_recognition_eng_v1.0.yaml b/yaml/named-entity_recognition_eng_v1.0.yaml index 666b05305..ec66569ba 100644 --- a/yaml/named-entity_recognition_eng_v1.0.yaml +++ b/yaml/named-entity_recognition_eng_v1.0.yaml @@ -64,7 +64,13 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/inputlimitexceeded' + $ref: '#/components/schemas/inputlimitexceeded' + '422': + description: Invalid Input + content: + application/json: + schema: + $ref: '#/components/schemas/invalidinput' '500': description: Internal Server Error content: @@ -209,6 +215,15 @@ components: status: type: string example: Failure + invalidinput: + type: object + properties: + message: + type: string + example: Invalid Input + status: + type: string + example: Failure versions: type: object properties: diff --git a/yaml/named-entity_recognition_jp.yaml b/yaml/named-entity_recognition_jp.yaml index 1edfa37cf..2992651aa 100644 --- a/yaml/named-entity_recognition_jp.yaml +++ b/yaml/named-entity_recognition_jp.yaml @@ -77,7 +77,13 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/inputlimitexceeded' + $ref: '#/components/schemas/inputlimitexceeded' + '422': + description: Invalid Input + content: + application/json: + schema: + $ref: '#/components/schemas/invalidinput' '500': description: Internal Server Error content: @@ -195,6 +201,15 @@ components: status: type: string example: Failure + invalidinput: + type: object + properties: + message: + type: string + example: Invalid Input + status: + type: string + example: Failure versions: type: object properties: diff --git a/yaml/named-entity_recognition_jp_v1.0.yaml b/yaml/named-entity_recognition_jp_v1.0.yaml index 50f06436d..41b1bdecb 100644 --- a/yaml/named-entity_recognition_jp_v1.0.yaml +++ b/yaml/named-entity_recognition_jp_v1.0.yaml @@ -90,7 +90,13 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/inputlimitexceeded' + $ref: '#/components/schemas/inputlimitexceeded' + '422': + description: Invalid Input + content: + application/json: + schema: + $ref: '#/components/schemas/invalidinput' '500': description: Internal Server Error content: @@ -269,6 +275,15 @@ components: status: type: string example: Failure + invalidinput: + type: object + properties: + message: + type: string + example: Invalid Input + status: + type: string + example: Failure versions: type: object properties: diff --git a/yaml/named-entity_recognition_thai.yaml b/yaml/named-entity_recognition_thai.yaml index 7c49be28c..fd4d13fc0 100644 --- a/yaml/named-entity_recognition_thai.yaml +++ b/yaml/named-entity_recognition_thai.yaml @@ -67,7 +67,13 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/inputlimitexceeded' + $ref: '#/components/schemas/inputlimitexceeded' + '422': + description: Invalid Input + content: + application/json: + schema: + $ref: '#/components/schemas/invalidinput' '500': description: Internal Server Error content: @@ -168,6 +174,15 @@ components: status: type: string example: Failure + invalidinput: + type: object + properties: + message: + type: string + example: Invalid Input + status: + type: string + example: Failure inputlimitexceeded: type: object properties: diff --git a/yaml/named-entity_recognition_thai_v1.0.yaml b/yaml/named-entity_recognition_thai_v1.0.yaml index 673e7f461..1ff2cdd4a 100644 --- a/yaml/named-entity_recognition_thai_v1.0.yaml +++ b/yaml/named-entity_recognition_thai_v1.0.yaml @@ -84,7 +84,13 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/inputlimitexceeded' + $ref: '#/components/schemas/inputlimitexceeded' + '422': + description: Invalid Input + content: + application/json: + schema: + $ref: '#/components/schemas/invalidinput' '500': description: Internal Server Error content: @@ -233,6 +239,15 @@ components: status: type: string example: Failure + invalidinput: + type: object + properties: + message: + type: string + example: Invalid Input + status: + type: string + example: Failure servererror: type: object properties: diff --git a/yaml/newspaper_article_scraper.yaml b/yaml/newspaper_article_scraper.yaml index 9361a9949..fee96b0c6 100644 --- a/yaml/newspaper_article_scraper.yaml +++ b/yaml/newspaper_article_scraper.yaml @@ -101,7 +101,13 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/inputlimitexceeded' + $ref: '#/components/schemas/inputlimitexceeded' + '422': + description: Invalid Input + content: + application/json: + schema: + $ref: '#/components/schemas/invalidinput' '500': description: Internal Server Error content: @@ -269,6 +275,15 @@ components: status: type: string example: Failure + invalidinput: + type: object + properties: + message: + type: string + example: Invalid Input + status: + type: string + example: Failure inputlimitexceeded: type: object properties: diff --git a/yaml/object_detection.yaml b/yaml/object_detection.yaml index 60fcc3ec7..a43ca866b 100644 --- a/yaml/object_detection.yaml +++ b/yaml/object_detection.yaml @@ -8,7 +8,7 @@ info: The classes are: person, bicycle, car, motorbike, aeroplane, bus, train, truck, boat, traffic light, fire hydrant, stop sign, parking meter, bench, bird, cat, dog, horse, sheep, cow, elephant, bear, zebra, giraffe, backpack, umbrella, handbag, tie, suitcase, frisbee, skis, snowboard, sports ball, kite, baseball bat, baseball glove, skateboard, surfboard, tennis racket, bottle, wine glass, cup, fork, knife, spoon, bowl, banana, apple, sandwich, orange, broccoli, carrot, hot dog, pizza, donut, cake, chair, sofa, pottedplant, bed, diningtable, toilet, tvmonitor, laptop, mouse, remote, keyboard, cell phone, microwave, oven, toaster, sink, refrigerator, book, clock, vase, scissors, teddy bear, hair drier, toothbrush. - The size of your image file should **not exceed 5 MB**, and the image dimension should be **least more than 416x416 pixels**. + The size of your image file should **not exceed 5 MB**, and the image dimension should be **at least 416x416 pixels**. version: '0.1.0' x-subscribelink: object_detection servers: @@ -65,7 +65,13 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/inputlimitexceeded' + $ref: '#/components/schemas/inputlimitexceeded' + '422': + description: Invalid Input + content: + application/json: + schema: + $ref: '#/components/schemas/invalidinput' '500': description: Internal Server Error content: @@ -176,6 +182,15 @@ components: status: type: string example: Failure + invalidinput: + type: object + properties: + message: + type: string + example: Invalid Input + status: + type: string + example: Failure inputfieldmissing: type: object properties: diff --git a/yaml/page_profiler_eng.yaml b/yaml/page_profiler_eng.yaml index c7dbf513a..3244b57b5 100644 --- a/yaml/page_profiler_eng.yaml +++ b/yaml/page_profiler_eng.yaml @@ -66,6 +66,12 @@ application/json: schema: $ref: '#/components/schemas/inputlimitexceeded' + '422': + description: Invalid Input + content: + application/json: + schema: + $ref: '#/components/schemas/invalidinput' '500': description: Internal Server Error content: @@ -153,6 +159,15 @@ status: type: string example: Failure + invalidinput: + type: object + properties: + message: + type: string + example: Invalid Input + status: + type: string + example: Failure gatewaytimeout: type: object properties: diff --git a/yaml/page_profiler_eng_v2.1.yaml b/yaml/page_profiler_eng_v2.1.yaml index 5665e4820..64f99f832 100644 --- a/yaml/page_profiler_eng_v2.1.yaml +++ b/yaml/page_profiler_eng_v2.1.yaml @@ -63,6 +63,12 @@ application/json: schema: $ref: '#/components/schemas/inputlimitexceeded' + '422': + description: Invalid Input + content: + application/json: + schema: + $ref: '#/components/schemas/invalidinput' '500': description: Internal Server Error content: @@ -189,6 +195,15 @@ status: type: string example: Failure + invalidinput: + type: object + properties: + message: + type: string + example: Invalid Input + status: + type: string + example: Failure versions: type: object properties: diff --git a/yaml/page_profiler_jp.yaml b/yaml/page_profiler_jp.yaml index a880b8999..2b136f16d 100644 --- a/yaml/page_profiler_jp.yaml +++ b/yaml/page_profiler_jp.yaml @@ -81,6 +81,12 @@ application/json: schema: $ref: '#/components/schemas/inputlimitexceeded' + '422': + description: Invalid Input + content: + application/json: + schema: + $ref: '#/components/schemas/invalidinput' '500': description: Internal Server Error content: @@ -167,6 +173,15 @@ status: type: string example: Failure + invalidinput: + type: object + properties: + message: + type: string + example: Invalid Input + status: + type: string + example: Failure notfound: type: object properties: diff --git a/yaml/page_profiler_thai.yaml b/yaml/page_profiler_thai.yaml index 8204d9e9e..33bba8d3c 100644 --- a/yaml/page_profiler_thai.yaml +++ b/yaml/page_profiler_thai.yaml @@ -95,6 +95,12 @@ application/json: schema: $ref: '#/components/schemas/inputlimitexceeded' + '422': + description: Invalid Input + content: + application/json: + schema: + $ref: '#/components/schemas/invalidinput' '500': description: Internal Server Error content: @@ -188,6 +194,15 @@ status: type: string example: Failure + invalidinput: + type: object + properties: + message: + type: string + example: Invalid Input + status: + type: string + example: Failure servererror: type: object properties: diff --git a/yaml/pdf_extractor.yaml b/yaml/pdf_extractor.yaml index 92c52f143..50b9495a8 100644 --- a/yaml/pdf_extractor.yaml +++ b/yaml/pdf_extractor.yaml @@ -75,6 +75,12 @@ paths: application/json: schema: $ref: '#/components/schemas/inputlimitexceeded' + '422': + description: Invalid Input + content: + application/json: + schema: + $ref: '#/components/schemas/invalidinput' '500': description: Internal Server Error content: @@ -133,6 +139,15 @@ components: status: type: string example: Failure + invalidinput: + type: object + properties: + message: + type: string + example: Invalid Input + status: + type: string + example: Failure paymentrequired: type: object properties: diff --git a/yaml/people_counting.yaml b/yaml/people_counting.yaml index 47f3e284b..d246f2a6c 100644 --- a/yaml/people_counting.yaml +++ b/yaml/people_counting.yaml @@ -65,7 +65,13 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/inputlimitexceeded' + $ref: '#/components/schemas/inputlimitexceeded' + '422': + description: Invalid Input + content: + application/json: + schema: + $ref: '#/components/schemas/invalidinput' '500': description: Internal Server Error content: @@ -151,6 +157,15 @@ components: status: type: string example: Failure + invalidinput: + type: object + properties: + message: + type: string + example: Invalid Input + status: + type: string + example: Failure notfound: type: object properties: diff --git a/yaml/pki_key_generator.yaml b/yaml/pki_key_generator.yaml index 0cd6d51d6..a9077e34f 100644 --- a/yaml/pki_key_generator.yaml +++ b/yaml/pki_key_generator.yaml @@ -63,7 +63,13 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/inputlimitexceeded' + $ref: '#/components/schemas/inputlimitexceeded' + '422': + description: Invalid Input + content: + application/json: + schema: + $ref: '#/components/schemas/invalidinput' '500': description: Internal Server Error content: @@ -146,6 +152,15 @@ components: status: type: string example: Failure + invalidinput: + type: object + properties: + message: + type: string + example: Invalid Input + status: + type: string + example: Failure gatewaytimeout: type: object properties: diff --git a/yaml/residential_sales_and_rental_hdb_sg.yaml b/yaml/residential_sales_and_rental_hdb_sg.yaml index b366c71b3..f16558d14 100644 --- a/yaml/residential_sales_and_rental_hdb_sg.yaml +++ b/yaml/residential_sales_and_rental_hdb_sg.yaml @@ -215,7 +215,13 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/inputlimitexceeded' + $ref: '#/components/schemas/inputlimitexceeded' + '422': + description: Invalid Input + content: + application/json: + schema: + $ref: '#/components/schemas/invalidinput' '500': description: Internal Server Error content: @@ -434,6 +440,15 @@ components: status: type: string example: Failure + invalidinput: + type: object + properties: + message: + type: string + example: Invalid Input + status: + type: string + example: Failure gatewaytimeout: type: object properties: diff --git a/yaml/script_alignment.yaml b/yaml/script_alignment.yaml index 552d1423d..c209fd573 100644 --- a/yaml/script_alignment.yaml +++ b/yaml/script_alignment.yaml @@ -62,7 +62,13 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/inputlimitexceeded' + $ref: '#/components/schemas/inputlimitexceeded' + '422': + description: Invalid Input + content: + application/json: + schema: + $ref: '#/components/schemas/invalidinput' '500': description: Internal Server Error content: @@ -148,6 +154,15 @@ components: status: type: string example: Failure + invalidinput: + type: object + properties: + message: + type: string + example: Invalid Input + status: + type: string + example: Failure servererror: type: object properties: diff --git a/yaml/script_alignment_v1.0.yaml b/yaml/script_alignment_v1.0.yaml index 14e273408..a6b4b1603 100644 --- a/yaml/script_alignment_v1.0.yaml +++ b/yaml/script_alignment_v1.0.yaml @@ -67,7 +67,13 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/inputlimitexceeded' + $ref: '#/components/schemas/inputlimitexceeded' + '422': + description: Invalid Input + content: + application/json: + schema: + $ref: '#/components/schemas/invalidinput' '500': description: Internal Server Error content: @@ -184,6 +190,15 @@ components: status: type: string example: Failure + invalidinput: + type: object + properties: + message: + type: string + example: Invalid Input + status: + type: string + example: Failure inputfieldmissing: type: object properties: diff --git a/yaml/season_parking_availability_hdb_sg.yaml b/yaml/season_parking_availability_hdb_sg.yaml index aab96bd73..c8578ae75 100644 --- a/yaml/season_parking_availability_hdb_sg.yaml +++ b/yaml/season_parking_availability_hdb_sg.yaml @@ -209,7 +209,13 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/inputlimitexceeded' + $ref: '#/components/schemas/inputlimitexceeded' + '422': + description: Invalid Input + content: + application/json: + schema: + $ref: '#/components/schemas/invalidinput' '500': description: Internal Server Error content: @@ -372,6 +378,15 @@ components: status: type: string example: Failure + invalidinput: + type: object + properties: + message: + type: string + example: Invalid Input + status: + type: string + example: Failure notfound: type: object properties: diff --git a/yaml/sentiment-analysis-aws.yaml b/yaml/sentiment-analysis-aws.yaml index 4644772d0..61cef6373 100644 --- a/yaml/sentiment-analysis-aws.yaml +++ b/yaml/sentiment-analysis-aws.yaml @@ -53,7 +53,13 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/inputlimitexceeded' + $ref: '#/components/schemas/inputlimitexceeded' + '422': + description: Invalid Input + content: + application/json: + schema: + $ref: '#/components/schemas/invalidinput' '500': description: Internal Server error content: @@ -104,6 +110,15 @@ components: status: type: string example: Failure + invalidinput: + type: object + properties: + message: + type: string + example: Invalid Input + status: + type: string + example: Failure paymentrequired: type: object properties: diff --git a/yaml/spacy_named-entity_recognition_eng.yaml b/yaml/spacy_named-entity_recognition_eng.yaml index 9867b6942..34ed38c5c 100644 --- a/yaml/spacy_named-entity_recognition_eng.yaml +++ b/yaml/spacy_named-entity_recognition_eng.yaml @@ -65,7 +65,13 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/inputlimitexceeded' + $ref: '#/components/schemas/inputlimitexceeded' + '422': + description: Invalid Input + content: + application/json: + schema: + $ref: '#/components/schemas/invalidinput' '500': description: Internal Server Error content: @@ -197,7 +203,15 @@ components: type: string example: Success description: The status of the API call success/failure - + invalidinput: + type: object + properties: + message: + type: string + example: Invalid Input + status: + type: string + example: Failure unauthorized: type: object properties: diff --git a/yaml/staple_invoice.yaml b/yaml/staple_invoice.yaml new file mode 100644 index 000000000..d91b728d6 --- /dev/null +++ b/yaml/staple_invoice.yaml @@ -0,0 +1,223 @@ +openapi: 3.0.1 +info: + title: Staple Invoice + description: |+ + Scan the Invoice document from file and explore the data by catagorywise. + Supported formats are : pdf, jpg, png, docx, doc + version: '1.0.0' + x-subscribelink: staple_receipt +servers: + - url: 'https://dev-apis.sentient.io' +tags: +- name: "v1.0.0" + description: "Published Date - Oct 30, 2020" +paths: + /microservices/nlp/scaninvoice/v1/getresults: + post: + tags: + - v1.0.0 + responses: + '200': + description: success response + content: + application/json: + schema: + $ref: '#/components/schemas/success' + example: {"message": "Successfully Processed","results":{"scanDocuments":{"data":{"BigBoxes":[{"box":[102,131,227,166,164.5,148.5],"page":0}],"Currency":{"UICategory":"VAT&Amounts","UIName":"Currency","UIType":"Text","matches":[{"keyword":[1160,1594,1171,1616,1165.5,1605,"$","$"],"match":"$","matchmulti":"$","page":0,"value":[1160,1594,1171,1616,1165.5,1605,"$","$"]}]},"Customer":null,"DetectedText":"GSSAINVOICEThankyouc/oGregDerderianTreasurer32TinkerRoadNashuaNH03064Phone603-595-4357faxnoneDATE:INVOICE#FOR:May22009100AnnualDuesBillTo:GSSAMember2009PhoneDESCRIPTIONAMOUNTAnnualDuesperteam2009summerswimseason$100.00TOTAL$100.00MakeallcheckspayabletoGSSAIfyouhaveanyquestionsconcerningthisinvoicecontactNaGregDerderianTreasurerTHANKYOUFORYOURMEMBERSHIP!","DocSize":[[2000,1545]],"Email":{"UICategory":"Vendor&Customer","UIName":"Email","UIType":"Text","matches":[{"keyword":null,"match":null,"matchmulti":null,"page":null,"value":null}]},"GSTNumber":{"UICategory":"Vendor&Customer","UIName":"GSTNumber","UIType":"Text","matches":[{"keyword":null,"match":null,"matchmulti":null,"page":null,"value":null}]},"LineItems":[[{"Amount":[22009],"Description":["32TinkerRoad","DATE:"]}]],"LineItems_standardHeader":[[{"Description":"32TinkerRoadDATE:","LineAmount":22009,"Quantity":1,"UnitAmount":22009}]],"OtherDate":{"UICategory":"BasicInformation","UIName":"OtherDate","UIType":"Date","matches":[{"keyword":null,"match":"2009-05-02","matchmulti":"May22009","page":0,"value":[1232,260]}]},"SenderAddress":{"UICategory":"Vendor&Customer","UIName":"VendorAddress","UIType":"Text","matches":[{"keyword":[102,131,227,166,164.5,148.5,"GSSA\n","GSSA\n"],"match":"c/oGregDerderianTreasurer\n32TinkerRoad\nNashua\nNH03064\nPhone603-595-4357\nfaxnone\n","matchmulti":"c/oGregDerderianTreasurer32TinkerRoadNashuaNH03064Phone603-595-4357Faxnone","page":0,"value":[97,231,457,349,277,290,"c/oGregDerderianTreasurer\n32TinkerRoad\nNashua\nNH03064\nPhone603-595-4357\nfaxnone\n","c/oGregDerderianTreasurer\n32TinkerRoad\nNashua\nNH03064\nPhone603-595-4357\nFaxnone\n"]}]},"ServiceCharge":{"UICategory":"VAT&Amounts","UIName":"ServiceCharge","UIType":"Amount","matches":[{"keyword":null,"match":null,"matchmulti":null,"page":null,"value":null}]},"docId":7905,"status":"COMPLETED"}},"status":"Success"}} + '401': + description: Unauthorized + content: + application/json: + schema: + $ref: '#/components/schemas/unauthorized' + '402': + description: Payment Required + content: + application/json: + schema: + $ref: '#/components/schemas/paymentrequired' + '403': + description: Forbidden + content: + application/json: + schema: + $ref: '#/components/schemas/forbidden' + '404': + description: Not Found + content: + application/json: + schema: + $ref: '#/components/schemas/notfound' + '419': + description: Input Field Missing + content: + application/json: + schema: + $ref: '#/components/schemas/inputfieldmissing' + '420': + description: Input Limit Exceeded + content: + application/json: + schema: + $ref: '#/components/schemas/inputlimitexceeded' + '422': + description: Invalid Input + content: + application/json: + schema: + $ref: '#/components/schemas/invalidinput' + '500': + description: Internal Server Error + content: + application/json: + schema: + $ref: '#/components/schemas/servererror' + '504': + description: Gateway Timeout + content: + application/json: + schema: + $ref: '#/components/schemas/gatewaytimeout' + security: + - APIAuthorizer: [] + requestBody: + content: + multipart/form-data: + schema: + $ref: '#/components/schemas/input' + required: true +components: + schemas: + success: + type: object + properties: + results: + type: object + example: { "" } + description: The result of the API call + properties: + scanDocuments: + type: object + example: { "" } + description: The details of documents + message: + type: string + example: Successfully Processed + description: Detail description on the API status + status: + type: string + example: Success + description: The status of the API call success/failure + unauthorized: + type: object + properties: + message: + type: string + example: Missing Authentication Token + status: + type: string + example: Failure + forbidden: + type: object + properties: + message: + type: string + example: Access Denied Unauthorized User + status: + type: string + example: Failure + invalidinput: + type: object + properties: + message: + type: string + example: Invalid Input + status: + type: string + example: Failure + paymentrequired: + type: object + properties: + message: + type: string + example: Insufficient Credits Kindly Top Up + status: + type: string + example: Failure + notfound: + type: object + properties: + message: + type: string + example: Invalid Request URL + status: + type: string + example: Failure + servererror: + type: object + properties: + message: + type: string + example: Internal Server Error + status: + type: string + example: Failure + gatewaytimeout: + type: object + properties: + message: + type: string + example: Request Timeout + status: + type: string + example: Failure + inputfieldmissing: + type: object + properties: + message: + type: string + example: Input Field Missing + status: + type: string + example: Failure + inputlimitexceeded: + type: object + properties: + message: + type: string + example: Input Limit Exceeded + status: + type: string + example: Failure + versions: + type: object + properties: + v1.0.0: + type: array + items: + oneOf: + - type: string + example: Published Date - Oct 30, 2020 + description: Initial version release + input: + type: object + required: + - file + - endpointUrl + properties: + file: + type: string + format: binary + default: true + example: upload file + description: The receipt document + handwritten: + type: string + description: Sholud be true of false. Default is false + securitySchemes: + APIAuthorizer: + type: apiKey + name: x-api-key + in: header + x-amazon-apigateway-authtype: custom + description: Authentication is done using the x-api-key in the request header diff --git a/yaml/staple_receipt.yaml b/yaml/staple_receipt.yaml new file mode 100644 index 000000000..050b4655e --- /dev/null +++ b/yaml/staple_receipt.yaml @@ -0,0 +1,1573 @@ +openapi: 3.0.1 +info: + title: Staple Receipt + description: |+ + Scan the Receipt document from file and explore the data by catagorywise. + Supported formats are : pdf, jpg, png, docx, doc + version: '1.0.0' + x-subscribelink: staple_receipt +servers: + - url: 'https://dev-apis.sentient.io' +tags: +- name: "v1.0.0" + description: "Published Date - Oct 30, 2020" +paths: + /microservices/nlp/scanreceipt/v1/getresults: + post: + tags: + - v1.0.0 + responses: + '200': + description: success response + content: + application/json: + schema: + $ref: '#/components/schemas/success' + example: + message: Successfully Processed + results: + scanDocuments: + data: + AccountName: + UICategory: Payment Instructions + UIName: Account Name + UIType: Text + matches: + - keyword: + match: + matchmulti: + page: + value: + AccountNumber: + UICategory: Payment Instructions + UIName: Account Number + UIType: Text + matches: + - keyword: + match: + matchmulti: + page: + value: + BigBoxes: + - box: + - 106 + - 134 + - 385 + - 174 + - 245.5 + - 154 + - East Repair Inc. + - East Repair Inc. + page: 0 + - box: + - 1148 + - 129 + - 1308 + - 171 + - 1228 + - 150 + - RECEIPT + - RECEIPT + page: 0 + - box: + - 102 + - 208 + - 322 + - 273 + - 212 + - 240.5 + - |- + 1912 Harvest Lane + New York, NY 12210 + - |- + 1912 Harvest Lane + New York , NY 12210 + page: 0 + - box: + - 1232 + - 455 + - 1307 + - 479 + - 1269.5 + - 467 + - US-001 + - US-001 + page: 0 + - box: + - 102 + - 452 + - 322 + - 591 + - 212 + - 521.5 + - |- + Bill To + John Smith + 2 Court Square + New York, NY 12210 + - |- + Bill To + John Smith + 2 Court Square + New York , NY 12210 + page: 0 + - box: + - 529 + - 454 + - 766 + - 595 + - 647.5 + - 524.5 + - |- + Ship To + John Smith + 3787 Pineview Drive + Cambridge, MA 12210 + - |- + Ship To + John Smith + 3787 Pineview Drive + Cambridge , MA 12210 + page: 0 + - box: + - 972 + - 452 + - 1113 + - 531 + - 1042.5 + - 491.5 + - |- + Receipt # + Receipt Date + - |- + Receipt # + Receipt Date + page: 0 + - box: + - 1193 + - 500 + - 1309 + - 527 + - 1251 + - 513.5 + - 11/02/2019 + - 11/02/2019 + page: 0 + - box: + - 1055 + - 553 + - 1114 + - 575 + - 1084.5 + - 564 + - 'PO #' + - 'P.O. #' + page: 0 + - box: + - 1200 + - 553 + - 1310 + - 576 + - 1255 + - 564.5 + - 2312/2019 + - 2312/2019 + page: 0 + - box: + - 1012 + - 600 + - 1112 + - 622 + - 1062 + - 611 + - Due Date + - Due Date + page: 0 + - box: + - 1193 + - 600 + - 1310 + - 623 + - 1251.5 + - 611.5 + - 26/02/2019 + - 26/02/2019 + page: 0 + - box: + - 130 + - 732 + - 178 + - 751 + - 154 + - 741.5 + - QTY + - QTY + page: 0 + - box: + - 422 + - 731 + - 580 + - 752 + - 501 + - 741.5 + - DESCRIPTION + - DESCRIPTION + page: 0 + - box: + - 831 + - 722 + - 962 + - 759 + - 896.5 + - 740.5 + - UNIT PRICE + - UNIT PRICE + page: 0 + - box: + - 1102 + - 730 + - 1205 + - 752 + - 1153.5 + - 741 + - AMOUNT + - AMOUNT + page: 0 + - box: + - 149 + - 793 + - 155 + - 813 + - 152 + - 803 + - '1' + - '1' + page: 0 + - box: + - 229 + - 793 + - 518 + - 816 + - 373.5 + - 804.5 + - Front and rear brake cables + - Front and rear brake cables + page: 0 + - box: + - 911 + - 793 + - 981 + - 814 + - 946 + - 803.5 + - '100.00' + - '100.00' + page: 0 + - box: + - 1220 + - 793 + - 1289 + - 816 + - 1254.5 + - 804.5 + - '100.00' + - '100.00' + page: 0 + - box: + - 148 + - 857 + - 159 + - 876 + - 153.5 + - 866.5 + - '2' + - '2' + page: 0 + - box: + - 229 + - 852 + - 463 + - 884 + - 346 + - 868 + - New set of pedal arms + - New set of pedal arms + page: 0 + - box: + - 925 + - 857 + - 981 + - 879 + - 953 + - 868 + - '15.00' + - '15.00' + page: 0 + - box: + - 1231 + - 856 + - 1290 + - 879 + - 1260.5 + - 867.5 + - '30.00' + - '30.00' + page: 0 + - box: + - 149 + - 920 + - 160 + - 939 + - 154.5 + - 929.5 + - '3' + - '3' + page: 0 + - box: + - 229 + - 918 + - 340 + - 939 + - 284.5 + - 928.5 + - Labor 3hrs + - Labor 3hrs + page: 0 + - box: + - 936 + - 920 + - 980 + - 940 + - 958 + - 930 + - '5.00' + - '5.00' + page: 0 + - box: + - 1233 + - 920 + - 1289 + - 941 + - 1261 + - 930.5 + - '15.00' + - '15.00' + page: 0 + - box: + - 897 + - 981 + - 981 + - 1003 + - 939 + - 992 + - Subtotal + - Subtotal + page: 0 + - box: + - 1219 + - 980 + - 1288 + - 1002 + - 1253.5 + - 991 + - '145.00' + - '145.00' + page: 0 + - box: + - 803 + - 1042 + - 980 + - 1063 + - 891.5 + - 1052.5 + - Sales Tax 6.25% + - Sales Tax 6.25% + page: 0 + - box: + - 1244 + - 1042 + - 1289 + - 1065 + - 1266.5 + - 1053.5 + - '9.06' + - '9.06' + page: 0 + - box: + - 872 + - 1104 + - 981 + - 1137 + - 926.5 + - 1120.5 + - TOTAL + - TOTAL + page: 0 + - box: + - 1172 + - 1101 + - 1289 + - 1140 + - 1230.5 + - 1120.5 + - "$ 154.06" + - "$ 154.06" + page: 0 + - box: + - 102 + - 1728 + - 422 + - 1801 + - 262 + - 1764.5 + - |- + Terms & Conditions + Payment is due within 15 days + - |- + Terms & Conditions + Payment is due within 15 days + page: 0 + - box: + - 104 + - 1841 + - 616 + - 1871 + - 360 + - 1856 + - 'Please make checks payable to: East Repair Inc.' + - 'Please make checks payable to: East Repair Inc.' + page: 0 + BillingAddress: + UICategory: Vendor & Customer + UIName: Billing Address + UIType: Text + matches: + - keyword: + - 102 + - 452 + - 322 + - 591 + - 212 + - 521.5 + - |- + Bill To + John Smith + 2 Court Square + New York, NY 12210 + - |- + Bill To + John Smith + 2 Court Square + New York , NY 12210 + match: |- + John Smith + 2 Court Square + New York, NY 12210 + matchmulti: Bill To John Smith 2 Court Square New York , NY 12210 + page: 0 + value: + - 102 + - 452 + - 322 + - 591 + - 212 + - 521.5 + - |- + Bill To + John Smith + 2 Court Square + New York, NY 12210 + - |- + Bill To + John Smith + 2 Court Square + New York , NY 12210 + CompanyName: + UICategory: Vendor & Customer + UIName: Vendor Name + UIType: Text + matches: + - keyword: + - 106 + - 134 + - 385 + - 174 + - 245.5 + - 154 + - East Repair Inc. + - East Repair Inc. + match: East Repair Inc. + matchmulti: East Repair Inc. + page: 0 + value: + - 106 + - 134 + - 385 + - 174 + - 245.5 + - 154 + - East Repair Inc. + - East Repair Inc. + Currency: + UICategory: VAT & Amounts + UIName: Currency + UIType: Text + matches: + - keyword: + - 872 + - 1104 + - 981 + - 1137 + - 926.5 + - 1120.5 + - TOTAL + - TOTAL + match: "$" + matchmulti: "$ 154.06" + page: 0 + value: + - 1172 + - 1101 + - 1289 + - 1140 + - 1230.5 + - 1120.5 + - "$ 154.06" + - "$ 154.06" + Customer: + DetectedText: 'East Repair Inc. RECEIPT 1912 Harvest Lane New York, NY 12210 + US-001 Bill To John Smith 2 Court Square New York, NY 12210 Ship To John Smith + 3787 Pineview Drive Cambridge, MA 12210 Receipt # Receipt Date 11/02/2019 + PO # 2312/2019 Due Date 26/02/2019 QTY DESCRIPTION UNIT PRICE AMOUNT 1 Front + and rear brake cables 100.00 100.00 2 New set of pedal arms 15.00 30.00 3 + Labor 3hrs 5.00 15.00 Subtotal 145.00 Sales Tax 6.25% 9.06 TOTAL $ 154.06 + Terms & Conditions Payment is due within 15 days Please make checks payable + to: East Repair Inc. ' + DocSize: + - - 2000 + - 1413 + Email: + UICategory: Vendor & Customer + UIName: Email + UIType: Text + matches: + - keyword: + match: + matchmulti: + page: + value: + Freight: + UICategory: VAT & Amounts + UIName: Freight + UIType: Amount + matches: + - keyword: + match: + matchmulti: + page: + value: + IBAN: + UICategory: Payment Instructions + UIName: IBAN + UIType: Text + matches: + - keyword: + match: + matchmulti: + page: + value: + InvoiceDate: + UICategory: Basic Information + UIName: Invoice Date + UIType: Date + matches: + - keyword: + - 972 + - 499 + - 1113 + - 531 + - 1042.5 + - 515 + - Receipt Date + - Receipt Date + match: '2019-11-02' + matchmulti: 11/02/2019 + page: 0 + value: + - 1193 + - 500 + - 1309 + - 527 + - 1251 + - 513.5 + - 11/02/2019 + - 11/02/2019 + InvoiceNumber: + UICategory: Basic Information + UIName: Invoice Number + UIType: Text + matches: + - keyword: + match: + matchmulti: + page: + value: + LineItems: + - - 'AMOUNT ': + - '100.00' + 'DESCRIPTION ': + - Front and rear brake cables + 'QTY ': + - '1' + 'UNIT PRICE ': + - '100.00' + - 'AMOUNT ': + - '30.00' + 'DESCRIPTION ': + - New set of pedal arms + 'QTY ': + - '2' + 'UNIT PRICE ': + - '15.00' + - 'AMOUNT ': + - '15.00' + 'DESCRIPTION ': + - Labor 3hrs + 'QTY ': + - '3' + 'UNIT PRICE ': + - '5.00' + LineItems_standardHeader: + - - Description: Front and rear brake cables + LineAmount: 100 + Quantity: 1 + UnitAmount: 100 + - Description: New set of pedal arms + LineAmount: 30 + Quantity: 2 + UnitAmount: 15 + - Description: Labor 3hrs + LineAmount: 15 + Quantity: 3 + UnitAmount: 5 + OtherAddress: + UICategory: Vendor & Customer + UIName: Other Address + UIType: Text + matches: + - keyword: + match: + matchmulti: + page: + value: + OtherDate: + UICategory: Basic Information + UIName: Other Date + UIType: Date + matches: + - keyword: + match: + matchmulti: + page: + value: + PONumber: + UICategory: Vendor & Customer + UIName: PO Number + UIType: Text + matches: + - keyword: + - 1055 + - 553 + - 1114 + - 575 + - 1084.5 + - 564 + - 'PO #' + - 'P.O. #' + match: 2312/2019 + matchmulti: 2312/2019 + page: 0 + value: + - 1200 + - 553 + - 1310 + - 576 + - 1255 + - 564.5 + - 2312/2019 + - 2312/2019 + PaymentDate: + UICategory: Basic Information + UIName: Payment Date + UIType: Date + matches: + - keyword: + - 1012 + - 600 + - 1112 + - 622 + - 1062 + - 611 + - Due Date + - Due Date + match: '2019-02-26' + matchmulti: 26/02/2019 + page: 0 + value: + - 1193 + - 600 + - 1310 + - 623 + - 1251.5 + - 611.5 + - 26/02/2019 + - 26/02/2019 + SenderAddress: + UICategory: Vendor & Customer + UIName: Vendor Address + UIType: Text + matches: + - keyword: + - 106 + - 134 + - 385 + - 174 + - 245.5 + - 154 + - East Repair Inc. + - East Repair Inc. + match: East Repair Inc. + matchmulti: East Repair Inc. + page: 0 + value: + - 106 + - 134 + - 385 + - 174 + - 245.5 + - 154 + - East Repair Inc. + - East Repair Inc. + ShippingAddress: + UICategory: Vendor & Customer + UIName: Shipping Address + UIType: Text + matches: + - keyword: + - 529 + - 454 + - 766 + - 595 + - 647.5 + - 524.5 + - |- + Ship To + John Smith + 3787 Pineview Drive + Cambridge, MA 12210 + - |- + Ship To + John Smith + 3787 Pineview Drive + Cambridge , MA 12210 + match: |- + John Smith + 3787 Pineview Drive + Cambridge, MA 12210 + matchmulti: Ship To John Smith 3787 Pineview Drive Cambridge , MA 12210 + page: 0 + value: + - 529 + - 454 + - 766 + - 595 + - 647.5 + - 524.5 + - |- + Ship To + John Smith + 3787 Pineview Drive + Cambridge, MA 12210 + - |- + Ship To + John Smith + 3787 Pineview Drive + Cambridge , MA 12210 + SmallBoxes: + - box: + - 106 + - 134 + - 385 + - 174 + - 245.5 + - 154 + - East Repair Inc. + - East Repair Inc. + page: 0 + - box: + - 1148 + - 129 + - 1308 + - 171 + - 1228 + - 150 + - RECEIPT + - RECEIPT + page: 0 + - box: + - 105 + - 208 + - 302 + - 241 + - 203.5 + - 224.5 + - 1912 Harvest Lane + - 1912 Harvest Lane + page: 0 + - box: + - 102 + - 242 + - 322 + - 273 + - 212 + - 257.5 + - New York, NY 12210 + - New York , NY 12210 + page: 0 + - box: + - 1232 + - 455 + - 1307 + - 479 + - 1269.5 + - 467 + - US-001 + - US-001 + page: 0 + - box: + - 104 + - 452 + - 174 + - 481 + - 139 + - 466.5 + - Bill To + - Bill To + page: 0 + - box: + - 103 + - 492 + - 220 + - 524 + - 161.5 + - 508 + - John Smith + - John Smith + page: 0 + - box: + - 103 + - 527 + - 262 + - 559 + - 182.5 + - 543 + - 2 Court Square + - 2 Court Square + page: 0 + - box: + - 102 + - 560 + - 322 + - 591 + - 212 + - 575.5 + - New York, NY 12210 + - New York , NY 12210 + page: 0 + - box: + - 529 + - 454 + - 616 + - 482 + - 572.5 + - 468 + - Ship To + - Ship To + page: 0 + - box: + - 530 + - 494 + - 647 + - 523 + - 588.5 + - 508.5 + - John Smith + - John Smith + page: 0 + - box: + - 530 + - 527 + - 744 + - 555 + - 637 + - 541 + - 3787 Pineview Drive + - 3787 Pineview Drive + page: 0 + - box: + - 529 + - 559 + - 766 + - 595 + - 647.5 + - 577 + - Cambridge, MA 12210 + - Cambridge , MA 12210 + page: 0 + - box: + - 1009 + - 452 + - 1113 + - 483 + - 1061 + - 467.5 + - 'Receipt #' + - 'Receipt #' + page: 0 + - box: + - 972 + - 499 + - 1113 + - 531 + - 1042.5 + - 515 + - Receipt Date + - Receipt Date + page: 0 + - box: + - 1193 + - 500 + - 1309 + - 527 + - 1251 + - 513.5 + - 11/02/2019 + - 11/02/2019 + page: 0 + - box: + - 1055 + - 553 + - 1114 + - 575 + - 1084.5 + - 564 + - 'PO #' + - 'P.O. #' + page: 0 + - box: + - 1200 + - 553 + - 1310 + - 576 + - 1255 + - 564.5 + - 2312/2019 + - 2312/2019 + page: 0 + - box: + - 1012 + - 600 + - 1112 + - 622 + - 1062 + - 611 + - Due Date + - Due Date + page: 0 + - box: + - 1193 + - 600 + - 1310 + - 623 + - 1251.5 + - 611.5 + - 26/02/2019 + - 26/02/2019 + page: 0 + - box: + - 130 + - 732 + - 178 + - 751 + - 154 + - 741.5 + - QTY + - QTY + page: 0 + - box: + - 422 + - 731 + - 580 + - 752 + - 501 + - 741.5 + - DESCRIPTION + - DESCRIPTION + page: 0 + - box: + - 831 + - 722 + - 962 + - 759 + - 896.5 + - 740.5 + - UNIT PRICE + - UNIT PRICE + page: 0 + - box: + - 1102 + - 730 + - 1205 + - 752 + - 1153.5 + - 741 + - AMOUNT + - AMOUNT + page: 0 + - box: + - 149 + - 793 + - 155 + - 813 + - 152 + - 803 + - '1' + - '1' + page: 0 + - box: + - 229 + - 793 + - 518 + - 816 + - 373.5 + - 804.5 + - Front and rear brake cables + - Front and rear brake cables + page: 0 + - box: + - 911 + - 793 + - 981 + - 814 + - 946 + - 803.5 + - '100.00' + - '100.00' + page: 0 + - box: + - 1220 + - 793 + - 1289 + - 816 + - 1254.5 + - 804.5 + - '100.00' + - '100.00' + page: 0 + - box: + - 148 + - 857 + - 159 + - 876 + - 153.5 + - 866.5 + - '2' + - '2' + page: 0 + - box: + - 229 + - 852 + - 463 + - 884 + - 346 + - 868 + - New set of pedal arms + - New set of pedal arms + page: 0 + - box: + - 925 + - 857 + - 981 + - 879 + - 953 + - 868 + - '15.00' + - '15.00' + page: 0 + - box: + - 1231 + - 856 + - 1290 + - 879 + - 1260.5 + - 867.5 + - '30.00' + - '30.00' + page: 0 + - box: + - 149 + - 920 + - 160 + - 939 + - 154.5 + - 929.5 + - '3' + - '3' + page: 0 + - box: + - 229 + - 918 + - 340 + - 939 + - 284.5 + - 928.5 + - Labor 3hrs + - Labor 3hrs + page: 0 + - box: + - 936 + - 920 + - 980 + - 940 + - 958 + - 930 + - '5.00' + - '5.00' + page: 0 + - box: + - 1233 + - 920 + - 1289 + - 941 + - 1261 + - 930.5 + - '15.00' + - '15.00' + page: 0 + - box: + - 897 + - 981 + - 981 + - 1003 + - 939 + - 992 + - Subtotal + - Subtotal + page: 0 + - box: + - 1219 + - 980 + - 1288 + - 1002 + - 1253.5 + - 991 + - '145.00' + - '145.00' + page: 0 + - box: + - 803 + - 1042 + - 980 + - 1063 + - 891.5 + - 1052.5 + - Sales Tax 6.25% + - Sales Tax 6.25% + page: 0 + - box: + - 1244 + - 1042 + - 1289 + - 1065 + - 1266.5 + - 1053.5 + - '9.06' + - '9.06' + page: 0 + - box: + - 872 + - 1104 + - 981 + - 1137 + - 926.5 + - 1120.5 + - TOTAL + - TOTAL + page: 0 + - box: + - 1172 + - 1101 + - 1289 + - 1140 + - 1230.5 + - 1120.5 + - "$ 154.06" + - "$ 154.06" + page: 0 + - box: + - 102 + - 1728 + - 327 + - 1760 + - 214.5 + - 1744 + - Terms & Conditions + - Terms & Conditions + page: 0 + - box: + - 104 + - 1767 + - 422 + - 1801 + - 263 + - 1784 + - Payment is due within 15 days + - Payment is due within 15 days + page: 0 + - box: + - 104 + - 1841 + - 616 + - 1871 + - 360 + - 1856 + - 'Please make checks payable to: East Repair Inc.' + - 'Please make checks payable to: East Repair Inc.' + page: 0 + Subtotal: + UICategory: VAT & Amounts + UIName: Subtotal + UIType: Amount + matches: + - keyword: + - 897 + - 775 + - 981 + - 797 + - 939 + - 992 + - Subtotal + - Subtotal + match: 145 + matchmulti: '145.00' + page: 0 + value: + - 1219 + - 980 + - 1288 + - 1002 + - 1253.5 + - 991 + - '145.00' + - '145.00' + Supplier: + SwiftCode: + UICategory: Payment Instructions + UIName: Swift Code + UIType: Text + matches: + - keyword: + match: + matchmulti: + page: + value: + TableDetected: true + Tables: + - GridX: + - 106 + - 212 + - 797 + - 1002 + - 1309 + GridY: + - 775 + - 833 + - 895 + - 958 + GridYPages: + - 0 + - 0 + - 0 + - 0 + HeaderPage: 0 + header: + - 120 + - 720 + - 1293 + - 761 + headernum: 4 + TaxTotal: + UICategory: VAT & Amounts + UIName: Tax Total + UIType: Amount + matches: + - keyword: + - 803 + - 836 + - 980 + - 857 + - 891.5 + - 1052.5 + - Sales Tax 6.25% + - Sales Tax 6.25% + match: 6.2 + matchmulti: Sales Tax 6.25% + page: 0 + value: + - 803 + - 1042 + - 980 + - 1063 + - 891.5 + - 1052.5 + - Sales Tax 6.25% + - Sales Tax 6.25% + Total: + UICategory: VAT & Amounts + UIName: Total + UIType: Amount + matches: + - keyword: + - 872 + - 898 + - 981 + - 931 + - 926.5 + - 1120.5 + - TOTAL + - TOTAL + match: 154.06 + matchmulti: "$ 154.06" + page: 0 + value: + - 1172 + - 1101 + - 1289 + - 1140 + - 1230.5 + - 1120.5 + - "$ 154.06" + - "$ 154.06" + Type: invoice_image + URL: + UICategory: Vendor & Customer + UIName: URL + UIType: Text + matches: + - keyword: + match: + matchmulti: + page: + value: + num_pages: 1 + docId: 7650 + status: COMPLETED + status: Success + + '401': + description: Unauthorized + content: + application/json: + schema: + $ref: '#/components/schemas/unauthorized' + '402': + description: Payment Required + content: + application/json: + schema: + $ref: '#/components/schemas/paymentrequired' + '403': + description: Forbidden + content: + application/json: + schema: + $ref: '#/components/schemas/forbidden' + '404': + description: Not Found + content: + application/json: + schema: + $ref: '#/components/schemas/notfound' + '419': + description: Input Field Missing + content: + application/json: + schema: + $ref: '#/components/schemas/inputfieldmissing' + '420': + description: Input Limit Exceeded + content: + application/json: + schema: + $ref: '#/components/schemas/inputlimitexceeded' + '422': + description: Invalid Input + content: + application/json: + schema: + $ref: '#/components/schemas/invalidinput' + '500': + description: Internal Server Error + content: + application/json: + schema: + $ref: '#/components/schemas/servererror' + '504': + description: Gateway Timeout + content: + application/json: + schema: + $ref: '#/components/schemas/gatewaytimeout' + security: + - APIAuthorizer: [] + requestBody: + content: + multipart/form-data: + schema: + $ref: '#/components/schemas/input' + required: true +components: + schemas: + success: + type: object + properties: + results: + type: object + example: { "" } + description: The result of the API call + properties: + scanDocuments: + type: object + example: { "" } + description: The details of documents + message: + type: string + example: Successfully Processed + description: Detail description on the API status + status: + type: string + example: Success + description: The status of the API call success/failure + unauthorized: + type: object + properties: + message: + type: string + example: Missing Authentication Token + status: + type: string + example: Failure + forbidden: + type: object + properties: + message: + type: string + example: Access Denied Unauthorized User + status: + type: string + example: Failure + paymentrequired: + type: object + properties: + message: + type: string + example: Insufficient Credits Kindly Top Up + status: + type: string + example: Failure + notfound: + type: object + properties: + message: + type: string + example: Invalid Request URL + status: + type: string + example: Failure + invalidinput: + type: object + properties: + message: + type: string + example: Invalid Input + status: + type: string + example: Failure + servererror: + type: object + properties: + message: + type: string + example: Internal Server Error + status: + type: string + example: Failure + gatewaytimeout: + type: object + properties: + message: + type: string + example: Request Timeout + status: + type: string + example: Failure + inputfieldmissing: + type: object + properties: + message: + type: string + example: Input Field Missing + status: + type: string + example: Failure + inputlimitexceeded: + type: object + properties: + message: + type: string + example: Input Limit Exceeded + status: + type: string + example: Failure + versions: + type: object + properties: + v1.0.0: + type: array + items: + oneOf: + - type: string + example: Published Date - Oct 30, 2020 + description: Initial version release + input: + type: object + required: + - file + - endpointUrl + properties: + file: + type: string + format: binary + default: true + example: upload file + description: The receipt document + handwritten: + type: string + description: Sholud be true of false. Default is false + securitySchemes: + APIAuthorizer: + type: apiKey + name: x-api-key + in: header + x-amazon-apigateway-authtype: custom + description: Authentication is done using the x-api-key in the request header diff --git a/yaml/taxonomy_matcher_eng.yaml b/yaml/taxonomy_matcher_eng.yaml index fd69b5241..309bdc885 100644 --- a/yaml/taxonomy_matcher_eng.yaml +++ b/yaml/taxonomy_matcher_eng.yaml @@ -72,7 +72,13 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/inputlimitexceeded' + $ref: '#/components/schemas/inputlimitexceeded' + '422': + description: Invalid Input + content: + application/json: + schema: + $ref: '#/components/schemas/invalidinput' '500': description: Internal Server Error content: @@ -138,6 +144,15 @@ components: status: type: string example: Failure + invalidinput: + type: object + properties: + message: + type: string + example: Invalid Input + status: + type: string + example: Failure servererror: type: object properties: diff --git a/yaml/taxonomy_matcher_eng_v1.0.yaml b/yaml/taxonomy_matcher_eng_v1.0.yaml index 3dcad2387..156b7a77b 100644 --- a/yaml/taxonomy_matcher_eng_v1.0.yaml +++ b/yaml/taxonomy_matcher_eng_v1.0.yaml @@ -75,7 +75,13 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/inputlimitexceeded' + $ref: '#/components/schemas/inputlimitexceeded' + '422': + description: Invalid Input + content: + application/json: + schema: + $ref: '#/components/schemas/invalidinput' '500': description: Internal Server Error content: @@ -127,6 +133,15 @@ components: status: type: string example: Failure + invalidinput: + type: object + properties: + message: + type: string + example: Invalid Input + status: + type: string + example: Failure forbidden: type: object properties: diff --git a/yaml/text-to-speech_chi.yaml b/yaml/text-to-speech_chi.yaml index 02f76c99d..c79b4c436 100644 --- a/yaml/text-to-speech_chi.yaml +++ b/yaml/text-to-speech_chi.yaml @@ -65,7 +65,13 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/inputlimitexceeded' + $ref: '#/components/schemas/inputlimitexceeded' + '422': + description: Invalid Input + content: + application/json: + schema: + $ref: '#/components/schemas/invalidinput' '500': description: Internal Server Error content: @@ -121,6 +127,15 @@ components: status: type: string example: Failure + invalidinput: + type: object + properties: + message: + type: string + example: Invalid Input + status: + type: string + example: Failure paymentrequired: type: object properties: diff --git a/yaml/text-to-speech_eng.yaml b/yaml/text-to-speech_eng.yaml index a69b2cb03..8768ddefe 100644 --- a/yaml/text-to-speech_eng.yaml +++ b/yaml/text-to-speech_eng.yaml @@ -66,6 +66,12 @@ paths: application/json: schema: $ref: '#/components/schemas/inputlimitexceeded' + '422': + description: Invalid Input + content: + application/json: + schema: + $ref: '#/components/schemas/invalidinput' '500': description: Internal Server Error content: @@ -229,6 +235,15 @@ components: status: type: string example: Failure + invalidinput: + type: object + properties: + message: + type: string + example: Invalid Input + status: + type: string + example: Failure forbidden: type: object properties: diff --git a/yaml/urls_retrieval.yaml b/yaml/urls_retrieval.yaml index 116c5f189..59670dde8 100644 --- a/yaml/urls_retrieval.yaml +++ b/yaml/urls_retrieval.yaml @@ -70,6 +70,12 @@ paths: application/json: schema: $ref: '#/components/schemas/inputlimitexceeded' + '422': + description: Invalid Input + content: + application/json: + schema: + $ref: '#/components/schemas/invalidinput' '500': description: Internal Server Error content: @@ -155,6 +161,15 @@ components: status: type: string example: Failure + invalidinput: + type: object + properties: + message: + type: string + example: Invalid Input + status: + type: string + example: Failure notfound: type: object properties: diff --git a/yaml/video-to-audio_convertor.yaml b/yaml/video-to-audio_convertor.yaml index bf64675d3..e3025959d 100644 --- a/yaml/video-to-audio_convertor.yaml +++ b/yaml/video-to-audio_convertor.yaml @@ -64,7 +64,13 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/inputlimitexceeded' + $ref: '#/components/schemas/inputlimitexceeded' + '422': + description: Invalid Input + content: + application/json: + schema: + $ref: '#/components/schemas/invalidinput' '500': description: Internal Server Error content: @@ -171,6 +177,15 @@ components: status: type: string example: Failure + invalidinput: + type: object + properties: + message: + type: string + example: Invalid Input + status: + type: string + example: Failure inputlimitexceeded: type: object properties: diff --git a/yaml/video-to-image_convertor.yaml b/yaml/video-to-image_convertor.yaml index 7b98a1bc9..d2b38f6d5 100644 --- a/yaml/video-to-image_convertor.yaml +++ b/yaml/video-to-image_convertor.yaml @@ -65,6 +65,12 @@ paths: application/json: schema: $ref: '#/components/schemas/inputlimitexceeded' + '422': + description: Invalid Input + content: + application/json: + schema: + $ref: '#/components/schemas/invalidinput' '500': description: Internal Server Error content: @@ -145,6 +151,15 @@ components: status: type: string example: Failure + invalidinput: + type: object + properties: + message: + type: string + example: Invalid Input + status: + type: string + example: Failure servererror: type: object properties: diff --git a/yaml/voice_activity_detection_eng.yaml b/yaml/voice_activity_detection_eng.yaml index 14163aa52..9b9959d5d 100644 --- a/yaml/voice_activity_detection_eng.yaml +++ b/yaml/voice_activity_detection_eng.yaml @@ -62,7 +62,13 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/inputlimitexceeded' + $ref: '#/components/schemas/inputlimitexceeded' + '422': + description: Invalid Input + content: + application/json: + schema: + $ref: '#/components/schemas/invalidinput' '500': description: Internal Server Error content: @@ -146,6 +152,15 @@ components: status: type: string example: Failure + invalidinput: + type: object + properties: + message: + type: string + example: Invalid Input + status: + type: string + example: Failure servererror: type: object properties: diff --git a/yaml/voice_activity_detection_eng_v1.0.yaml b/yaml/voice_activity_detection_eng_v1.0.yaml new file mode 100644 index 000000000..87b795c39 --- /dev/null +++ b/yaml/voice_activity_detection_eng_v1.0.yaml @@ -0,0 +1,259 @@ +openapi: 3.0.1 +info: + title: Voice Activity Detection ENG + description: |+ + This Voice microservice detects utterances in the input audio and outputs the start and end time of these utterances. + + An utterance is the smallest unit of speech. It is a continuous piece of speech beginning and ending with a clear pause. + version: '1.0.0' + x-subscribelink: voice_activity_detection_eng +servers: + - url: 'https://dev-apis.sentient.io' +tags: +- name: "v1.0.0" + description: "Published Date - Nov 30, 2020" +paths: + /microservices/voice/vad/v1/getpredictions: + post: + tags: + - v1.0.0 + responses: + '200': + description: success response + content: + application/json: + schema: + $ref: '#/components/schemas/success' + example: + results: + results: [{end: 23.72,seqNum: 1,start: 0.64}] + message: Successfully Processed + status: Success + + '401': + description: Unauthorized + content: + application/json: + schema: + $ref: '#/components/schemas/unauthorized' + '402': + description: Payment Required + content: + application/json: + schema: + $ref: '#/components/schemas/paymentrequired' + '403': + description: Forbidden + content: + application/json: + schema: + $ref: '#/components/schemas/forbidden' + '404': + description: Not Found + content: + application/json: + schema: + $ref: '#/components/schemas/notfound' + '419': + description: Input Field Missing + content: + application/json: + schema: + $ref: '#/components/schemas/inputfieldmissing' + '420': + description: Input Limit Exceeded + content: + application/json: + schema: + $ref: '#/components/schemas/inputlimitexceeded' + '422': + description: Invalid Input + content: + application/json: + schema: + $ref: '#/components/schemas/invalidinput' + '500': + description: Internal Server Error + content: + application/json: + schema: + $ref: '#/components/schemas/servererror' + '504': + description: Gateway Timeout + content: + application/json: + schema: + $ref: '#/components/schemas/gatewaytimeout' + security: + - APIAuthorizer: [] + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/input' + required: true +components: + schemas: + success: + type: object + properties: + results: + type: object + description: The result of the API call. + example: { "" } + properties: + results: + type: array + example: [{end: 23.72,seqNum: 1,start: 0.64}] + description: List of details of start and end time of utterances in the input audio + items: + oneOf: + - type: object + properties: + end: + type: number + format: float + example: 23.72 + description: End time of utterance, in seconds. Offset from the start of stream. + seqNum: + type: number + example: 1 + description: Running sequence. Starts from 1. + start: + type: number + format: float + example: 0.64 + description: Start time of utterance, in seconds. Offset from the start of stream. + message: + type: string + example: Successfully Processed + description: Detail description on the API status + status: + type: string + example: Success + description: The status of the API call success/failure + unauthorized: + type: object + properties: + message: + type: string + example: Missing Authentication Token + status: + type: string + example: Failure + forbidden: + type: object + properties: + message: + type: string + example: Access Denied Unauthorized User + status: + type: string + example: Failure + invalidinput: + type: object + properties: + message: + type: string + example: Invalid Input + status: + type: string + example: Failure + paymentrequired: + type: object + properties: + message: + type: string + example: Insufficient Credits Kindly Top Up + status: + type: string + example: Failure + notfound: + type: object + properties: + message: + type: string + example: Invalid Request URL + status: + type: string + example: Failure + servererror: + type: object + properties: + message: + type: string + example: Internal Server Error + status: + type: string + example: Failure + gatewaytimeout: + type: object + properties: + message: + type: string + example: Request Timeout + status: + type: string + example: Failure + inputfieldmissing: + type: object + properties: + message: + type: string + example: Input Field Missing + status: + type: string + example: Failure + inputlimitexceeded: + type: object + properties: + message: + type: string + example: Input Limit Exceeded + status: + type: string + example: Failure + input: + type: object + required: + - wav_base64 + properties: + wav_base64: + x-name: wav_base64 + type: string + default: true + example: UklGRkbiBABXQVZFZm10IBAAAAABA... + description: |+ + Required. Input audio file in base64 format + threshold: + x-name: threshold + type: number + format: float + default: false + example: 0.2 + description: |+ + Optional. Threshold ranges between 0.0 and 1.0 and default is 0.4 + versions: + type: object + properties: + v1.0.0: + type: array + items: + oneOf: + - type: string + example: Published Date - Nov 30,2020 + description: Standardizing Output JSON + v0.1.0: + type: array + items: + oneOf: + - type: string + example: Published Date - Jul 03,2020 + description: Initial version release + securitySchemes: + APIAuthorizer: + type: apiKey + name: x-api-key + in: header + x-amazon-apigateway-authtype: custom + description: Authentication is done using the x-api-key in the request header diff --git a/yaml/web_scraper.yaml b/yaml/web_scraper.yaml index a6cb8bf82..1f8455932 100644 --- a/yaml/web_scraper.yaml +++ b/yaml/web_scraper.yaml @@ -126,7 +126,13 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/inputlimitexceeded' + $ref: '#/components/schemas/inputlimitexceeded' + '422': + description: Invalid Input + content: + application/json: + schema: + $ref: '#/components/schemas/invalidinput' '500': description: Internal Server Error content: @@ -218,6 +224,15 @@ components: status: type: string example: Failure + invalidinput: + type: object + properties: + message: + type: string + example: Invalid Input + status: + type: string + example: Failure servererror: type: object properties: @@ -257,13 +272,27 @@ components: versions: type: object properties: - v1.1: + v1.1.0: type: array items: oneOf: - type: string example: Published Date - Oct 30, 2020 - description: Partial URL support + description: Partial URL support + v1.0.0: + type: array + items: + oneOf: + - type: string + example: Published Date - Jul 03, 2020 + description: Improvised search filters using queryList, now you can even navigate down the html tree like get all p tag inside a div class "class":"class_name p" + v0.1.0: + type: array + items: + oneOf: + - type: string + example: Published Date - Jul 18, 2018 + description: Initial version release input: type: object properties: diff --git a/yaml/wikipedia_retrieval.yaml b/yaml/wikipedia_retrieval.yaml index 9a7efc14b..60cd34b95 100644 --- a/yaml/wikipedia_retrieval.yaml +++ b/yaml/wikipedia_retrieval.yaml @@ -81,7 +81,13 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/inputlimitexceeded' + $ref: '#/components/schemas/inputlimitexceeded' + '422': + description: Invalid Input + content: + application/json: + schema: + $ref: '#/components/schemas/invalidinput' '500': description: Internal Server Error content: @@ -207,6 +213,15 @@ components: status: type: string example: Failure + invalidinput: + type: object + properties: + message: + type: string + example: Invalid Input + status: + type: string + example: Failure notfound: type: object properties: @@ -272,17 +287,14 @@ components: description: The search term, highest match to the title of the Wikipedia page. pageid: type: integer - example: 1 default: true description: The Wikipedia id of the page requested. language: type: string - example: ISO 639-1 default: false description: Indicates the language in which the Wikipedia page is written. Default is English, for other languages give the input as ISO 639-1 language code filter_key: type: string - example: all default: false description: Indicates the filter criteria of the output result fields. The default return set includes pageid, url, and summary.“all” - returns all the fields. You can also filter by individual fields using the list value. Possible values are pageid, url, summary, content, links, and images securitySchemes: diff --git a/yaml/word_sense_disambiguation_eng.yaml b/yaml/word_sense_disambiguation_eng.yaml index 44647fa14..124381fa2 100644 --- a/yaml/word_sense_disambiguation_eng.yaml +++ b/yaml/word_sense_disambiguation_eng.yaml @@ -81,7 +81,13 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/inputlimitexceeded' + $ref: '#/components/schemas/inputlimitexceeded' + '422': + description: Invalid Input + content: + application/json: + schema: + $ref: '#/components/schemas/invalidinput' '500': description: Internal Server Error content: @@ -203,6 +209,15 @@ components: status: type: string example: Failure + invalidinput: + type: object + properties: + message: + type: string + example: Invalid Input + status: + type: string + example: Failure servererror: type: object properties: diff --git a/yaml/word_sense_disambiguation_eng_v1.0.yaml b/yaml/word_sense_disambiguation_eng_v1.0.yaml index ade581ce7..9da4d77fe 100644 --- a/yaml/word_sense_disambiguation_eng_v1.0.yaml +++ b/yaml/word_sense_disambiguation_eng_v1.0.yaml @@ -83,7 +83,13 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/inputlimitexceeded' + $ref: '#/components/schemas/inputlimitexceeded' + '422': + description: Invalid Input + content: + application/json: + schema: + $ref: '#/components/schemas/invalidinput' '500': description: Internal Server Error content: @@ -200,6 +206,15 @@ components: status: type: string example: Failure + invalidinput: + type: object + properties: + message: + type: string + example: Invalid Input + status: + type: string + example: Failure paymentrequired: type: object properties: diff --git a/yaml/youtube_video_downloader.yaml b/yaml/youtube_video_downloader.yaml index ed7a60092..caa188406 100644 --- a/yaml/youtube_video_downloader.yaml +++ b/yaml/youtube_video_downloader.yaml @@ -64,7 +64,13 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/inputlimitexceeded' + $ref: '#/components/schemas/inputlimitexceeded' + '422': + description: Invalid Input + content: + application/json: + schema: + $ref: '#/components/schemas/invalidinput' '500': description: Internal Server Error content: @@ -161,6 +167,15 @@ components: status: type: string example: Failure + invalidinput: + type: object + properties: + message: + type: string + example: Invalid Input + status: + type: string + example: Failure inputfieldmissing: type: object properties: From 98161d636cf5c2e0dc52d568abd6298ff3e3239d Mon Sep 17 00:00:00 2001 From: Priyadharshini <57977344+priyadharshini-sent@users.noreply.github.com> Date: Fri, 27 Nov 2020 17:56:50 +0530 Subject: [PATCH 177/792] Update d&b_business_check_sg.yaml --- yaml/d&b_business_check_sg.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/yaml/d&b_business_check_sg.yaml b/yaml/d&b_business_check_sg.yaml index 6ed27c1ba..d7bffe50c 100644 --- a/yaml/d&b_business_check_sg.yaml +++ b/yaml/d&b_business_check_sg.yaml @@ -2,7 +2,7 @@ openapi: 3.0.1 info: title: D&B Business Check (SG) description: |+ - This Data microservice provides key business information of a Singapore-registered company includes the business name, registration number, registered address and date of change, company status, registered activities, shareholders details (i.e. date of commencement, residing address) capital amount and shares allocated to each shareholders. Updated daily. + This Data microservice provides key business information of a Singapore-registered company and includes the business name, registration number, registered address and date of change, company status, registered activities, shareholders details (i.e. date of commencement, residing address) capital amount and shares allocated to each shareholders. Updated daily. version: '0.1.0' x-subscribelink: d&b_business_check_sg servers: From c0c7b33f819cb435133efd7efa318ffb7fb150dd Mon Sep 17 00:00:00 2001 From: Priyadharshini <57977344+priyadharshini-sent@users.noreply.github.com> Date: Fri, 27 Nov 2020 17:58:14 +0530 Subject: [PATCH 178/792] Update d&b_brief_financial_information_sg.yaml --- yaml/d&b_brief_financial_information_sg.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/yaml/d&b_brief_financial_information_sg.yaml b/yaml/d&b_brief_financial_information_sg.yaml index 696216211..732715cec 100644 --- a/yaml/d&b_brief_financial_information_sg.yaml +++ b/yaml/d&b_brief_financial_information_sg.yaml @@ -1,7 +1,7 @@ openapi: 3.0.1 info: title: D&B Brief Financial Information (SG) - description: This Data microservice provides the annual financial information of the Singapore-registered business, inclusive of annual profit and loss and financial ratios. Updated daily. + description: This Data microservice provides the annual financial information of Singapore-registered businesses, inclusive of annual profit and loss and financial ratios. Updated daily. version: '0.1.0' x-subscribelink: d&b_brief_financial_information_sg servers: From df50866ec222375379115a327ab410190194551e Mon Sep 17 00:00:00 2001 From: Priyadharshini <57977344+priyadharshini-sent@users.noreply.github.com> Date: Fri, 27 Nov 2020 17:59:50 +0530 Subject: [PATCH 179/792] Update demographics_hdb_sg.yaml --- yaml/demographics_hdb_sg.yaml | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/yaml/demographics_hdb_sg.yaml b/yaml/demographics_hdb_sg.yaml index d1e209809..2bc610366 100644 --- a/yaml/demographics_hdb_sg.yaml +++ b/yaml/demographics_hdb_sg.yaml @@ -3,8 +3,7 @@ info: title: HDB Demographics (SG) x-subscribelink: demographics_hdb_sg description: |+ - This Data microservice returns information on Housing Development Board of Singapore (HDB) estates that includes location address, postal code, gender and age groups, down to block-level granularity. - The HDB POTH programme makes selected public and non-public datasets available to developers and companies to improve their service offerings to benefit the lives of Singapore citizens. Sentient.io is proud to partner with HDB to manage and facilitate the sharing of data for the POTH Programme. + This Data microservice returns information on Housing Development Board of Singapore (HDB) estates and includes the location address, postal code, gender and age groups, down to block-level granularity.The HDB POTH programme makes selected public and non-public datasets available to developers and companies to improve their service offerings to benefit the lives of Singapore citizens. Sentient.io is proud to partner with HDB to manage and facilitate the sharing of data for the POTH Programme. **Note:** As this microservice uses the GET method, developers using this microservice must remember to have their app encode all the input values to be URL friendly (i.e. all spaces and special characters must be replaced). Here’s a reference on [URL encoding](https://www.w3schools.com/tags/ref_urlencode.ASP). From 04d6fd7ecec9218e92721a2faeb3dec26ab068fe Mon Sep 17 00:00:00 2001 From: Priyadharshini <57977344+priyadharshini-sent@users.noreply.github.com> Date: Fri, 27 Nov 2020 18:00:25 +0530 Subject: [PATCH 180/792] Update flat_ownership_hdb_sg.yaml --- yaml/flat_ownership_hdb_sg.yaml | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/yaml/flat_ownership_hdb_sg.yaml b/yaml/flat_ownership_hdb_sg.yaml index da8584d10..3e7d9c6fc 100644 --- a/yaml/flat_ownership_hdb_sg.yaml +++ b/yaml/flat_ownership_hdb_sg.yaml @@ -3,9 +3,7 @@ info: title: HDB Flat Ownership Duration (SG) x-subscribelink: flat_ownership_hdb_sg description: |+ - This Data microservice returns information on flat ownership within Housing Development Board of Singapore (HDB) estates that includes location address, postal code, length of ownership and their quantity in units. - - The HDB POTH programme makes selected public and non-public datasets available to developers and companies to improve their service offerings to benefit the lives of Singapore citizens. Sentient.io is proud to partner with HDB to manage and facilitate the sharing of data for the POTH Programme. + This Data microservice returns information on flat ownership within Housing Development Board of Singapore (HDB) estates and includes the location address, postal code, length of ownership and their quantity in units.The HDB POTH programme makes selected public and non-public datasets available to developers and companies to improve their service offerings to benefit the lives of Singapore citizens. Sentient.io is proud to partner with HDB to manage and facilitate the sharing of data for the POTH Programme." **Note:** As this microservice uses the GET method, developers using this microservice must remember to have their app encode all the input values to be URL friendly (i.e. all spaces and special characters must be replaced). Here’s a reference on [URL encoding](https://www.w3schools.com/tags/ref_urlencode.ASP). From 8788a82578eeff62a10bab8c671c84f898672770 Mon Sep 17 00:00:00 2001 From: Priyadharshini <57977344+priyadharshini-sent@users.noreply.github.com> Date: Fri, 27 Nov 2020 18:03:08 +0530 Subject: [PATCH 181/792] Update season_parking_availability_hdb_sg.yaml --- yaml/season_parking_availability_hdb_sg.yaml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/yaml/season_parking_availability_hdb_sg.yaml b/yaml/season_parking_availability_hdb_sg.yaml index c8578ae75..0f2584927 100644 --- a/yaml/season_parking_availability_hdb_sg.yaml +++ b/yaml/season_parking_availability_hdb_sg.yaml @@ -3,9 +3,9 @@ info: title: HDB Season Parking Availability (SG) x-subscribelink: season_parking_availability_hdb_sg description: |+ - This Data microservice returns season car park availability information within Housing Development Board of Singapore (HDB) estates that includes location address, postal code, branch office, vehicle type and parking lot availability for different types of vehicle by carpark location. + This Data microservice returns information on season car park availability within Housing Development Board of Singapore (HDB) estates and includes the location address, postal code, branch office, vehicle type and parking lot availability for different types of vehicle by carpark location. - The HDB POTH programme makes selected public and non-public datasets available to developers and companies to improve their service offerings to benefit the lives of Singapore citizens. Sentient.io is proud to partner with HDB to manage and facilitate the sharing of data for the POTH Programme. + The HDB POTH programme makes selected public and non-public datasets available to developers and companies to improve their service offerings to benefit the lives of Singapore citizens. Sentient.io is proud to partner with HDB to manage and facilitate the sharing of data for the POTH Programme. **Note:** As this microservice uses the GET method, developers using this microservice must remember to have their app encode all the input values to be URL friendly (i.e. all spaces and special characters must be replaced). Here’s a reference on [URL encoding](https://www.w3schools.com/tags/ref_urlencode.ASP). From 75c6cf1f8ecce85ec8c765034266e9778e957e32 Mon Sep 17 00:00:00 2001 From: Priyadharshini <57977344+priyadharshini-sent@users.noreply.github.com> Date: Fri, 27 Nov 2020 18:03:49 +0530 Subject: [PATCH 182/792] Update automatic_speech_recognition_chi_sg.yaml --- yaml/automatic_speech_recognition_chi_sg.yaml | 6 ++---- 1 file changed, 2 insertions(+), 4 deletions(-) diff --git a/yaml/automatic_speech_recognition_chi_sg.yaml b/yaml/automatic_speech_recognition_chi_sg.yaml index 3d773a61b..960507d0d 100644 --- a/yaml/automatic_speech_recognition_chi_sg.yaml +++ b/yaml/automatic_speech_recognition_chi_sg.yaml @@ -3,10 +3,8 @@ info: title: Automatic Speech Recognition CHI (SG) description: |+ This Voice microservice takes in the input audio file (in WAV format at 16kHz) and transcribes Mandarin speech content within the input file into text. - - This microservice works best for if the audio file consists of mostly speech with no long pauses in between. - - The size of your audio file should be **between 3 KB to 10 MB**. + + This microservice works best when the audio file consists of mostly speech with no long pauses in between. version: '0.1.1' x-subscribelink: automatic_speech_recognition_chi_sg servers: From 353cd0973ac13bfb495b628e270de576d27881f5 Mon Sep 17 00:00:00 2001 From: Priyadharshini <57977344+priyadharshini-sent@users.noreply.github.com> Date: Fri, 27 Nov 2020 18:04:26 +0530 Subject: [PATCH 183/792] Update commercial_directories_hdb_sg.yaml --- yaml/commercial_directories_hdb_sg.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/yaml/commercial_directories_hdb_sg.yaml b/yaml/commercial_directories_hdb_sg.yaml index cd456aa63..a235fecbc 100644 --- a/yaml/commercial_directories_hdb_sg.yaml +++ b/yaml/commercial_directories_hdb_sg.yaml @@ -3,7 +3,7 @@ info: title: HDB Commercial Directories (SG) x-subscribelink: commercial_directories_hdb_sg description: |+ - This Data microservice retrieves the list of all retail shops in Singapore which allows you to search for a shop by its name, address, building name, postal code, latitude and longitude coordinates type of business. The resultant dataset offers useful information like the shop operating hours and contact number. Updated weekly. + This Data microservice retrieves the list of all retail shops within Singapore HDBs and allows you to search for a shop by its name, address, building name, postal code, latitude and longitude coordinates type of business. The resultant dataset offers useful information like the shop operating hours and contact number. Updated weekly. The HDB POTH programme makes selected public and non-public datasets available to developers and companies to improve their service offerings to benefit the lives of Singapore citizens. Sentient.io is proud to partner with HDB to manage and facilitate the sharing of data for the POTH Programme. From 5d631f31b1fd3723c5e1fe844a12ff232d4650fd Mon Sep 17 00:00:00 2001 From: Priyadharshini <57977344+priyadharshini-sent@users.noreply.github.com> Date: Fri, 27 Nov 2020 18:04:52 +0530 Subject: [PATCH 184/792] Update pki_key_generator.yaml --- yaml/pki_key_generator.yaml | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/yaml/pki_key_generator.yaml b/yaml/pki_key_generator.yaml index a9077e34f..73c32ed27 100644 --- a/yaml/pki_key_generator.yaml +++ b/yaml/pki_key_generator.yaml @@ -2,9 +2,7 @@ openapi: 3.0.1 info: title: PKI Key Generator description: |+ - This Utiltiy microservice generates Public key and Private key pair, useful for encryption purposes. - - Do ensure that your text is **within 512 characters**. + This Utiltiy microservice generates Public key and Private key pair, and is useful for encryption purposes. version: '0.1.0' x-subscribelink: pki_key_generator servers: From fcd4849ecd02ea508720a0544eb70d5cc1d14883 Mon Sep 17 00:00:00 2001 From: Priyadharshini <57977344+priyadharshini-sent@users.noreply.github.com> Date: Fri, 27 Nov 2020 18:05:31 +0530 Subject: [PATCH 185/792] Update carpark_hdb_sg.yaml --- yaml/carpark_hdb_sg.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/yaml/carpark_hdb_sg.yaml b/yaml/carpark_hdb_sg.yaml index 4f67ca45f..430299026 100644 --- a/yaml/carpark_hdb_sg.yaml +++ b/yaml/carpark_hdb_sg.yaml @@ -3,7 +3,7 @@ info: title: HDB Carpark Locations (SG) x-subscribelink: carpark_hdb_sg description: |+ - This Data microservice retrieves the Singapore Housing Development Board's carpark information within Singapore HDB estates that includes location address, postal code and parking lot capacity for different types of vehicle by carpark location. Updated monthly. + This Data microservice retrieves the Singapore Housing Development Board's carpark information within Singapore HDB estates and includes the location address, postal code and parking lot capacity for different types of vehicle by carpark location. Updated monthly. The HDB POTH programme makes selected public and non-public datasets available to developers and companies to improve their service offerings to benefit the lives of Singapore citizens. Sentient.io is proud to partner with HDB to manage and facilitate the sharing of data for the POTH Programme. From b4b576b8bd5294140c7c5dcd332cc0e0a3cc5c0b Mon Sep 17 00:00:00 2001 From: Priyadharshini <57977344+priyadharshini-sent@users.noreply.github.com> Date: Fri, 27 Nov 2020 18:06:02 +0530 Subject: [PATCH 186/792] Update word_sense_disambiguation_eng.yaml --- yaml/word_sense_disambiguation_eng.yaml | 6 ++---- 1 file changed, 2 insertions(+), 4 deletions(-) diff --git a/yaml/word_sense_disambiguation_eng.yaml b/yaml/word_sense_disambiguation_eng.yaml index 124381fa2..c8921c11a 100644 --- a/yaml/word_sense_disambiguation_eng.yaml +++ b/yaml/word_sense_disambiguation_eng.yaml @@ -2,11 +2,9 @@ openapi: 3.0.1 info: title: Word Sense Disambiguation ENG description: |+ - This NLP microservice takes in a text and a target word and identifies the target word's hypernym. Hypernym refers to the specific meaning of the word within the context of the sentence. - + This NLP microservice takes in a text and a target word and identifies the target word's hypernym. Hypernym refers to the specific meaning of the word within the context of the sentence. For example, colour is a hypernym of red. + If the word is determined to be a noun within the sentence context, the microservice returns the potential hypernym, definition, and score. Otherwise, no result will be returned for that context. - - Do ensure that your text is within **5000 characters**. version: '0.1.0' x-subscribelink: word_sense_disambiguation_eng From aa456df4d48856138da2eb335e2d64f59aa98d0b Mon Sep 17 00:00:00 2001 From: Priyadharshini <57977344+priyadharshini-sent@users.noreply.github.com> Date: Fri, 27 Nov 2020 18:06:36 +0530 Subject: [PATCH 187/792] Update inverse_text_normalisation_eng.yaml --- yaml/inverse_text_normalisation_eng.yaml | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/yaml/inverse_text_normalisation_eng.yaml b/yaml/inverse_text_normalisation_eng.yaml index bc50418e8..e0155665b 100644 --- a/yaml/inverse_text_normalisation_eng.yaml +++ b/yaml/inverse_text_normalisation_eng.yaml @@ -2,11 +2,11 @@ openapi: 3.0.1 info: title: Inverse Text Normalisation ENG description: |+ - This NLP microservice recovers the missing punctuations such as full stop, comma, exclamation mark, and question mark from the input text. - - It converts pre-defined abbreviations from lower case to upper case and also first letters of sentences to upper case. - - Do ensure that your text is within **5000 characters**. + This NLP microservice recovers missing punctuations such as full stop, comma, exclamation mark, and question mark from the input text. + + This NLP microservice also converts pre-defined abbreviations from lower case to upper case. + + This NLP microservice also converts first letters of sentences to upper case. version: '0.1.0' x-subscribelink: inverse_text_normalisation_eng servers: From d8808a76983545ca99f57854e652a051d0b747a1 Mon Sep 17 00:00:00 2001 From: Priyadharshini <57977344+priyadharshini-sent@users.noreply.github.com> Date: Fri, 27 Nov 2020 18:06:58 +0530 Subject: [PATCH 188/792] Update youtube_video_downloader.yaml --- yaml/youtube_video_downloader.yaml | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/yaml/youtube_video_downloader.yaml b/yaml/youtube_video_downloader.yaml index caa188406..879d08219 100644 --- a/yaml/youtube_video_downloader.yaml +++ b/yaml/youtube_video_downloader.yaml @@ -2,9 +2,7 @@ openapi: 3.0.1 info: title: Youtube Video Downloader description: |+ - This Utility microservice retrieves the Youtube video of the input URL and output a download link. - - Note that the URL has to be **spelt in full**, including "https://www." + This Utility microservice retrieves the Youtube video of the input URL and outputs a download link. version: '0.1.0' x-subscribelink: youtube_video_downloader servers: From eec47358803d29ad01c1c465c7276f5c75e1da10 Mon Sep 17 00:00:00 2001 From: Priyadharshini <57977344+priyadharshini-sent@users.noreply.github.com> Date: Fri, 27 Nov 2020 18:08:00 +0530 Subject: [PATCH 189/792] Update face_recognition_politicians_sg.yaml --- yaml/face_recognition_politicians_sg.yaml | 6 ++---- 1 file changed, 2 insertions(+), 4 deletions(-) diff --git a/yaml/face_recognition_politicians_sg.yaml b/yaml/face_recognition_politicians_sg.yaml index dcf5cf2a3..c6977385d 100644 --- a/yaml/face_recognition_politicians_sg.yaml +++ b/yaml/face_recognition_politicians_sg.yaml @@ -2,11 +2,9 @@ openapi: 3.0.1 info: title: Face Recognition Politicians (SG) description: |+ - This Computer Vision microservice recognises faces from input image files of Singapore Members of Parliament. - + This Computer Vision microservice recognises faces from input image files of the Members of Singapore Parliament. + This microservice returns the identity of the person, the bounding box in image coordinates, and the confidence of the prediction. - - The size of your image file should **not exceed 5 MB**, and the image dimension should be **at least 416x416 pixels**. version: '0.1.0' x-subscribelink: face_recognition_politicians_sg servers: From befcafc68ebf20aa8c4d66f0b6962aceaecbfc40 Mon Sep 17 00:00:00 2001 From: Priyadharshini <57977344+priyadharshini-sent@users.noreply.github.com> Date: Fri, 27 Nov 2020 18:08:30 +0530 Subject: [PATCH 190/792] Update video-to-image_convertor.yaml --- yaml/video-to-image_convertor.yaml | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/yaml/video-to-image_convertor.yaml b/yaml/video-to-image_convertor.yaml index d2b38f6d5..a0a2569a4 100644 --- a/yaml/video-to-image_convertor.yaml +++ b/yaml/video-to-image_convertor.yaml @@ -2,9 +2,9 @@ openapi: 3.0.1 info: title: Video-to-Image Convertor description: |+ - This Utility microservice captures the images from the input video file at frame rate of 1 frame per second. - - The size of your video file should **not exceed 10 MB**. + This Utility microservice captures the images from the input video file at the frame rate of 1 frame per second. + + Supported formats are : 3g2, avi, flv, mkv, mov, mp4, ogv, webm, wmv, m4v with H.264 codec encoded. version: '0.1.0' x-subscribelink: video-to-image_convertor servers: From 6a331232a2d801e81c6faf55ea3f10e5de69d9fd Mon Sep 17 00:00:00 2001 From: Priyadharshini <57977344+priyadharshini-sent@users.noreply.github.com> Date: Fri, 27 Nov 2020 18:09:10 +0530 Subject: [PATCH 191/792] Update urls_retrieval.yaml --- yaml/urls_retrieval.yaml | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/yaml/urls_retrieval.yaml b/yaml/urls_retrieval.yaml index 59670dde8..8ae6555f1 100644 --- a/yaml/urls_retrieval.yaml +++ b/yaml/urls_retrieval.yaml @@ -2,7 +2,9 @@ openapi: 3.0.1 info: title: URLs Retrieval description: |+ - This Utility microservice crawls and retrieves their content from the input URLs, up to the specified depth. + This Utility microservice crawls and retrieves content from the input URLs, up to the specified depth. + + Default depth is 0 and maximum number of URLs is 500. version: '0.2.0' x-subscribelink: urls_retrieval servers: From 515fd7d03bee7043d50998c57fbe807fab4e76e4 Mon Sep 17 00:00:00 2001 From: Priyadharshini <57977344+priyadharshini-sent@users.noreply.github.com> Date: Sat, 28 Nov 2020 16:50:52 +0530 Subject: [PATCH 192/792] Update d&b_business_check_sg.yaml --- yaml/d&b_business_check_sg.yaml | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/yaml/d&b_business_check_sg.yaml b/yaml/d&b_business_check_sg.yaml index d7bffe50c..40955b05d 100644 --- a/yaml/d&b_business_check_sg.yaml +++ b/yaml/d&b_business_check_sg.yaml @@ -3,6 +3,17 @@ info: title: D&B Business Check (SG) description: |+ This Data microservice provides key business information of a Singapore-registered company and includes the business name, registration number, registered address and date of change, company status, registered activities, shareholders details (i.e. date of commencement, residing address) capital amount and shares allocated to each shareholders. Updated daily. + x-additionalinfo: |+ + Suggested Use Cases: + - For software solutions that require general background checks of a company. This microservice can provide a high level of scrutiny of potential business associates, and throw light on the risks that cannot be detected by geopolitical analysis or batch screening levels. + + - For example, this microservice can be used to check if a Singapore-registered company meets regulations, such as if the company complies with anti-money laundering, anti-bribery, and corruption regulations by looking at registered activities, shareholders details, and more. + + - It can also be used to simplify the due diligence process, by identify risk issues using a range of reports that meet different compliance requirements. + + - It can also be used to protect your business – safeguard against reputational risk by avoiding those involved in financial crime. + + - It can also be used for finance-related domains such as vehicle leasing, loans, enterprise credit terms and so on. Updated daily." version: '0.1.0' x-subscribelink: d&b_business_check_sg servers: From 1cc9e1ea328cd3ed3b2bc5efb79ec7caa1a856d3 Mon Sep 17 00:00:00 2001 From: Priyadharshini <57977344+priyadharshini-sent@users.noreply.github.com> Date: Sat, 28 Nov 2020 16:52:27 +0530 Subject: [PATCH 193/792] Update d&b_business_check_sg.yaml --- yaml/d&b_business_check_sg.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/yaml/d&b_business_check_sg.yaml b/yaml/d&b_business_check_sg.yaml index 40955b05d..b8f5683ba 100644 --- a/yaml/d&b_business_check_sg.yaml +++ b/yaml/d&b_business_check_sg.yaml @@ -13,7 +13,7 @@ info: - It can also be used to protect your business – safeguard against reputational risk by avoiding those involved in financial crime. - - It can also be used for finance-related domains such as vehicle leasing, loans, enterprise credit terms and so on. Updated daily." + - It can also be used for finance-related domains such as vehicle leasing, loans, enterprise credit terms and so on. Updated daily. version: '0.1.0' x-subscribelink: d&b_business_check_sg servers: From 5c3b254dd2aeee6896412f258ad383b76ee049c9 Mon Sep 17 00:00:00 2001 From: Priyadharshini <57977344+priyadharshini-sent@users.noreply.github.com> Date: Sat, 28 Nov 2020 16:54:22 +0530 Subject: [PATCH 194/792] Update d&b_basic_individual_search_sg.yaml --- yaml/d&b_basic_individual_search_sg.yaml | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/yaml/d&b_basic_individual_search_sg.yaml b/yaml/d&b_basic_individual_search_sg.yaml index bffa806a8..881a05141 100644 --- a/yaml/d&b_basic_individual_search_sg.yaml +++ b/yaml/d&b_basic_individual_search_sg.yaml @@ -3,6 +3,11 @@ info: title: D&B Basic Individual Search (SG) description: |+ This Data microservice provides the information on the (Singapore-registered) business interest of an individual that includes the individual’s actual name, residential address, business and shareholding in businesses, current & previous ownership, litigation against individual and businesses, bankruptcy record and count on the times this individual has been searched on. Updated daily. + x-additionalinfo: |+ + Suggested Use Cases: + - Software solutions that require personal checks, e.g. in the appointment of Board Members, Directorship or C-suite level hiring, where the appointee’s background is paramount to the Company and its reputation. + + - Swift pre-employment screening solution - information provided by the microservice can be used to protect one's company's reputation from potential negative publicity by conducting background checks on individuals prior to hiring. version: '0.1.0' x-subscribelink: d&b_basic_individual_search_sg servers: From 17d198ce7e86bf15097836564ee6d09000a0058b Mon Sep 17 00:00:00 2001 From: Priyadharshini <57977344+priyadharshini-sent@users.noreply.github.com> Date: Sat, 28 Nov 2020 16:55:07 +0530 Subject: [PATCH 195/792] Update d&b_business_check_plus_sg.yaml --- yaml/d&b_business_check_plus_sg.yaml | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/yaml/d&b_business_check_plus_sg.yaml b/yaml/d&b_business_check_plus_sg.yaml index 2053894c8..4413b322e 100644 --- a/yaml/d&b_business_check_plus_sg.yaml +++ b/yaml/d&b_business_check_plus_sg.yaml @@ -2,6 +2,11 @@ openapi: 3.0.1 info: title: D&B Business Check Plus (SG) description: The Data microservice provides key business information, litigation information (High and Subordinate Courts) and Winding Up Trace of a company including the Business name, registration number, registered address and date of change, company status, registered activities, shareholders details (i.e. date of commencement, residing address) capital amount and shares allocated to each shareholder, litigation information. Updated daily. + x-additionalinfo: |+ + Suggested Use Cases: + - Software solutions targeted at corporate finance and legal domains, e.g. in cases of mergers, joint ventures or partnerships. + + - Aside from being able to protect your business via litigation checks to safeguard against reputational risk by avoiding companies potentially involved in financial crimes, the information from this microservice can serve as a quick solution for analysts or lawyers in a company whom are looking to draft documents related to cooperate finance or legal domains with one quick search. version: '0.1.0' x-subscribelink: d&b_business_check_plus_sg servers: From c91d5fa085adb556abfc6552a9bffaa9d2d25f51 Mon Sep 17 00:00:00 2001 From: Priyadharshini <57977344+priyadharshini-sent@users.noreply.github.com> Date: Sat, 28 Nov 2020 16:55:57 +0530 Subject: [PATCH 196/792] Update d&b_brief_financial_information_sg.yaml --- yaml/d&b_brief_financial_information_sg.yaml | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/yaml/d&b_brief_financial_information_sg.yaml b/yaml/d&b_brief_financial_information_sg.yaml index 732715cec..4f27ffaec 100644 --- a/yaml/d&b_brief_financial_information_sg.yaml +++ b/yaml/d&b_brief_financial_information_sg.yaml @@ -2,6 +2,11 @@ openapi: 3.0.1 info: title: D&B Brief Financial Information (SG) description: This Data microservice provides the annual financial information of Singapore-registered businesses, inclusive of annual profit and loss and financial ratios. Updated daily. + x-additionalinfo: |+ + Suggested Use Cases: + - Software solutions with functions for personal credit checks, e.g. for parties who have a vested interest (e.g. banks, investors) in the company’s performance and to evaluate the company’s gearing and acid ratios. + + - Information from this microservice can be used for financial analysis - one can build models based on historical behavior. Continually update fraud patterns and compare with real-time transactions. Store and consolidate market data, trade activity, and other data, such as social and transactional data. version: '0.1.0' x-subscribelink: d&b_brief_financial_information_sg servers: From 3683bb37e9271b1b7e5edc8c08c19f58f10bf18e Mon Sep 17 00:00:00 2001 From: Priyadharshini <57977344+priyadharshini-sent@users.noreply.github.com> Date: Sat, 28 Nov 2020 16:57:25 +0530 Subject: [PATCH 197/792] Update fitness_stations_and_playgrounds_hdb_sg.yaml --- yaml/fitness_stations_and_playgrounds_hdb_sg.yaml | 3 +++ 1 file changed, 3 insertions(+) diff --git a/yaml/fitness_stations_and_playgrounds_hdb_sg.yaml b/yaml/fitness_stations_and_playgrounds_hdb_sg.yaml index 745a5833a..6878cf99b 100644 --- a/yaml/fitness_stations_and_playgrounds_hdb_sg.yaml +++ b/yaml/fitness_stations_and_playgrounds_hdb_sg.yaml @@ -7,6 +7,9 @@ info: As this is a dataset download microservice, a successful call will return a pre-signed URL where the entire dataset can be downloaded as a CSV file. The HDB POTH programme makes selected public and non-public datasets available to developers and companies to improve their service offerings to benefit the lives of Singapore citizens. Sentient.io is proud to partner with HDB to manage and facilitate the sharing of data for the POTH Programme. x-additionalinfo: |+ + Suggested Use Cases: + - Real estate services - can be used as a background check solution to extract information related to the types and number of fitness stations/playgrounds present in an area for people buying or renting a HDB home. + Download the complete dataset using a pre-signed URL. It's a two steps process. **Step 1:** Get the pre-signed URL From 3ebe1b4e1cd99a5e2f89ea00d50f260d7bd97a23 Mon Sep 17 00:00:00 2001 From: Priyadharshini <57977344+priyadharshini-sent@users.noreply.github.com> Date: Sat, 28 Nov 2020 16:58:16 +0530 Subject: [PATCH 198/792] Update amenities_hardcourts_hdb_sg.yaml --- yaml/amenities_hardcourts_hdb_sg.yaml | 3 +++ 1 file changed, 3 insertions(+) diff --git a/yaml/amenities_hardcourts_hdb_sg.yaml b/yaml/amenities_hardcourts_hdb_sg.yaml index 47e3a0f6b..676a89e20 100644 --- a/yaml/amenities_hardcourts_hdb_sg.yaml +++ b/yaml/amenities_hardcourts_hdb_sg.yaml @@ -7,6 +7,9 @@ info: As this is a dataset download microservice, a successful call will return a pre-signed URL where the entire dataset can be downloaded as a CSV file. The HDB POTH programme makes selected public and non-public datasets available to developers and companies to improve their service offerings to benefit the lives of Singapore citizens. Sentient.io is proud to partner with HDB to manage and facilitate the sharing of data for the POTH Programme. x-additionalinfo: |+ + Suggested Use Cases: + - Real estate services - can be used as a solution to extract information related to the types and number of hardcourts present in an area for people buying or renting a HDB home. + Download the complete dataset using a pre-signed URL. It's a two steps process **Step 1:** Get the pre-signed URL From 1af7a6786e239f887d42f24835b669fc815069b8 Mon Sep 17 00:00:00 2001 From: Priyadharshini <57977344+priyadharshini-sent@users.noreply.github.com> Date: Sat, 28 Nov 2020 16:58:59 +0530 Subject: [PATCH 199/792] Update amenities_lamp_posts_hdb_sg.yaml --- yaml/amenities_lamp_posts_hdb_sg.yaml | 3 +++ 1 file changed, 3 insertions(+) diff --git a/yaml/amenities_lamp_posts_hdb_sg.yaml b/yaml/amenities_lamp_posts_hdb_sg.yaml index 21e1816c0..8ffbd5c51 100644 --- a/yaml/amenities_lamp_posts_hdb_sg.yaml +++ b/yaml/amenities_lamp_posts_hdb_sg.yaml @@ -7,6 +7,9 @@ info: As this is a dataset download microservice, a successful call will return a pre-signed URL where the entire dataset can be downloaded as a CSV file. The HDB POTH programme makes selected public and non-public datasets available to developers and companies to improve their service offerings to benefit the lives of Singapore citizens. Sentient.io is proud to partner with HDB to manage and facilitate the sharing of data for the POTH Programme. x-additionalinfo: |+ + Suggested Use Cases: + - Real estate services or social service solutions - can be used as a background check solution to extract information related to lampposts present in an area for people with certain preferences when buying or renting a HDB home. For example, the elderly may prefer HDB homes surrounded with more lampposts as they require more aid in terms of lighting when walking home. + Download the complete dataset using a pre-signed URL. It's a two steps process **Step 1:** Get the pre-signed URL From bc4787a23a2dd872e7b3d5b5275c98f15e37ff78 Mon Sep 17 00:00:00 2001 From: Priyadharshini <57977344+priyadharshini-sent@users.noreply.github.com> Date: Sat, 28 Nov 2020 16:59:45 +0530 Subject: [PATCH 200/792] Update amenities_shelters_hdb_sg.yaml --- yaml/amenities_shelters_hdb_sg.yaml | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/yaml/amenities_shelters_hdb_sg.yaml b/yaml/amenities_shelters_hdb_sg.yaml index e7614f957..6e8a9ff98 100644 --- a/yaml/amenities_shelters_hdb_sg.yaml +++ b/yaml/amenities_shelters_hdb_sg.yaml @@ -7,6 +7,13 @@ info: As this is a dataset download microservice, a successful call will return a pre-signed URL where the entire dataset can be downloaded as a CSV file. The HDB POTH programme makes selected public and non-public datasets available to developers and companies to improve their service offerings to benefit the lives of Singapore citizens. Sentient.io is proud to partner with HDB to manage and facilitate the sharing of data for the POTH Programme. x-additionalinfo: |+ + Suggested Use Cases: + - Real estate services - can be used as a solution to extract information related to the types and number of shelters present for people buying or renting a HDB home. + + - Property background checks - can be used as a background check service for retail shops owners looking to set up their shops in HDBs, as areas with shelters may induce the likelihood of more customers. + + - Can also be used as a solution to improve user awareness and personalization - for example, a weather app can refer a user to the nearest HDB shelter in the case of a rainy day. + Download the complete dataset using a pre-signed URL. It's a two steps process **Step 1:** Get the pre-signed URL From bd7a1706870f3b9eec677c79ce7fc02e1c1d30a6 Mon Sep 17 00:00:00 2001 From: Priyadharshini <57977344+priyadharshini-sent@users.noreply.github.com> Date: Sat, 28 Nov 2020 17:00:25 +0530 Subject: [PATCH 201/792] Update demographics_hdb_sg.yaml --- yaml/demographics_hdb_sg.yaml | 3 +++ 1 file changed, 3 insertions(+) diff --git a/yaml/demographics_hdb_sg.yaml b/yaml/demographics_hdb_sg.yaml index 2bc610366..c076f3086 100644 --- a/yaml/demographics_hdb_sg.yaml +++ b/yaml/demographics_hdb_sg.yaml @@ -8,6 +8,9 @@ info: **Note:** As this microservice uses the GET method, developers using this microservice must remember to have their app encode all the input values to be URL friendly (i.e. all spaces and special characters must be replaced). Here’s a reference on [URL encoding](https://www.w3schools.com/tags/ref_urlencode.ASP). x-additionalinfo : |+ + Suggested Use Cases: + - This microservice can be used as a solution to help businesses better understand and connect with their customers, engage new prospects and increase revenue. For example, it can be used to create intelligent prospect lists that ensure one is always maximizing their marketing investment. + **Refining queries in the filterdata field using filter types and match types** The filterdata fields use elasticsearch’s syntax (specifically filter types and match types) to help further refine search results and provide greater flexibility in structuring more sophisticated queries. From c507cf8a161baa003ceac0f1de1a5a4e718c5aa9 Mon Sep 17 00:00:00 2001 From: Priyadharshini <57977344+priyadharshini-sent@users.noreply.github.com> Date: Sat, 28 Nov 2020 17:01:11 +0530 Subject: [PATCH 202/792] Update flat_ownership_hdb_sg.yaml --- yaml/flat_ownership_hdb_sg.yaml | 3 +++ 1 file changed, 3 insertions(+) diff --git a/yaml/flat_ownership_hdb_sg.yaml b/yaml/flat_ownership_hdb_sg.yaml index 3e7d9c6fc..c870ddf02 100644 --- a/yaml/flat_ownership_hdb_sg.yaml +++ b/yaml/flat_ownership_hdb_sg.yaml @@ -8,6 +8,9 @@ info: **Note:** As this microservice uses the GET method, developers using this microservice must remember to have their app encode all the input values to be URL friendly (i.e. all spaces and special characters must be replaced). Here’s a reference on [URL encoding](https://www.w3schools.com/tags/ref_urlencode.ASP). x-additionalinfo : |+ + Suggested Use Cases: + - Real estate services - for example, this microservice can be used for services that are related to HDB ownership transfer (i.e. when one transfer, include, withdraw and/or substitute owners for a flat), such as when drafting up related legal documents. + **Refining queries in the filterdata field using filter types and match types** The filterdata fields use elasticsearch’s syntax (specifically filter types and match types) to help further refine search results and provide greater flexibility in structuring more sophisticated queries. From 48b672b8c87d2c94eea18409b22e8dfa04eb3661 Mon Sep 17 00:00:00 2001 From: Priyadharshini <57977344+priyadharshini-sent@users.noreply.github.com> Date: Sat, 28 Nov 2020 17:01:54 +0530 Subject: [PATCH 203/792] Update season_parking_availability_hdb_sg.yaml --- yaml/season_parking_availability_hdb_sg.yaml | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/yaml/season_parking_availability_hdb_sg.yaml b/yaml/season_parking_availability_hdb_sg.yaml index 0f2584927..5aa8e92cb 100644 --- a/yaml/season_parking_availability_hdb_sg.yaml +++ b/yaml/season_parking_availability_hdb_sg.yaml @@ -10,6 +10,11 @@ info: **Note:** As this microservice uses the GET method, developers using this microservice must remember to have their app encode all the input values to be URL friendly (i.e. all spaces and special characters must be replaced). Here’s a reference on [URL encoding](https://www.w3schools.com/tags/ref_urlencode.ASP). x-additionalinfo : |+ + Suggested Use Cases: + - Real estate services - can be used as a background check solution to extract information related to season car park availability in an area for people with certain preferences when buying or renting a HDB home. + + - Can also be integrated into apps related to maps or parking for more detailed carpark information within Singapore HDB estates + **Refining queries in the filterdata field using filter types and match types** The filterdata fields use elasticsearch’s syntax (specifically filter types and match types) to help further refine search results and provide greater flexibility in structuring more sophisticated queries. From 175f37ce443cdfeb909cc2d006d5f9c6a105bab1 Mon Sep 17 00:00:00 2001 From: Priyadharshini <57977344+priyadharshini-sent@users.noreply.github.com> Date: Sat, 28 Nov 2020 17:02:39 +0530 Subject: [PATCH 204/792] Update automatic_speech_recognition_chi_sg.yaml --- yaml/automatic_speech_recognition_chi_sg.yaml | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/yaml/automatic_speech_recognition_chi_sg.yaml b/yaml/automatic_speech_recognition_chi_sg.yaml index 960507d0d..ea88f5a13 100644 --- a/yaml/automatic_speech_recognition_chi_sg.yaml +++ b/yaml/automatic_speech_recognition_chi_sg.yaml @@ -5,6 +5,17 @@ info: This Voice microservice takes in the input audio file (in WAV format at 16kHz) and transcribes Mandarin speech content within the input file into text. This microservice works best when the audio file consists of mostly speech with no long pauses in between. + x-additionalinfo: |+ + Suggested Use Cases: + - Extraction of text from voice ( from sound files), especially with Singaporean accented Mandarin. + + - Extraction of text from video, especially with Singaporean accented Mandarin. + + - Improve customer service - empower a customer service system by adding IVR (interactive voice response) and agent conversations to call centers. Perform analytics on conversation data to gain more insights into the calls and customers. + + - Enable voice control services - e.g. implement voice commands such as “turn the volume up,” and voice search such as saying “what is the temperature in Paris?” + + - Transcribe multimedia content - transcribe audio and video to include captions and improve audience reach and experience. For example, this microservice can be used for indexing or subtitling video and/or multispeaker content; similar to video captioning on YouTube. version: '0.1.1' x-subscribelink: automatic_speech_recognition_chi_sg servers: From f707839793838cd03fe79baaaf44a7bb1ce4ecde Mon Sep 17 00:00:00 2001 From: Priyadharshini <57977344+priyadharshini-sent@users.noreply.github.com> Date: Sat, 28 Nov 2020 17:03:42 +0530 Subject: [PATCH 205/792] Update voice_activity_detection_eng.yaml --- yaml/voice_activity_detection_eng.yaml | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/yaml/voice_activity_detection_eng.yaml b/yaml/voice_activity_detection_eng.yaml index 9b9959d5d..021359beb 100644 --- a/yaml/voice_activity_detection_eng.yaml +++ b/yaml/voice_activity_detection_eng.yaml @@ -5,6 +5,15 @@ info: This Voice microservice detects utterances in the input audio and outputs the start and end time of these utterances. An utterance is the smallest unit of speech. It is a continuous piece of speech beginning and ending with a clear pause. + x-additionalinfo: |+ + Suggested Use Cases: + - Narrate a blurb or chunk of text in English + + - Improve customer service - empower a customer service system by adding IVR (interactive voice response) and agent conversations to call centers. Perform analytics on conversation data to gain more insights into the calls and customers. + + - Enable voice control - implement voice commands such as “turn the volume up,” and voice search such as saying “what is the temperature in Paris?” + + - Transcribe multimedia content - transcribe audio and video to include captions and improve audience reach and experience. For example, this microservice can be used for indexing or subtitling video and/or multispeaker content; similar to video captioning on YouTube. version: '0.1.0' x-subscribelink: voice_activity_detection_eng servers: From 27eb87d8670b3320235efe587ae8350f3a44a53d Mon Sep 17 00:00:00 2001 From: Priyadharshini <57977344+priyadharshini-sent@users.noreply.github.com> Date: Sat, 28 Nov 2020 17:04:27 +0530 Subject: [PATCH 206/792] Update text-to-speech_eng.yaml --- yaml/text-to-speech_eng.yaml | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/yaml/text-to-speech_eng.yaml b/yaml/text-to-speech_eng.yaml index 8768ddefe..42d47b6ee 100644 --- a/yaml/text-to-speech_eng.yaml +++ b/yaml/text-to-speech_eng.yaml @@ -7,6 +7,15 @@ info: The Text-to-Speech AI generated synthesized voice speaks with Singapore English accent. Do ensure that your text is within **2000 characters**. + x-additionalinfo: |+ + Suggested Use Cases: + - Transcribes spoken English words, sentences or phrases into written forms + + - Voice bots in contact centers - deliver a better voice experience for customer service by dynamically generating speech, instead of playing static, pre-recorded audio. Engage with synthesized voices that give callers a sense of familiarity and personalization. + + - Voice generation in devices - enable natural communications with users by empowering your devices to speak humanlike voices. Build an end-to-end voice user interface together with Speech-to-Text and improve user experience with easy and engaging interactions. + + - Accessible EPGs (Electronic Program Guides) - implement text-to-speech functionality in EPGs to provide a better user experience to customers and meet accessibility requirements for services and applications. version: '0.1.0' x-subscribelink: text-to-speech_eng servers: From 350731aac39f93d14baee7facd79e908fec70c14 Mon Sep 17 00:00:00 2001 From: Priyadharshini <57977344+priyadharshini-sent@users.noreply.github.com> Date: Sat, 28 Nov 2020 17:05:04 +0530 Subject: [PATCH 207/792] Update text-to-speech_chi.yaml --- yaml/text-to-speech_chi.yaml | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/yaml/text-to-speech_chi.yaml b/yaml/text-to-speech_chi.yaml index c79b4c436..34f42b2af 100644 --- a/yaml/text-to-speech_chi.yaml +++ b/yaml/text-to-speech_chi.yaml @@ -7,6 +7,13 @@ info: The Text-to-Speech AI generated synthesized voice speaks with native Mandarin accent. Do ensure that your text is **within 750 characters**. + x-additionalinfo: |+ + Suggested Use Cases: + - Voice bots in contact centers - Deliver a better voice experience for customer service by dynamically generating speech, instead of playing static, pre-recorded audio. Engage with synthesized voices that give callers a sense of familiarity and personalization. + + - Voice generation in devices - Enable natural communications with users by empowering your devices to speak humanlike voices. Build an end-to-end voice user interface together with Speech-to-Text and improve user experience with easy and engaging interactions. + + - Accessible EPGs (Electronic Program Guides) - Implement text-to-speech functionality in EPGs to provide a better user experience to customers and meet accessibility requirements for services and applications. version: '0.1.0' x-subscribelink: text-to-speech_chi servers: From fab6c21e8dba62b708367fa140c76414f24a8975 Mon Sep 17 00:00:00 2001 From: Priyadharshini <57977344+priyadharshini-sent@users.noreply.github.com> Date: Sat, 28 Nov 2020 17:06:17 +0530 Subject: [PATCH 208/792] Update page_profiler_eng.yaml --- yaml/page_profiler_eng.yaml | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/yaml/page_profiler_eng.yaml b/yaml/page_profiler_eng.yaml index 3244b57b5..780eb4217 100644 --- a/yaml/page_profiler_eng.yaml +++ b/yaml/page_profiler_eng.yaml @@ -9,6 +9,11 @@ The named-entity classes extracted are persons, locations, organisations and miscellaneous.

This microservice automatically extracts structured information from unstructured text data such as chatlogs, emails, news articles, etc. Do ensure that your URL text is in the **ASCII format**. + x-additionalinfo: |+ + Suggested Use Cases: + - Gain insights from online customers - extract structured information from unstructured text data such as chatlogs, emails, news articles, etc. to find and label fields within a document and then apply sentiment analysis to understand customer opinions to find actionable product and UX insights. + + - Entity analysis - identify entities within documents, including receipts, invoices, and contracts; and label them by types such as date, person, contact information, organization, location, events, products, and media. version: '1.0.0' x-subscribelink: page_profiler_eng x-depreciated: "Oct 15, 2020" From 3ce346317a44a6572d21aefc3bf84a15cfd52b3f Mon Sep 17 00:00:00 2001 From: Priyadharshini <57977344+priyadharshini-sent@users.noreply.github.com> Date: Sat, 28 Nov 2020 17:07:01 +0530 Subject: [PATCH 209/792] Update directory_of_singapore_startups.yaml --- yaml/directory_of_singapore_startups.yaml | 3 +++ 1 file changed, 3 insertions(+) diff --git a/yaml/directory_of_singapore_startups.yaml b/yaml/directory_of_singapore_startups.yaml index 0025a8d8f..b4f9b672a 100644 --- a/yaml/directory_of_singapore_startups.yaml +++ b/yaml/directory_of_singapore_startups.yaml @@ -5,6 +5,9 @@ info: description: |+ This Data microservice retrieves the list of all Singapore startup companies found on the internet through web scraping. Updated quarterly. x-additionalinfo: |+ + Suggested Use Cases: + - Build solutions related to startups in Singapore. For example, investors interested in industry analysis can use this microservice to identify the trends and patterns in Singapore's startup scene. + **Refining queries in the filterdata field using filter types and match types** The filterdata fields use elasticsearch’s syntax (specifically filter types and match types) to help further refine search results and provide greater flexibility in structuring more sophisticated queries. From 9de7e08ddd19f267b48987146cd553a7cab8e4f7 Mon Sep 17 00:00:00 2001 From: Priyadharshini <57977344+priyadharshini-sent@users.noreply.github.com> Date: Sat, 28 Nov 2020 17:07:43 +0530 Subject: [PATCH 210/792] Update commercial_directories_hdb_sg.yaml --- yaml/commercial_directories_hdb_sg.yaml | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/yaml/commercial_directories_hdb_sg.yaml b/yaml/commercial_directories_hdb_sg.yaml index a235fecbc..094f6475f 100644 --- a/yaml/commercial_directories_hdb_sg.yaml +++ b/yaml/commercial_directories_hdb_sg.yaml @@ -12,6 +12,10 @@ info: **Note:** As this microservice uses the GET method, developers using this microservice must remember to have their app encode all the input values to be URL friendly (i.e. all spaces and special characters must be replaced). Here’s a reference on [URL encoding](https://www.w3schools.com/tags/ref_urlencode.ASP). x-additionalinfo : |+ + Suggested Use Cases: + - Build a resident community mobile app with e-commerce collection and estate directory features. To illustrate, the app can: + Name retail shops in HDBs based on their GPS location. + **Refining queries in the filterdata field using filter types and match types** The filterdata fields use elasticsearch’s syntax (specifically filter types and match types) to help further refine search results and provide greater flexibility in structuring more sophisticated queries. From cf108a4f71878ef84acfbcbf9371a9a11eac5bd4 Mon Sep 17 00:00:00 2001 From: Priyadharshini <57977344+priyadharshini-sent@users.noreply.github.com> Date: Sat, 28 Nov 2020 17:08:24 +0530 Subject: [PATCH 211/792] Update residential_sales_and_rental_hdb_sg.yaml --- yaml/residential_sales_and_rental_hdb_sg.yaml | 3 +++ 1 file changed, 3 insertions(+) diff --git a/yaml/residential_sales_and_rental_hdb_sg.yaml b/yaml/residential_sales_and_rental_hdb_sg.yaml index f16558d14..7c10d033e 100644 --- a/yaml/residential_sales_and_rental_hdb_sg.yaml +++ b/yaml/residential_sales_and_rental_hdb_sg.yaml @@ -12,6 +12,9 @@ info: **Note:** As this microservice uses the GET method, developers using this microservice must remember to have their app encode all the input values to be URL friendly (i.e. all spaces and special characters must be replaced). Here’s a reference on [URL encoding](https://www.w3schools.com/tags/ref_urlencode.ASP). x-additionalinfo : |+ + Suggested Use Cases: + - Information can be used to build a community app that benefits from geo-targeting family types and income groups by areas for non-profit charity/social organizations, real estate developers, property agencies, retail shops, marketing for educational sector, government agencies. + **Refining queries in the filterdata field using filter types and match types** The filterdata fields use elasticsearch’s syntax (specifically filter types and match types) to help further refine search results and provide greater flexibility in structuring more sophisticated queries. From e6ab39df2729e4a4b58ccc118705de0fc0c455cf Mon Sep 17 00:00:00 2001 From: Priyadharshini <57977344+priyadharshini-sent@users.noreply.github.com> Date: Sat, 28 Nov 2020 17:17:56 +0530 Subject: [PATCH 212/792] Update pki_key_generator.yaml --- yaml/pki_key_generator.yaml | 3 +++ 1 file changed, 3 insertions(+) diff --git a/yaml/pki_key_generator.yaml b/yaml/pki_key_generator.yaml index 73c32ed27..6fd6f6a75 100644 --- a/yaml/pki_key_generator.yaml +++ b/yaml/pki_key_generator.yaml @@ -3,6 +3,9 @@ info: title: PKI Key Generator description: |+ This Utiltiy microservice generates Public key and Private key pair, and is useful for encryption purposes. + x-additionalinfo: |+ + Suggested Use Cases: + - This microservice can be used to simplify the deployment, management, and security of one's enterprise PKI with a microservice that helps to automate time-consuming, risky, and error-prone infrastructure tasks, freeing users to focus on higher-value projects. version: '0.1.0' x-subscribelink: pki_key_generator servers: From d0bc7fc14ab06a72b34921bf556f98eb158bd7a2 Mon Sep 17 00:00:00 2001 From: Priyadharshini <57977344+priyadharshini-sent@users.noreply.github.com> Date: Sat, 28 Nov 2020 17:18:40 +0530 Subject: [PATCH 213/792] Update encryption_using_pki_key.yaml --- yaml/encryption_using_pki_key.yaml | 3 +++ 1 file changed, 3 insertions(+) diff --git a/yaml/encryption_using_pki_key.yaml b/yaml/encryption_using_pki_key.yaml index 32d3e90e0..d4e435ec7 100644 --- a/yaml/encryption_using_pki_key.yaml +++ b/yaml/encryption_using_pki_key.yaml @@ -7,6 +7,9 @@ info: This can be use with PKI Key Generator. Do ensure that your text is **within 512 characters**. + x-additionalinfo: |+ + Suggested Use Cases: + - This microservice can be used to simplify the deployment, management, and security of one's enterprise PKI with a microservice that helps to automate time-consuming, risky, and error-prone infrastructure tasks, freeing users to focus on higher-value projects. version: '0.1.0' x-subscribelink: encryption_using_pki_key servers: From 65a791309f98f79b8c5b64d229eaf59bb5ea109d Mon Sep 17 00:00:00 2001 From: Priyadharshini <57977344+priyadharshini-sent@users.noreply.github.com> Date: Sat, 28 Nov 2020 17:19:42 +0530 Subject: [PATCH 214/792] Update decryption_using_pki_key.yaml --- yaml/decryption_using_pki_key.yaml | 3 +++ 1 file changed, 3 insertions(+) diff --git a/yaml/decryption_using_pki_key.yaml b/yaml/decryption_using_pki_key.yaml index 27b337bd9..a74ba60d9 100644 --- a/yaml/decryption_using_pki_key.yaml +++ b/yaml/decryption_using_pki_key.yaml @@ -7,6 +7,9 @@ info: This can be use with PKI Key Generator. Do ensure that your text is **within 512 characters**. + x-additionalinfo: |+ + Suggested Use Cases: + - This microservice can be used to simplify the deployment, management, and security of one's enterprise PKI with a microservice that helps to automate time-consuming, risky, and error-prone infrastructure tasks, freeing users to focus on higher-value projects. version: '0.1.0' x-subscribelink: decryption_using_pki_key servers: From 78a79df87e23ceacc5a3a6bf59e2c7aced161473 Mon Sep 17 00:00:00 2001 From: Priyadharshini <57977344+priyadharshini-sent@users.noreply.github.com> Date: Sat, 28 Nov 2020 17:20:28 +0530 Subject: [PATCH 215/792] Update carpark_hdb_sg.yaml --- yaml/carpark_hdb_sg.yaml | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/yaml/carpark_hdb_sg.yaml b/yaml/carpark_hdb_sg.yaml index 430299026..c44c2e220 100644 --- a/yaml/carpark_hdb_sg.yaml +++ b/yaml/carpark_hdb_sg.yaml @@ -12,6 +12,13 @@ info: **Note:** As this microservice uses the GET method, developers using this microservice must remember to have their app encode all the input values to be URL friendly (i.e. all spaces and special characters must be replaced). Here’s a reference on [URL encoding](https://www.w3schools.com/tags/ref_urlencode.ASP). x-additionalinfo : |+ + Suggested Use Cases: + - Geo-targeting app with map feature, property development planning resource, or planning for vehicle-sharing app. + + - Real estate services - can be used as a background check solution to extract information related to the types and number of carparks present in an area for people with certain preferences when buying or renting a HDB home. + + - Can also be integrated into apps related to maps or parking for more detailed carpark information within Singapore HDB estates + **Refining queries in the filterdata field using filter types and match types** The filterdata fields use elasticsearch’s syntax (specifically filter types and match types) to help further refine search results and provide greater flexibility in structuring more sophisticated queries. From 4bdc5d4e834c59ab72557a16f21f66c85b15f58b Mon Sep 17 00:00:00 2001 From: Priyadharshini <57977344+priyadharshini-sent@users.noreply.github.com> Date: Sat, 28 Nov 2020 17:20:59 +0530 Subject: [PATCH 216/792] Update building_addresses_hdb_sg.yaml --- yaml/building_addresses_hdb_sg.yaml | 3 +++ 1 file changed, 3 insertions(+) diff --git a/yaml/building_addresses_hdb_sg.yaml b/yaml/building_addresses_hdb_sg.yaml index 281883ad3..5a313b292 100644 --- a/yaml/building_addresses_hdb_sg.yaml +++ b/yaml/building_addresses_hdb_sg.yaml @@ -10,6 +10,9 @@ info: **Note:** As this microservice uses the GET method, developers using this microservice must remember to have their app encode all the input values to be URL friendly (i.e. all spaces and special characters must be replaced). Here’s a reference on [URL encoding](https://www.w3schools.com/tags/ref_urlencode.ASP). x-additionalinfo : |+ + Suggested Use Cases: + - Information from this microservice can be used to build a geo-targeting app with precise map features. + **Refining queries in the filterdata field using filter types and match types** The filterdata fields use elasticsearch’s syntax (specifically filter types and match types) to help further refine search results and provide greater flexibility in structuring more sophisticated queries. From 577f1f2be10424e4ee9dc0bd75cd7b0b45186d63 Mon Sep 17 00:00:00 2001 From: Priyadharshini <57977344+priyadharshini-sent@users.noreply.github.com> Date: Sat, 28 Nov 2020 17:21:37 +0530 Subject: [PATCH 217/792] Update named-entity_recognition_eng.yaml --- yaml/named-entity_recognition_eng.yaml | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/yaml/named-entity_recognition_eng.yaml b/yaml/named-entity_recognition_eng.yaml index 235af98ed..d7afffb37 100644 --- a/yaml/named-entity_recognition_eng.yaml +++ b/yaml/named-entity_recognition_eng.yaml @@ -9,6 +9,13 @@ info: This microservice automatically extracts structured information from unstructured text data such as chatlogs, emails, news articles, etc. Do ensure that your text is within **5000 characters**. + x-additionalinfo: |+ + Suggested Use Cases: + - Extracting structured pre-defined information from text. + + - Gain insights from online customers - extract structured information from unstructured text data such as chatlogs, emails, news articles, etc. to find and label fields within a document and then apply sentiment analysis to understand customer opinions to find actionable product and UX insights. + + - Entity analysis - identify entities within documents, including receipts, invoices, and contracts; and label them by types such as date, person, contact information, organization, location, events, products, and media. version: '0.1.0' x-subscribelink: named-entity_recognition_eng servers: From 753fec71d67bad795d593a10ff0fceb102900573 Mon Sep 17 00:00:00 2001 From: Priyadharshini <57977344+priyadharshini-sent@users.noreply.github.com> Date: Sat, 28 Nov 2020 17:22:14 +0530 Subject: [PATCH 218/792] Update video-to-audio_convertor.yaml --- yaml/video-to-audio_convertor.yaml | 3 +++ 1 file changed, 3 insertions(+) diff --git a/yaml/video-to-audio_convertor.yaml b/yaml/video-to-audio_convertor.yaml index e3025959d..297a5c729 100644 --- a/yaml/video-to-audio_convertor.yaml +++ b/yaml/video-to-audio_convertor.yaml @@ -6,6 +6,9 @@ info: The size of your video file should **not exceed 3.5 MB**. version: '0.1.0' + x-additionalinfo: |+ + Suggested Use Cases: + - For building applications that extracts audio from videos in batches. Users can further pipe the audio into microservices involving ASR for further transciption. x-subscribelink: video-to-audio_convertor servers: - url: 'https://apis.sentient.io' From 21a80583c25bd995bf309a3ec4ce6b3feef8bd0d Mon Sep 17 00:00:00 2001 From: Priyadharshini <57977344+priyadharshini-sent@users.noreply.github.com> Date: Sat, 28 Nov 2020 17:23:01 +0530 Subject: [PATCH 219/792] Update word_sense_disambiguation_eng.yaml --- yaml/word_sense_disambiguation_eng.yaml | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/yaml/word_sense_disambiguation_eng.yaml b/yaml/word_sense_disambiguation_eng.yaml index c8921c11a..912364568 100644 --- a/yaml/word_sense_disambiguation_eng.yaml +++ b/yaml/word_sense_disambiguation_eng.yaml @@ -5,7 +5,11 @@ info: This NLP microservice takes in a text and a target word and identifies the target word's hypernym. Hypernym refers to the specific meaning of the word within the context of the sentence. For example, colour is a hypernym of red. If the word is determined to be a noun within the sentence context, the microservice returns the potential hypernym, definition, and score. Otherwise, no result will be returned for that context. + x-additionalinfo: |+ + Suggested Use Cases: + - Information Retrieval - this microservice can be used to build a system that assists users in finding the information they required but it does not explicitly return the answers of the questions. + - Text Mining and Information Extraction - this microservice can be used to do accurate analysis of text. For example it can help to create an intelligent gathering system to do flagging of the correct words e.g. medical intelligent system might need flagging of “red balloon” rather than “led balloon”. version: '0.1.0' x-subscribelink: word_sense_disambiguation_eng servers: From bdd71d93c1f22e5bc6d87247aea6e62eff240082 Mon Sep 17 00:00:00 2001 From: Priyadharshini <57977344+priyadharshini-sent@users.noreply.github.com> Date: Sat, 28 Nov 2020 17:23:35 +0530 Subject: [PATCH 220/792] Update inverse_text_normalisation_eng.yaml --- yaml/inverse_text_normalisation_eng.yaml | 3 +++ 1 file changed, 3 insertions(+) diff --git a/yaml/inverse_text_normalisation_eng.yaml b/yaml/inverse_text_normalisation_eng.yaml index e0155665b..9d8a53bfc 100644 --- a/yaml/inverse_text_normalisation_eng.yaml +++ b/yaml/inverse_text_normalisation_eng.yaml @@ -7,6 +7,9 @@ info: This NLP microservice also converts pre-defined abbreviations from lower case to upper case. This NLP microservice also converts first letters of sentences to upper case. + x-additionalinfo: |+ + Suggested Use Cases: + - Can be integrated into services or apps that offer digital writing assistance to make writing clear and effective. version: '0.1.0' x-subscribelink: inverse_text_normalisation_eng servers: From b2fc7951d6b904498705e32731d7f8307552e4d7 Mon Sep 17 00:00:00 2001 From: Priyadharshini <57977344+priyadharshini-sent@users.noreply.github.com> Date: Sat, 28 Nov 2020 17:24:38 +0530 Subject: [PATCH 221/792] Update audio_format_convertor.yaml --- yaml/audio_format_convertor.yaml | 3 +++ 1 file changed, 3 insertions(+) diff --git a/yaml/audio_format_convertor.yaml b/yaml/audio_format_convertor.yaml index 7aa999b33..49e7ef64c 100644 --- a/yaml/audio_format_convertor.yaml +++ b/yaml/audio_format_convertor.yaml @@ -5,6 +5,9 @@ info: This API is used to convert your audio like music(any format) to the WAV format. The size of your audio file should **not exceed 10 MB**. + x-additionalinfo: |+ + Suggested Use Cases: + - Build services related to sound engineering or audio editing as WAV is the format of choice for video and audio editors. WAV files are lossless compared to the lossy MP3 file format, meaning that WAV audio is a high-quality uncompressed file that is excellent for studio recordings and audio mastering. version: '0.1.0' x-subscribelink: audio_format_convertor servers: From e9216c31dd366b0220769793230bfc05e8c664c3 Mon Sep 17 00:00:00 2001 From: Priyadharshini <57977344+priyadharshini-sent@users.noreply.github.com> Date: Sat, 28 Nov 2020 17:25:13 +0530 Subject: [PATCH 222/792] Update taxonomy_matcher_eng.yaml --- yaml/taxonomy_matcher_eng.yaml | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/yaml/taxonomy_matcher_eng.yaml b/yaml/taxonomy_matcher_eng.yaml index 309bdc885..be8e2ad41 100644 --- a/yaml/taxonomy_matcher_eng.yaml +++ b/yaml/taxonomy_matcher_eng.yaml @@ -9,6 +9,11 @@ info: This microservice can help identify the types of concept that are frequently mentioned in an article. Do ensure that your text is within **5000 characters**. + x-additionalinfo: |+ + Suggested Use Cases: + - Categorise a particular word to pre-built taxonomy tree. + + - This microservice can be used to manage taxonomies, such as a hierarchy of product categories used for an eCommerce site. The information in a taxonomy is meta-information about the categories used to classify a set of things. For an eCommerce site, the set of things are items in the product catalog. Users can use this meta-information to enhance search. version: '0.1.0' x-subscribelink: taxonomy_matcher_eng servers: From 756b451c9148b01406577a35e6835e882566d8f7 Mon Sep 17 00:00:00 2001 From: Priyadharshini <57977344+priyadharshini-sent@users.noreply.github.com> Date: Sat, 28 Nov 2020 17:25:47 +0530 Subject: [PATCH 223/792] Update wikipedia_retrieval.yaml --- yaml/wikipedia_retrieval.yaml | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/yaml/wikipedia_retrieval.yaml b/yaml/wikipedia_retrieval.yaml index 60cd34b95..f7ccc3b9d 100644 --- a/yaml/wikipedia_retrieval.yaml +++ b/yaml/wikipedia_retrieval.yaml @@ -3,6 +3,11 @@ info: title: Wikipedia Retrieval description: |+ It is an API that provides the user with a Wikipedia article based on the input keyword. Refer to this link for the full list of Wikipedias - https://meta.wikimedia.org/wiki/List_of_Wikipedias + x-additionalinfo: |+ + Suggested Use Cases: + - Access topics within Wikipedia with great specificity. Can be used for research/study-related solutions by using information from this microservice to compare articles, revisions and more. + + - Extract the most relevant content from Wikipedia’s categories to provide a text analysis service to ascertain what any text is in reference to. version: '0.1.0' x-subscribelink: wikipedia_retrieval servers: From b2999397835a2e4632c363bd779dfa3d0fc1d8f6 Mon Sep 17 00:00:00 2001 From: Priyadharshini <57977344+priyadharshini-sent@users.noreply.github.com> Date: Sat, 28 Nov 2020 17:26:25 +0530 Subject: [PATCH 224/792] Update object_detection.yaml --- yaml/object_detection.yaml | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/yaml/object_detection.yaml b/yaml/object_detection.yaml index a43ca866b..38dd04129 100644 --- a/yaml/object_detection.yaml +++ b/yaml/object_detection.yaml @@ -9,6 +9,13 @@ info: The classes are: person, bicycle, car, motorbike, aeroplane, bus, train, truck, boat, traffic light, fire hydrant, stop sign, parking meter, bench, bird, cat, dog, horse, sheep, cow, elephant, bear, zebra, giraffe, backpack, umbrella, handbag, tie, suitcase, frisbee, skis, snowboard, sports ball, kite, baseball bat, baseball glove, skateboard, surfboard, tennis racket, bottle, wine glass, cup, fork, knife, spoon, bowl, banana, apple, sandwich, orange, broccoli, carrot, hot dog, pizza, donut, cake, chair, sofa, pottedplant, bed, diningtable, toilet, tvmonitor, laptop, mouse, remote, keyboard, cell phone, microwave, oven, toaster, sink, refrigerator, book, clock, vase, scissors, teddy bear, hair drier, toothbrush. The size of your image file should **not exceed 5 MB**, and the image dimension should be **at least 416x416 pixels**. + x-additionalinfo: |+ + Suggested Use Cases: + - Industrial inspection - use Object Detection to automate the quality control process in manufacturing by enabling edge devices to identify defects. + + - Product search - build a product search app to find products of interest within images and visually search product catalogs. + + - Build an object detection app for the visually-impaired - help users identify daily objects that they may need aid in recognising version: '0.1.0' x-subscribelink: object_detection servers: From 15acd5b5056ca1d56e39c9153928f148f0a3d414 Mon Sep 17 00:00:00 2001 From: Priyadharshini <57977344+priyadharshini-sent@users.noreply.github.com> Date: Sat, 28 Nov 2020 17:27:06 +0530 Subject: [PATCH 225/792] Update json-csv_convertor.yaml --- yaml/json-csv_convertor.yaml | 3 +++ 1 file changed, 3 insertions(+) diff --git a/yaml/json-csv_convertor.yaml b/yaml/json-csv_convertor.yaml index d3878813d..fa7493441 100644 --- a/yaml/json-csv_convertor.yaml +++ b/yaml/json-csv_convertor.yaml @@ -3,6 +3,9 @@ info: title: JSON-CSV Convertor description: |+ This Utility microservice converts the input JSON (json string or json file) to CSV format. + x-additionalinfo: |+ + Suggested Use Cases: + - For users who would like to combine data into useful spreadsheets for others to analyze, update, or refer to. This microservice can convert a collection of JSON into CSV spreadsheets like Google Sheets or Excel to analyze data without programming. version: '1.0.0' x-subscribelink: json-csv_convertor servers: From 3add3c0e2560f5355ff8c9add83039209254d7fa Mon Sep 17 00:00:00 2001 From: Priyadharshini <57977344+priyadharshini-sent@users.noreply.github.com> Date: Sat, 28 Nov 2020 17:27:36 +0530 Subject: [PATCH 226/792] Update csv-json_convertor.yaml --- yaml/csv-json_convertor.yaml | 3 +++ 1 file changed, 3 insertions(+) diff --git a/yaml/csv-json_convertor.yaml b/yaml/csv-json_convertor.yaml index 4d8abd8bc..787783873 100644 --- a/yaml/csv-json_convertor.yaml +++ b/yaml/csv-json_convertor.yaml @@ -5,6 +5,9 @@ info: This Utility microservice converts the input CSV to JSON format. The headers should be the keywords and columns should be the value of proper keywords. The size of your file should **not exceed 3.5 MB**. + x-additionalinfo: |+ + Suggested Use Cases: + - For users who would like to combine data into useful spreadsheets for others to analyze, update, or refer to. This microservice can convert a collection of CSV spreadsheets like Google Sheets or Excel into JSON to analyze data without programming. version: '1.0.0' x-subscribelink: csv-json_convertor servers: From 03e8f60e30b8381e9b4603c25a3c1b4992dadf66 Mon Sep 17 00:00:00 2001 From: Priyadharshini <57977344+priyadharshini-sent@users.noreply.github.com> Date: Sat, 28 Nov 2020 17:28:07 +0530 Subject: [PATCH 227/792] Update youtube_video_downloader.yaml --- yaml/youtube_video_downloader.yaml | 3 +++ 1 file changed, 3 insertions(+) diff --git a/yaml/youtube_video_downloader.yaml b/yaml/youtube_video_downloader.yaml index 879d08219..3f6328aaa 100644 --- a/yaml/youtube_video_downloader.yaml +++ b/yaml/youtube_video_downloader.yaml @@ -3,6 +3,9 @@ info: title: Youtube Video Downloader description: |+ This Utility microservice retrieves the Youtube video of the input URL and outputs a download link. + x-additionalinfo: |+ + Suggested Use Cases: + - Can be integrated into apps used to download and watch videos when the user wants to save limited data. version: '0.1.0' x-subscribelink: youtube_video_downloader servers: From 32157bd1b08787e511e892daf5d0157ecc85b43f Mon Sep 17 00:00:00 2001 From: Priyadharshini <57977344+priyadharshini-sent@users.noreply.github.com> Date: Sat, 28 Nov 2020 17:28:29 +0530 Subject: [PATCH 228/792] Update script_alignment.yaml --- yaml/script_alignment.yaml | 3 +++ 1 file changed, 3 insertions(+) diff --git a/yaml/script_alignment.yaml b/yaml/script_alignment.yaml index c209fd573..15557c07e 100644 --- a/yaml/script_alignment.yaml +++ b/yaml/script_alignment.yaml @@ -7,6 +7,9 @@ info: The output is the time-coded high-quality script. Do ensure that your text is within **5000 characters**. + x-additionalinfo: |+ + Suggested Use Cases: + - Can be used to create time-coded high-quality script for services like radio broadcasting, television broadcasting and digital content creation. version: '0.1.0' x-subscribelink: script_alignment servers: From 8946b2b712e1a062671688afdc2d6057ddaf449d Mon Sep 17 00:00:00 2001 From: Priyadharshini <57977344+priyadharshini-sent@users.noreply.github.com> Date: Sat, 28 Nov 2020 17:29:53 +0530 Subject: [PATCH 229/792] Update web_scraper.yaml --- yaml/web_scraper.yaml | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/yaml/web_scraper.yaml b/yaml/web_scraper.yaml index 1f8455932..dcb5c630f 100644 --- a/yaml/web_scraper.yaml +++ b/yaml/web_scraper.yaml @@ -5,6 +5,10 @@ info: description: |+ This API is used to extract content or specific HTML elements from web pages. Supports both HTML and Text output. The web scraper can be instructed to extract HTML elements that match the criteria given in the queryList HTTP request parameter, it can even do navigate down the html tree like get all p tag inside a div class "class":"class_name p". x-additionalinfo: |+ + x-additionalinfo: |+ + Suggested Use Cases: + - Can be used for contact scraping, and as a component of applications used for web indexing, web mining and data mining, online price change monitoring and price comparison, product review scraping (to watch the competition), gathering real estate listings, weather data monitoring, website change detection, research, tracking online presence and reputation, web mashup and, web data integration. + Examples: To get article content, as text From 01132e6ddec6be7f97ac1b3d496c7f4625ae8c12 Mon Sep 17 00:00:00 2001 From: Priyadharshini <57977344+priyadharshini-sent@users.noreply.github.com> Date: Sat, 28 Nov 2020 17:30:23 +0530 Subject: [PATCH 230/792] Update face_recognition_politicians_sg.yaml --- yaml/face_recognition_politicians_sg.yaml | 3 +++ 1 file changed, 3 insertions(+) diff --git a/yaml/face_recognition_politicians_sg.yaml b/yaml/face_recognition_politicians_sg.yaml index c6977385d..5358880be 100644 --- a/yaml/face_recognition_politicians_sg.yaml +++ b/yaml/face_recognition_politicians_sg.yaml @@ -5,6 +5,9 @@ info: This Computer Vision microservice recognises faces from input image files of the Members of Singapore Parliament. This microservice returns the identity of the person, the bounding box in image coordinates, and the confidence of the prediction. + x-additionalinfo: |+ + Suggested Use Cases: + - For solutions related to identifying the speaker for auto-tagging, or matching the transcription to the person that is a Member of the Singapore Parliament. version: '0.1.0' x-subscribelink: face_recognition_politicians_sg servers: From 2ca085bfc966fae2ee0ebc8437ced6bf0924ec5c Mon Sep 17 00:00:00 2001 From: Priyadharshini <57977344+priyadharshini-sent@users.noreply.github.com> Date: Sat, 28 Nov 2020 17:30:54 +0530 Subject: [PATCH 231/792] Update document_convertor_eng.yaml --- yaml/document_convertor_eng.yaml | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/yaml/document_convertor_eng.yaml b/yaml/document_convertor_eng.yaml index 6a1c177c3..78efaf409 100644 --- a/yaml/document_convertor_eng.yaml +++ b/yaml/document_convertor_eng.yaml @@ -5,6 +5,11 @@ info: This Utility microservice extracts the English text content of singular input Microsoft Word, HTML or PDF documents and outputs into plain text format. The size of your document file should **not exceed 7 MB**. + x-additionalinfo: |+ + Suggested Use Cases: + - Used for pre/post processing of documents so that the output can paired with another microservice to address a specific solution. For example, text extracted from the document can be used with a Voice microservice such as Text-to-Speech. + + - Can be used for solutions related to processing workflows that are document-heavy so that the user can focus on the more value-added decisions. Documents in a variety of formats can be taken in to return cleanly structured data. Examples included mortgage processing, procurement data etc. version: '1.0.0' x-subscribelink: document_convertor_eng servers: From ed25b84022dc36991fb385f89569b4f03d1824bc Mon Sep 17 00:00:00 2001 From: Priyadharshini <57977344+priyadharshini-sent@users.noreply.github.com> Date: Sat, 28 Nov 2020 17:31:24 +0530 Subject: [PATCH 232/792] Update newspaper_article_scraper.yaml --- yaml/newspaper_article_scraper.yaml | 3 +++ 1 file changed, 3 insertions(+) diff --git a/yaml/newspaper_article_scraper.yaml b/yaml/newspaper_article_scraper.yaml index fee96b0c6..974d8d690 100644 --- a/yaml/newspaper_article_scraper.yaml +++ b/yaml/newspaper_article_scraper.yaml @@ -7,6 +7,9 @@ info: Current supported languages: Arabic, Russian, Dutch, German, English, Spanish, French, Hebrew, Italian, Korean, Norwegian, Persian, Polish, Portuguese, Swedish, Hungarian, Finnish, Danish, Chinese, Indonesian, Vietnamese, Swahili, Turkish, Greek, Ukrainian. Supports automatic languages detection. Note that the URL has to be **spelt in full**, including "https://www." + x-additionalinfo: |+ + Suggested Use Cases: + - Can be used in services related to the creation of a real-time web application that gathers data from several newspapers and shows a summary of the different topics that are being discussed in the news articles. version: '0.1.0' x-subscribelink: newspaper_article_scraper servers: From 95ba4b759d8ad1c85e631dde7cb72f3925322d86 Mon Sep 17 00:00:00 2001 From: Priyadharshini <57977344+priyadharshini-sent@users.noreply.github.com> Date: Sat, 28 Nov 2020 17:31:52 +0530 Subject: [PATCH 233/792] Update video-to-image_convertor.yaml --- yaml/video-to-image_convertor.yaml | 3 +++ 1 file changed, 3 insertions(+) diff --git a/yaml/video-to-image_convertor.yaml b/yaml/video-to-image_convertor.yaml index a0a2569a4..cbb23d1df 100644 --- a/yaml/video-to-image_convertor.yaml +++ b/yaml/video-to-image_convertor.yaml @@ -5,6 +5,9 @@ info: This Utility microservice captures the images from the input video file at the frame rate of 1 frame per second. Supported formats are : 3g2, avi, flv, mkv, mov, mp4, ogv, webm, wmv, m4v with H.264 codec encoded. + x-additionalinfo: |+ + Suggested Use Cases: + - Can be integrated into video editing software to create a quick preview of the footage the user is editing. version: '0.1.0' x-subscribelink: video-to-image_convertor servers: From 03fe62f9d2b4b6368691d08dd52ff09cbae154ff Mon Sep 17 00:00:00 2001 From: Priyadharshini <57977344+priyadharshini-sent@users.noreply.github.com> Date: Sat, 28 Nov 2020 17:32:17 +0530 Subject: [PATCH 234/792] Update landmark_detection_sg.yaml --- yaml/landmark_detection_sg.yaml | 3 +++ 1 file changed, 3 insertions(+) diff --git a/yaml/landmark_detection_sg.yaml b/yaml/landmark_detection_sg.yaml index 23e60a22b..c98c8eee1 100644 --- a/yaml/landmark_detection_sg.yaml +++ b/yaml/landmark_detection_sg.yaml @@ -7,6 +7,9 @@ info: This microservice returns the detected landmark and confidence score. The size of your image file should **not exceed 5 MB**. + x-additionalinfo: |+ + Suggested Use Cases: + - Can be used for geo-targeting apps with map feature or property development planning resource apps. version: '0.1.0' x-subscribelink: landmark_detection_sg servers: From d12030e4cd7fe8c596d73adec2782cbbf0171cd3 Mon Sep 17 00:00:00 2001 From: Priyadharshini <57977344+priyadharshini-sent@users.noreply.github.com> Date: Sat, 28 Nov 2020 17:32:40 +0530 Subject: [PATCH 235/792] Update landmark_detection_jp.yaml --- yaml/landmark_detection_jp.yaml | 3 +++ 1 file changed, 3 insertions(+) diff --git a/yaml/landmark_detection_jp.yaml b/yaml/landmark_detection_jp.yaml index cb741ff3a..a99d082d8 100644 --- a/yaml/landmark_detection_jp.yaml +++ b/yaml/landmark_detection_jp.yaml @@ -7,6 +7,9 @@ info: The microservice returns the detected landmark and confidence score. The size of your image file should **not exceed 5 MB**. + x-additionalinfo: |+ + Suggested Use Cases: + - Can be used for geo-targeting apps with map feature or property development planning resource apps. version: '0.1.0' x-subscribelink: landmark_detection_jp servers: From f748bb423a1f06efa232b194ad54d45f53108c78 Mon Sep 17 00:00:00 2001 From: Priyadharshini <57977344+priyadharshini-sent@users.noreply.github.com> Date: Sat, 28 Nov 2020 17:33:16 +0530 Subject: [PATCH 236/792] Update pdf_extractor.yaml --- yaml/pdf_extractor.yaml | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/yaml/pdf_extractor.yaml b/yaml/pdf_extractor.yaml index 50b9495a8..39515145c 100644 --- a/yaml/pdf_extractor.yaml +++ b/yaml/pdf_extractor.yaml @@ -11,6 +11,11 @@ info: Supported languages: Hindi, German, Spanish, Portuguese, French, Turkish, Italian, Russian, Arabic, Indonesian, Chinese, Japanese and Korean. The size of your PDF file should **not exceed 7 MB**. + x-additionalinfo: |+ + Suggested Use Cases: + - Used for pre/post processing of documents so that the output can paired with another microservice to address a specific solution. For example, text extracted from the PDF document can be used with a Voice microservice such as Text-to-Speech. + + - Can be used for solutions related to processing workflows that are document-heavy so that the user can focus on the more value-added decisions. Documents in a variety of formats can be taken in to return cleanly structured data. Examples included mortgage processing, procurement data etc. version: '1.0.0' x-subscribelink: pdf_extractor servers: From f7b222389de81ae40e171b97c5c52e94e15c5031 Mon Sep 17 00:00:00 2001 From: Priyadharshini <57977344+priyadharshini-sent@users.noreply.github.com> Date: Sat, 28 Nov 2020 17:33:39 +0530 Subject: [PATCH 237/792] Update urls_retrieval.yaml --- yaml/urls_retrieval.yaml | 3 +++ 1 file changed, 3 insertions(+) diff --git a/yaml/urls_retrieval.yaml b/yaml/urls_retrieval.yaml index 8ae6555f1..46e59600f 100644 --- a/yaml/urls_retrieval.yaml +++ b/yaml/urls_retrieval.yaml @@ -5,6 +5,9 @@ info: This Utility microservice crawls and retrieves content from the input URLs, up to the specified depth. Default depth is 0 and maximum number of URLs is 500. + x-additionalinfo: |+ + Suggested Use Cases: + - Use this microservice to update web content or indices of other sites' web content. version: '0.2.0' x-subscribelink: urls_retrieval servers: From 3b8dae72d31e4b79da170b30d762cf37aab96cd1 Mon Sep 17 00:00:00 2001 From: Priyadharshini <57977344+priyadharshini-sent@users.noreply.github.com> Date: Sat, 28 Nov 2020 17:34:11 +0530 Subject: [PATCH 238/792] Update named-entity_recognition_jp.yaml --- yaml/named-entity_recognition_jp.yaml | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/yaml/named-entity_recognition_jp.yaml b/yaml/named-entity_recognition_jp.yaml index 2992651aa..e121ab660 100644 --- a/yaml/named-entity_recognition_jp.yaml +++ b/yaml/named-entity_recognition_jp.yaml @@ -7,6 +7,13 @@ info: The named-entity classes extracted are persons, locations, organisations and miscellaneous. This microservice automatically extracts structured information from unstructured text data such as chatlogs, emails, news articles, etc. + x-additionalinfo: |+ + Suggested Use Cases: + - Extract structured pre-defined information from text. + + - Insights from online customers - extract structured information from unstructured text data such as chatlogs, emails, news articles, etc. to find and label fields within a document and then apply sentiment analysis to understand customer opinions to find actionable product and UX insights. + + - Entity analysis - identify entities within documents, including receipts, invoices, and contracts; and label them by types such as date, person, contact information, organization, location, events, products, and media. version: '0.1.0' x-subscribelink: named-entity_recognition_jp servers: From 9e6b889d7ce84eaf12fee8409c6d7f34093d0b17 Mon Sep 17 00:00:00 2001 From: Priyadharshini <57977344+priyadharshini-sent@users.noreply.github.com> Date: Sat, 28 Nov 2020 17:34:41 +0530 Subject: [PATCH 239/792] Update named-entity_recognition_thai.yaml --- yaml/named-entity_recognition_thai.yaml | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/yaml/named-entity_recognition_thai.yaml b/yaml/named-entity_recognition_thai.yaml index fd4d13fc0..3b0d40163 100644 --- a/yaml/named-entity_recognition_thai.yaml +++ b/yaml/named-entity_recognition_thai.yaml @@ -7,6 +7,13 @@ info: The named-entity classes extracted are persons, locations, organisations and miscellaneous. This microservice automatically extracts structured information from unstructured text data such as chatlogs, emails, news articles, etc. + x-additionalinfo: |+ + Suggested Use Cases: + - Extract structured pre-defined information from text. + + - Insights from online customers - extract structured information from unstructured text data such as chatlogs, emails, news articles, etc. to find and label fields within a document and then apply sentiment analysis to understand customer opinions to find actionable product and UX insights. + + - Entity analysis - identify entities within documents, including receipts, invoices, and contracts; and label them by types such as date, person, contact information, organization, location, events, products, and media. version: '0.1.0' x-subscribelink: named-entity_recognition_thai servers: From 06ece0e7b8b544ef097e01884bad8ccc7a5ea6f5 Mon Sep 17 00:00:00 2001 From: Priyadharshini <57977344+priyadharshini-sent@users.noreply.github.com> Date: Sat, 28 Nov 2020 17:35:16 +0530 Subject: [PATCH 240/792] Update page_profiler_jp.yaml --- yaml/page_profiler_jp.yaml | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/yaml/page_profiler_jp.yaml b/yaml/page_profiler_jp.yaml index 2b136f16d..f757141aa 100644 --- a/yaml/page_profiler_jp.yaml +++ b/yaml/page_profiler_jp.yaml @@ -7,6 +7,11 @@ The named-entity classes extracted are persons, locations, organisations and miscellaneous. This microservice automatically extracts structured information from unstructured text data such as chatlogs, emails, news articles, etc. + x-additionalinfo: |+ + Suggested Use Cases: + - Insights from online customers - extract structured information from unstructured text data such as chatlogs, emails, news articles, etc. to find and label fields within a document and then apply sentiment analysis to understand customer opinions to find actionable product and UX insights. + + - Entity analysis - identify entities within documents, including receipts, invoices, and contracts; and label them by types such as date, person, contact information, organization, location, events, products, and media. version: '1.0.0' x-subscribelink: page_profiler_jp servers: From 4ca5151e0ae34b938764410f851dd95798d3ccec Mon Sep 17 00:00:00 2001 From: Priyadharshini <57977344+priyadharshini-sent@users.noreply.github.com> Date: Sat, 28 Nov 2020 17:35:49 +0530 Subject: [PATCH 241/792] Update page_profiler_thai.yaml --- yaml/page_profiler_thai.yaml | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/yaml/page_profiler_thai.yaml b/yaml/page_profiler_thai.yaml index 33bba8d3c..e8749ba30 100644 --- a/yaml/page_profiler_thai.yaml +++ b/yaml/page_profiler_thai.yaml @@ -7,6 +7,11 @@ The named-entity classes extracted are persons, locations, organisations and miscellaneous. This microservice automatically extracts structured information from unstructured text data such as chatlogs, emails, news articles, etc. + x-additionalinfo: |+ + Suggested Use Cases: + - Insights from online customers - extract structured information from unstructured text data such as chatlogs, emails, news articles, etc. to find and label fields within a document and then apply sentiment analysis to understand customer opinions to find actionable product and UX insights. + + - Entity analysis - identify entities within documents, including receipts, invoices, and contracts; and label them by types such as date, person, contact information, organization, location, events, products, and media. version: '1.0.0' x-subscribelink: page_profiler_thai servers: From 1aaea067c4a529371f99db5846f92e4ac0e3f613 Mon Sep 17 00:00:00 2001 From: Priyadharshini <57977344+priyadharshini-sent@users.noreply.github.com> Date: Sat, 28 Nov 2020 17:36:16 +0530 Subject: [PATCH 242/792] Update spacy_named-entity_recognition_eng.yaml --- yaml/spacy_named-entity_recognition_eng.yaml | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/yaml/spacy_named-entity_recognition_eng.yaml b/yaml/spacy_named-entity_recognition_eng.yaml index 34ed38c5c..50c75ff93 100644 --- a/yaml/spacy_named-entity_recognition_eng.yaml +++ b/yaml/spacy_named-entity_recognition_eng.yaml @@ -9,7 +9,9 @@ info: This microservice automatically extracts structured information from unstructured text data such as chatlogs, emails, news articles, etc. Do ensure that your text is **within 5000 characters**. - + x-additionalinfo: |+ + Suggested Use Cases: + - Can be used to build information extraction or natural language understanding systems, or to pre-process text for deep learning -e.g. tokenization, Parts-of-Speech (PoS) Tagging, Text Classification and Named Entity Recognition. version: '0.1.0' x-subscribelink: spacy_ner servers: From 1a3c4f877ef50f8c1673f2ca7081812b5f8e588e Mon Sep 17 00:00:00 2001 From: Priyadharshini <57977344+priyadharshini-sent@users.noreply.github.com> Date: Sat, 28 Nov 2020 17:37:44 +0530 Subject: [PATCH 243/792] Update base64-file-encode.yaml --- yaml/base64-file-encode.yaml | 3 +++ 1 file changed, 3 insertions(+) diff --git a/yaml/base64-file-encode.yaml b/yaml/base64-file-encode.yaml index bf5a9d699..35b9e25a2 100644 --- a/yaml/base64-file-encode.yaml +++ b/yaml/base64-file-encode.yaml @@ -3,6 +3,9 @@ info: title: Base64 Encoder description: |+ This Utility microservice converts an uploaded file to Base64 encoded text (also known as a binary file to text converter). This microservice supports most documents, images, audio, video, archive and font files. See documentation for the detailed list of supported file formats.

User can choose the output base64 text string in 5 different formats (plain text, JSON, hyperlink, datauri, XML).

For the reverse process (converting Base64 string back to binary file), check out the Base 64 File Decode microservice. + x-additionalinfo: |+ + Suggested Use Cases: + - As a pre-processor for microservices that only takes in Base64 inputs version: '0.0.1' x-subscribelink: base64_file_encode servers: From 5f1a675a9a2ea908f5fbff998de930b1c3e3ee0e Mon Sep 17 00:00:00 2001 From: Priyadharshini <57977344+priyadharshini-sent@users.noreply.github.com> Date: Sat, 28 Nov 2020 17:38:11 +0530 Subject: [PATCH 244/792] Update base64-file-decode.yaml --- yaml/base64-file-decode.yaml | 3 +++ 1 file changed, 3 insertions(+) diff --git a/yaml/base64-file-decode.yaml b/yaml/base64-file-decode.yaml index dc1ce2661..79983132b 100644 --- a/yaml/base64-file-decode.yaml +++ b/yaml/base64-file-decode.yaml @@ -3,6 +3,9 @@ info: title: Base64 Decoder description: |+ This Utility microservice converts a Base64 encoded text string to a binary file.

For the reverse process (convert binary file to Base64 encoded text string), check out the Base64 File Encode microservice. + x-additionalinfo: |+ + Suggested Use Cases: + - As a post-processor for microservices that only outputs Base64 encoded text version: '0.0.1' x-subscribelink: base64_file_decode servers: From 9322c624e60a69546487c7ae4079f81a953ee049 Mon Sep 17 00:00:00 2001 From: Priyadharshini <57977344+priyadharshini-sent@users.noreply.github.com> Date: Sat, 28 Nov 2020 17:38:35 +0530 Subject: [PATCH 245/792] Update people_counting.yaml --- yaml/people_counting.yaml | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/yaml/people_counting.yaml b/yaml/people_counting.yaml index d246f2a6c..c34343987 100644 --- a/yaml/people_counting.yaml +++ b/yaml/people_counting.yaml @@ -7,7 +7,9 @@ info: This microservice returns the number of people detected in that video, the likelihood of overestimation/underestimation, the first appearance and the duration and confidence of each person detected. The size of your image file should **not exceed 10 MB**, and the image dimension should be **least more than 416x416 pixels**. - + x-additionalinfo: |+ + Suggested Use Cases: + - Improve visitor experience and optimize operations in retail, leisure, and other sectors - build services to count visitor traffic in venues, measure detailed movements and interactions, and visualize that data to better understand what is happening in within a certain spaces. For example, one can optimize traffic, staff and marketing strategies to increase conversion rates and profits with actionable data. Businesses can use visitor count as a benchmark to figure out the conversion rate for a certain spot to see the real performance. Efficiently allocating the number of staff according to hourly visitor traffic will also create value in terms of revenue, profit and  efficiency. version: '0.1.0' x-subscribelink: people_counting servers: From 71f5473665d4ce37d0c4e7943e9ef557fa33e5fa Mon Sep 17 00:00:00 2001 From: rameshsentient <51635015+rameshsentient@users.noreply.github.com> Date: Fri, 4 Dec 2020 18:43:23 +0530 Subject: [PATCH 246/792] Update page_profiler_eng_v2.1.yaml --- yaml/page_profiler_eng_v2.1.yaml | 15 +++++++++++---- 1 file changed, 11 insertions(+), 4 deletions(-) diff --git a/yaml/page_profiler_eng_v2.1.yaml b/yaml/page_profiler_eng_v2.1.yaml index 64f99f832..74ea0037d 100644 --- a/yaml/page_profiler_eng_v2.1.yaml +++ b/yaml/page_profiler_eng_v2.1.yaml @@ -8,17 +8,17 @@ The named-entity classes extracted are persons, locations, organisations and miscellaneous.

This microservice automatically extracts structured information from unstructured text data such as chatlogs, emails, news articles, etc. x-subscribelink: page_profiler_eng - version: '2.1.0' + version: '2.1.1' servers: - url: 'https://apis.sentient.io' tags: - - name: "v2.1.0" - description: "Published Date - Oct 30, 2020" + - name: "v2.1.1" + description: "Published Date - Dec 04, 2020" paths: /microservices/nlp/pageprofiler/v2/getpredictions: post: tags: - - v2.1.0 + - v2.1.1 responses: '200': description: success response @@ -207,6 +207,13 @@ versions: type: object properties: + v2.1.1: + type: array + items: + oneOf: + - type: string + example: Published Date - Dec 04, 2020 + description: Patch Update v2.1.0: type: array items: From 93fa179b4c1c5c993ba1984aee0ea9241f6b24ed Mon Sep 17 00:00:00 2001 From: rameshsentient <51635015+rameshsentient@users.noreply.github.com> Date: Fri, 4 Dec 2020 18:45:10 +0530 Subject: [PATCH 247/792] Update web_scraper.yaml --- yaml/web_scraper.yaml | 15 +++++++++++---- 1 file changed, 11 insertions(+), 4 deletions(-) diff --git a/yaml/web_scraper.yaml b/yaml/web_scraper.yaml index dcb5c630f..2f94a754d 100644 --- a/yaml/web_scraper.yaml +++ b/yaml/web_scraper.yaml @@ -56,17 +56,17 @@ info: **returnType is not supported with attribute. The results are returned in JSON format and allow for developers to rapidly retrieve website elements like tables, images, etc. from URL - version: '1.1.0' + version: '1.1.1' servers: - url: 'https://apis.sentient.io' tags: -- name: "v1.1.0" - description: "Published Date - Oct 30, 2020" +- name: "v1.1.1" + description: "Published Date - Dec 04, 2020" paths: /microservices/utility/webscraping/v1/getresults: post: tags: - - v1.1.0 + - v1.1.1 responses: '200': description: success response @@ -276,6 +276,13 @@ components: versions: type: object properties: + v1.1.1: + type: array + items: + oneOf: + - type: string + example: Published Date - Dec 04, 2020 + description: Patch Update v1.1.0: type: array items: From 576cb5a5eaf5ce4739ed7631365d523925a47315 Mon Sep 17 00:00:00 2001 From: rameshsentient <51635015+rameshsentient@users.noreply.github.com> Date: Fri, 4 Dec 2020 18:57:17 +0530 Subject: [PATCH 248/792] Update urls_retrieval.yaml --- yaml/urls_retrieval.yaml | 15 +++++++++++---- 1 file changed, 11 insertions(+), 4 deletions(-) diff --git a/yaml/urls_retrieval.yaml b/yaml/urls_retrieval.yaml index 46e59600f..bb6d21935 100644 --- a/yaml/urls_retrieval.yaml +++ b/yaml/urls_retrieval.yaml @@ -8,18 +8,18 @@ info: x-additionalinfo: |+ Suggested Use Cases: - Use this microservice to update web content or indices of other sites' web content. - version: '0.2.0' + version: '0.2.1' x-subscribelink: urls_retrieval servers: - url: 'https://apis.sentient.io' tags: -- name: "v0.2.0" - description: "Published Date - Oct 30, 2020" +- name: "v0.2.1" + description: "Published Date - Dec 04, 2020" paths: /microservices/utility/crawlurls/v0/getresults: post: tags: - - v0.2.0 + - v0.2.1 responses: '200': description: success response @@ -223,6 +223,13 @@ components: versions: type: object properties: + v0.2.1: + type: array + items: + oneOf: + - type: string + example: Published Date - Dec 04, 2020 + description: Patch Update v0.2.0: type: array items: From affb904013d902e159d62f2b4cc736533e56cfd2 Mon Sep 17 00:00:00 2001 From: Priyadharshini <57977344+priyadharshini-sent@users.noreply.github.com> Date: Mon, 7 Dec 2020 15:42:56 +0530 Subject: [PATCH 249/792] Update asr_with_voice_activity_detection_eng_sg.yaml --- yaml/asr_with_voice_activity_detection_eng_sg.yaml | 3 +++ 1 file changed, 3 insertions(+) diff --git a/yaml/asr_with_voice_activity_detection_eng_sg.yaml b/yaml/asr_with_voice_activity_detection_eng_sg.yaml index ee319ca1d..06932680c 100644 --- a/yaml/asr_with_voice_activity_detection_eng_sg.yaml +++ b/yaml/asr_with_voice_activity_detection_eng_sg.yaml @@ -8,6 +8,9 @@ info: The size of your audio file should be **between 3 KB to 10 MB**. version: '0.1.0' + x-additionalinfo: |+ + Suggested Use Cases: + - Combine this with the Text-to-Speech API to deliver voice-enabled experiences in IoT (Internet of Things) applications, such as implementing voice commands like “turn the volume up". x-subscribelink: asr_with_voice_activity_detection_eng_sg servers: - url: 'https://apis.sentient.io' From 66c0d6733aa944c123f47bf90684630fde8f2835 Mon Sep 17 00:00:00 2001 From: Priyadharshini <57977344+priyadharshini-sent@users.noreply.github.com> Date: Mon, 7 Dec 2020 15:44:03 +0530 Subject: [PATCH 250/792] Update inverse_text_normalisation_eng_v1.0.yaml --- yaml/inverse_text_normalisation_eng_v1.0.yaml | 3 +++ 1 file changed, 3 insertions(+) diff --git a/yaml/inverse_text_normalisation_eng_v1.0.yaml b/yaml/inverse_text_normalisation_eng_v1.0.yaml index 5779a4b2b..28ded0d20 100644 --- a/yaml/inverse_text_normalisation_eng_v1.0.yaml +++ b/yaml/inverse_text_normalisation_eng_v1.0.yaml @@ -8,6 +8,9 @@ info: Do ensure that your text is within **5000 characters**. version: '1.0.0' + x-additionalinfo: |+ + Suggested Use Cases: + - Can be integrated into services or apps that offer digital writing assistance to make writing clear and effective. x-subscribelink: inverse_text_normalisation_eng servers: - url: 'https://apis.sentient.io' From 23a4c3bf8874dcd64ca17016abcc080f53995b43 Mon Sep 17 00:00:00 2001 From: Priyadharshini <57977344+priyadharshini-sent@users.noreply.github.com> Date: Mon, 7 Dec 2020 15:44:49 +0530 Subject: [PATCH 251/792] Update named-entity_recognition_eng_v1.0.yaml --- yaml/named-entity_recognition_eng_v1.0.yaml | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/yaml/named-entity_recognition_eng_v1.0.yaml b/yaml/named-entity_recognition_eng_v1.0.yaml index ec66569ba..9fb6c36cc 100644 --- a/yaml/named-entity_recognition_eng_v1.0.yaml +++ b/yaml/named-entity_recognition_eng_v1.0.yaml @@ -10,6 +10,11 @@ info: Do ensure that your text is within **5000 characters**. version: '1.0.0' + x-additionalinfo: |+ + Suggested Use Cases: + - Extracting structured pre-defined information from text. + - Gain insights from online customers - extract structured information from unstructured text data such as chatlogs, emails, news articles, etc. to find and label fields within a document and then apply sentiment analysis to understand customer opinions to find actionable product and UX insights. + - Entity analysis - identify entities within documents, including receipts, invoices, and contracts; and label them by types such as date, person, contact information, organization, location, events, products, and media. x-subscribelink: named-entity_recognition_eng servers: - url: 'https://apis.sentient.io' From fe157e6912a657f40a6f313631e75d0449162136 Mon Sep 17 00:00:00 2001 From: Priyadharshini <57977344+priyadharshini-sent@users.noreply.github.com> Date: Mon, 7 Dec 2020 15:47:18 +0530 Subject: [PATCH 252/792] Update page_profiler_eng_v2.1.yaml --- yaml/page_profiler_eng_v2.1.yaml | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/yaml/page_profiler_eng_v2.1.yaml b/yaml/page_profiler_eng_v2.1.yaml index 74ea0037d..8efba71b7 100644 --- a/yaml/page_profiler_eng_v2.1.yaml +++ b/yaml/page_profiler_eng_v2.1.yaml @@ -7,7 +7,11 @@ From the web content, the microservice then applies natural language processing to extracts named-entities and returns the output. The named-entity classes extracted are persons, locations, organisations and miscellaneous.

This microservice automatically extracts structured information from unstructured text data such as chatlogs, emails, news articles, etc. - x-subscribelink: page_profiler_eng + x-subscribelink: page_profiler_eng + x-additionalinfo: |+ + Suggested Use Cases: + - Gain insights from online customers - extract structured information from unstructured text data such as chatlogs, emails, news articles, etc. to find and label fields within a document and then apply sentiment analysis to understand customer opinions to find actionable product and UX insights. + - Entity analysis - identify entities within documents, including receipts, invoices, and contracts; and label them by types such as date, person, contact information, organization, location, events, products, and media. version: '2.1.1' servers: - url: 'https://apis.sentient.io' From e75273751b9b587d4b75cda364052ed8732ceb4d Mon Sep 17 00:00:00 2001 From: Priyadharshini <57977344+priyadharshini-sent@users.noreply.github.com> Date: Mon, 7 Dec 2020 15:48:50 +0530 Subject: [PATCH 253/792] Update taxonomy_matcher_eng_v1.0.yaml --- yaml/taxonomy_matcher_eng_v1.0.yaml | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/yaml/taxonomy_matcher_eng_v1.0.yaml b/yaml/taxonomy_matcher_eng_v1.0.yaml index 156b7a77b..e689178c7 100644 --- a/yaml/taxonomy_matcher_eng_v1.0.yaml +++ b/yaml/taxonomy_matcher_eng_v1.0.yaml @@ -10,6 +10,10 @@ info: Do ensure that your text is within **5000 characters**. version: '1.0.0' + x-additionalinfo: |+ + Suggested Use Cases: + - Categorise a particular word to pre-built taxonomy tree. + - This microservice can be used to manage taxonomies, such as a hierarchy of product categories used for an eCommerce site. The information in a taxonomy is meta-information about the categories used to classify a set of things. For an eCommerce site, the set of things are items in the product catalog. Users can use this meta-information to enhance search. x-subscribelink: taxonomy_matcher_eng servers: - url: 'https://apis.sentient.io' From 6625de189fdd8d114994e027b05ba0b7fd737bab Mon Sep 17 00:00:00 2001 From: Priyadharshini <57977344+priyadharshini-sent@users.noreply.github.com> Date: Mon, 7 Dec 2020 15:49:27 +0530 Subject: [PATCH 254/792] Update word_sense_disambiguation_eng_v1.0.yaml --- yaml/word_sense_disambiguation_eng_v1.0.yaml | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/yaml/word_sense_disambiguation_eng_v1.0.yaml b/yaml/word_sense_disambiguation_eng_v1.0.yaml index 9da4d77fe..9a803cb7a 100644 --- a/yaml/word_sense_disambiguation_eng_v1.0.yaml +++ b/yaml/word_sense_disambiguation_eng_v1.0.yaml @@ -8,6 +8,10 @@ info: Do ensure that your text is **within 5000 characters**. version: '1.0.0' + x-additionalinfo: |+ + Suggested Use Cases: + - Information Retrieval - this microservice can be used to build a system that assists users in finding the information they required but it does not explicitly return the answers of the questions. + - Text Mining and Information Extraction - this microservice can be used to do accurate analysis of text. For example it can help to create an intelligent gathering system to do flagging of the correct words e.g. medical intelligent system might need flagging of “red balloon” rather than “led balloon”. x-subscribelink: word_sense_disambiguation_eng servers: - url: 'https://apis.sentient.io' From 908fb9638d1eb6cb6bc086cee7429779730f62f4 Mon Sep 17 00:00:00 2001 From: Priyadharshini <57977344+priyadharshini-sent@users.noreply.github.com> Date: Mon, 7 Dec 2020 15:50:13 +0530 Subject: [PATCH 255/792] Update named-entity_recognition_jp_v1.0.yaml --- yaml/named-entity_recognition_jp_v1.0.yaml | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/yaml/named-entity_recognition_jp_v1.0.yaml b/yaml/named-entity_recognition_jp_v1.0.yaml index 41b1bdecb..0eaecdc5c 100644 --- a/yaml/named-entity_recognition_jp_v1.0.yaml +++ b/yaml/named-entity_recognition_jp_v1.0.yaml @@ -10,6 +10,11 @@ info: Do ensure that your text is within **5000 characters**. version: '1.0.0' + x-additionalinfo: |+ + Suggested Use Cases: + - Extract structured pre-defined information from text. + - Insights from online customers - extract structured information from unstructured text data such as chatlogs, emails, news articles, etc. to find and label fields within a document and then apply sentiment analysis to understand customer opinions to find actionable product and UX insights. + - Entity analysis - identify entities within documents, including receipts, invoices, and contracts; and label them by types such as date, person, contact information, organization, location, events, products, and media. x-subscribelink: named-entity_recognition_jp servers: - url: 'https://apis.sentient.io' From 42003b124d709bae103d7f6cdfe24ea7af9b65c8 Mon Sep 17 00:00:00 2001 From: Priyadharshini <57977344+priyadharshini-sent@users.noreply.github.com> Date: Mon, 7 Dec 2020 15:50:50 +0530 Subject: [PATCH 256/792] Update named-entity_recognition_thai_v1.0.yaml --- yaml/named-entity_recognition_thai_v1.0.yaml | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/yaml/named-entity_recognition_thai_v1.0.yaml b/yaml/named-entity_recognition_thai_v1.0.yaml index 1ff2cdd4a..ed37b958a 100644 --- a/yaml/named-entity_recognition_thai_v1.0.yaml +++ b/yaml/named-entity_recognition_thai_v1.0.yaml @@ -10,6 +10,13 @@ info: Do ensure that your text is **within 5000 characters**. version: '1.0.0' + x-additionalinfo: |+ + Suggested Use Cases: + - Extract structured pre-defined information from text. + + - Insights from online customers - extract structured information from unstructured text data such as chatlogs, emails, news articles, etc. to find and label fields within a document and then apply sentiment analysis to understand customer opinions to find actionable product and UX insights. + + - Entity analysis - identify entities within documents, including receipts, invoices, and contracts; and label them by types such as date, person, contact information, organization, location, events, products, and media. x-subscribelink: named-entity_recognition_thai servers: - url: 'https://apis.sentient.io' From 5f99325a7de21d3fa57d28a5b98b5a59d87c5006 Mon Sep 17 00:00:00 2001 From: Priyadharshini <57977344+priyadharshini-sent@users.noreply.github.com> Date: Mon, 7 Dec 2020 15:51:37 +0530 Subject: [PATCH 257/792] Update script_alignment_v1.0.yaml --- yaml/script_alignment_v1.0.yaml | 3 +++ 1 file changed, 3 insertions(+) diff --git a/yaml/script_alignment_v1.0.yaml b/yaml/script_alignment_v1.0.yaml index a6b4b1603..c13dce0cc 100644 --- a/yaml/script_alignment_v1.0.yaml +++ b/yaml/script_alignment_v1.0.yaml @@ -8,6 +8,9 @@ info: Do ensure that your text is within **5000 characters**. version: '1.0.0' + x-additionalinfo: |+ + Suggested Use Cases: + - Can be used to create time-coded high-quality script for services like radio broadcasting, television broadcasting and digital content creation. x-subscribelink: script_alignment servers: - url: 'https://apis.sentient.io' From 893a95eeafc9a535bf125e93290b3d648163a6b5 Mon Sep 17 00:00:00 2001 From: Priyadharshini <57977344+priyadharshini-sent@users.noreply.github.com> Date: Mon, 7 Dec 2020 16:14:15 +0530 Subject: [PATCH 258/792] Update automatic_speech_recognition_eng_sg.yaml --- yaml/automatic_speech_recognition_eng_sg.yaml | 3 +++ 1 file changed, 3 insertions(+) diff --git a/yaml/automatic_speech_recognition_eng_sg.yaml b/yaml/automatic_speech_recognition_eng_sg.yaml index 511a1bcdf..46c83f9df 100644 --- a/yaml/automatic_speech_recognition_eng_sg.yaml +++ b/yaml/automatic_speech_recognition_eng_sg.yaml @@ -8,6 +8,9 @@ info: The size of your audio file should be **between 3 KB to 10 MB**. version: '0.1.0' + x-additionalinfo: |+ + Suggested Use Cases: + - Combine this with the Text-to-Speech API to deliver voice-enabled experiences in IoT (Internet of Things) applications, such as implementing voice commands. x-subscribelink: automatic_speech_recognition_eng_sg servers: - url: 'https://apis.sentient.io' From efdc753d14a6c1fe7b50103e6769c2821c76dab6 Mon Sep 17 00:00:00 2001 From: Priyadharshini <57977344+priyadharshini-sent@users.noreply.github.com> Date: Tue, 8 Dec 2020 16:26:29 +0530 Subject: [PATCH 259/792] Update commercial_directories_hdb_sg.yaml --- yaml/commercial_directories_hdb_sg.yaml | 2 -- 1 file changed, 2 deletions(-) diff --git a/yaml/commercial_directories_hdb_sg.yaml b/yaml/commercial_directories_hdb_sg.yaml index 094f6475f..e4b59c2e8 100644 --- a/yaml/commercial_directories_hdb_sg.yaml +++ b/yaml/commercial_directories_hdb_sg.yaml @@ -6,8 +6,6 @@ info: This Data microservice retrieves the list of all retail shops within Singapore HDBs and allows you to search for a shop by its name, address, building name, postal code, latitude and longitude coordinates type of business. The resultant dataset offers useful information like the shop operating hours and contact number. Updated weekly. The HDB POTH programme makes selected public and non-public datasets available to developers and companies to improve their service offerings to benefit the lives of Singapore citizens. Sentient.io is proud to partner with HDB to manage and facilitate the sharing of data for the POTH Programme. - - Suggested Use Cases: Resident community mobile app with e-commerce collection and estate directory features. **Note:** As this microservice uses the GET method, developers using this microservice must remember to have their app encode all the input values to be URL friendly (i.e. all spaces and special characters must be replaced). Here’s a reference on [URL encoding](https://www.w3schools.com/tags/ref_urlencode.ASP). From 2fa53a06c3cd1892f6b35d80e42515d35fdf3630 Mon Sep 17 00:00:00 2001 From: Priyadharshini <57977344+priyadharshini-sent@users.noreply.github.com> Date: Tue, 8 Dec 2020 16:27:16 +0530 Subject: [PATCH 260/792] Update residential_sales_and_rental_hdb_sg.yaml --- yaml/residential_sales_and_rental_hdb_sg.yaml | 2 -- 1 file changed, 2 deletions(-) diff --git a/yaml/residential_sales_and_rental_hdb_sg.yaml b/yaml/residential_sales_and_rental_hdb_sg.yaml index 7c10d033e..f0b27a902 100644 --- a/yaml/residential_sales_and_rental_hdb_sg.yaml +++ b/yaml/residential_sales_and_rental_hdb_sg.yaml @@ -6,8 +6,6 @@ info: This Data microservice retreives comprehensive details of each HDB block in Singapore including the number of units for each type of flats and whether they were sold or leased. Queries based on keywords and proximity to particular locations can be performed. Updated weekly. The HDB POTH programme makes selected public and non-public datasets available to developers and companies to improve their service offerings to benefit the lives of Singapore citizens. Sentient.io is proud to partner with HDB to manage and facilitate the sharing of data for the POTH Programme. - - Suggested Use Cases: Community app that benefits from geo-targeting family types and income groups by areas for non-profit charity/social organizations, real estate developers, property agencies, retail shops, marketing for educational sector, government agencies. **Note:** As this microservice uses the GET method, developers using this microservice must remember to have their app encode all the input values to be URL friendly (i.e. all spaces and special characters must be replaced). Here’s a reference on [URL encoding](https://www.w3schools.com/tags/ref_urlencode.ASP). From 75df006874fd52930084c59a2b22d49693a7ffc0 Mon Sep 17 00:00:00 2001 From: Priyadharshini <57977344+priyadharshini-sent@users.noreply.github.com> Date: Tue, 8 Dec 2020 16:27:50 +0530 Subject: [PATCH 261/792] Update carpark_hdb_sg.yaml --- yaml/carpark_hdb_sg.yaml | 2 -- 1 file changed, 2 deletions(-) diff --git a/yaml/carpark_hdb_sg.yaml b/yaml/carpark_hdb_sg.yaml index c44c2e220..a4f6f666b 100644 --- a/yaml/carpark_hdb_sg.yaml +++ b/yaml/carpark_hdb_sg.yaml @@ -7,8 +7,6 @@ info: The HDB POTH programme makes selected public and non-public datasets available to developers and companies to improve their service offerings to benefit the lives of Singapore citizens. Sentient.io is proud to partner with HDB to manage and facilitate the sharing of data for the POTH Programme. - Suggested Use Cases: Geo-targeting app with map feature, property development planning resource, or planning for vehicle-sharing app. - **Note:** As this microservice uses the GET method, developers using this microservice must remember to have their app encode all the input values to be URL friendly (i.e. all spaces and special characters must be replaced). Here’s a reference on [URL encoding](https://www.w3schools.com/tags/ref_urlencode.ASP). x-additionalinfo : |+ From 3169693595e85b3e29a979045d1c267a15f99d87 Mon Sep 17 00:00:00 2001 From: Priyadharshini <57977344+priyadharshini-sent@users.noreply.github.com> Date: Tue, 8 Dec 2020 16:35:14 +0530 Subject: [PATCH 262/792] Update season_parking_availability_hdb_sg.yaml --- yaml/season_parking_availability_hdb_sg.yaml | 19 +------------------ 1 file changed, 1 insertion(+), 18 deletions(-) diff --git a/yaml/season_parking_availability_hdb_sg.yaml b/yaml/season_parking_availability_hdb_sg.yaml index 5aa8e92cb..729130552 100644 --- a/yaml/season_parking_availability_hdb_sg.yaml +++ b/yaml/season_parking_availability_hdb_sg.yaml @@ -4,23 +4,18 @@ info: x-subscribelink: season_parking_availability_hdb_sg description: |+ This Data microservice returns information on season car park availability within Housing Development Board of Singapore (HDB) estates and includes the location address, postal code, branch office, vehicle type and parking lot availability for different types of vehicle by carpark location. - The HDB POTH programme makes selected public and non-public datasets available to developers and companies to improve their service offerings to benefit the lives of Singapore citizens. Sentient.io is proud to partner with HDB to manage and facilitate the sharing of data for the POTH Programme. - - **Note:** As this microservice uses the GET method, developers using this microservice must remember to have their app encode all the input values to be URL friendly (i.e. all spaces and special characters must be replaced). Here’s a reference on [URL encoding](https://www.w3schools.com/tags/ref_urlencode.ASP). + **Note:** As this microservice uses the GET method, developers using this microservice must remember to have their app encode all the input values to be URL friendly (i.e. all spaces and special characters must be replaced). Here’s a reference on [URL encoding](https://www.w3schools.com/tags/ref_urlencode.ASP). x-additionalinfo : |+ Suggested Use Cases: - Real estate services - can be used as a background check solution to extract information related to season car park availability in an area for people with certain preferences when buying or renting a HDB home. - - Can also be integrated into apps related to maps or parking for more detailed carpark information within Singapore HDB estates **Refining queries in the filterdata field using filter types and match types** - The filterdata fields use elasticsearch’s syntax (specifically filter types and match types) to help further refine search results and provide greater flexibility in structuring more sophisticated queries. **Filter Types:** - A filter type is a logic operator to which the search results must fulfill certain logical conditions to be returned. The supported match types are: * **must** - All of the stated conditions must match. Equivalent to an AND operator. @@ -45,23 +40,14 @@ info: A match type is a match operator nested within a filter type that fine-tunes the matching condition of the text search. The supported match types are: * **match** - Search within a full text field for a single word - > {"match":{"street":"serangoon"}} - * **match_phrase** - Search within a full text field - > {"match_phrase":{"street":"bishan street 24"}} - * **match_phrase_prefix** - Search within a full text field with prefix - > {"match_phrase_prefix":{"street":"bishan street 24"}} - * **term** - Returns results that contain an exact term in a provided field - > {"term":{"car_park_group":"G15"}} - * **terms** - Returns results that contain one or more exact terms in a provided field - > {"terms":{"car_park_group":["G15","G39"]}} * **range** - Returns results that contain terms within a stipulated range @@ -73,7 +59,6 @@ info: * **exists** - Returns results that contain any indexed value for a field > {"exists":{ "field": "postalcode"}} - For a more detailed guide to match types, [refer to this](https://www.elastic.co/guide/en/elasticsearch/reference/7.9/term-level-queries.html). **Forming sophisticated queries using combinations of filter types (in JSON)** @@ -85,7 +70,6 @@ info: > "should":[{"match":{"car_park_group":"G18"}}], > "must_not":[{"match":{"postalcode":"550409"}}] > } - **Sample Queries Based on Use Cases** 1. **Search for the parking lot availability for commercial vehicle at the carpark of 503 Serangoon North Avenue 4.** @@ -454,4 +438,3 @@ components: in: header x-amazon-apigateway-authtype: custom description: Authentication is done using the x-api-key in the request header. - From 24f42a0bd307e75d3b967b1369e84f6b9bdd2864 Mon Sep 17 00:00:00 2001 From: rameshsentient <51635015+rameshsentient@users.noreply.github.com> Date: Wed, 9 Dec 2020 14:33:39 +0530 Subject: [PATCH 263/792] Update page_profiler_jp.yaml --- yaml/page_profiler_jp.yaml | 17 ++++++++++++----- 1 file changed, 12 insertions(+), 5 deletions(-) diff --git a/yaml/page_profiler_jp.yaml b/yaml/page_profiler_jp.yaml index f757141aa..3b20a30b2 100644 --- a/yaml/page_profiler_jp.yaml +++ b/yaml/page_profiler_jp.yaml @@ -12,18 +12,18 @@ - Insights from online customers - extract structured information from unstructured text data such as chatlogs, emails, news articles, etc. to find and label fields within a document and then apply sentiment analysis to understand customer opinions to find actionable product and UX insights. - Entity analysis - identify entities within documents, including receipts, invoices, and contracts; and label them by types such as date, person, contact information, organization, location, events, products, and media. - version: '1.0.0' + version: '1.1.0' x-subscribelink: page_profiler_jp servers: - url: 'https://apis.sentient.io' tags: - - name: "v1.0.0" - description: "Published Date - Oct 30, 2020" + - name: "v1.1.0" + description: "Published Date - Dec 07, 2020" paths: /microservices/nlp/pageprofilerjp/v1/getpredictions: post: tags: - - v1.0.0 + - v1.1.0 responses: '200': description: success response @@ -234,7 +234,14 @@ example: Failure versions: type: object - properties: + properties: + v1.1.0: + type: array + items: + oneOf: + - type: string + example: Published Date - Dec 07, 2020 + description: Patch Update v1.0.0: type: array items: From 2ac4a4b6ffd66af021e8483c28020278797947e2 Mon Sep 17 00:00:00 2001 From: rameshsentient <51635015+rameshsentient@users.noreply.github.com> Date: Wed, 9 Dec 2020 14:36:53 +0530 Subject: [PATCH 264/792] Update page_profiler_thai.yaml --- yaml/page_profiler_thai.yaml | 15 +++++++++++---- 1 file changed, 11 insertions(+), 4 deletions(-) diff --git a/yaml/page_profiler_thai.yaml b/yaml/page_profiler_thai.yaml index e8749ba30..eee8fec2d 100644 --- a/yaml/page_profiler_thai.yaml +++ b/yaml/page_profiler_thai.yaml @@ -12,18 +12,18 @@ - Insights from online customers - extract structured information from unstructured text data such as chatlogs, emails, news articles, etc. to find and label fields within a document and then apply sentiment analysis to understand customer opinions to find actionable product and UX insights. - Entity analysis - identify entities within documents, including receipts, invoices, and contracts; and label them by types such as date, person, contact information, organization, location, events, products, and media. - version: '1.0.0' + version: '1.1.0' x-subscribelink: page_profiler_thai servers: - url: 'https://apis.sentient.io' tags: - - name: "v1.0.0" - description: "Published Date - Oct 30, 2020" + - name: "v1.1.0" + description: "Published Date - Dec 07, 2020" paths: /microservices/nlp/pageprofilerthai/v1/getpredictions: post: tags: - - v1.0.0 + - v1.1.0 responses: '200': description: success response @@ -247,6 +247,13 @@ versions: type: object properties: + v1.1.0: + type: array + items: + oneOf: + - type: string + example: Published Date - Dec 07, 2020 + description: Patch Update v1.0.0: type: array items: From 22d9ca36b6617fa3f8d0cf1c0c409e5ec11e5ffd Mon Sep 17 00:00:00 2001 From: rameshsentient <51635015+rameshsentient@users.noreply.github.com> Date: Wed, 9 Dec 2020 14:42:53 +0530 Subject: [PATCH 265/792] Update voice_activity_detection_eng_v1.0.yaml --- yaml/voice_activity_detection_eng_v1.0.yaml | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/yaml/voice_activity_detection_eng_v1.0.yaml b/yaml/voice_activity_detection_eng_v1.0.yaml index 87b795c39..7fca01284 100644 --- a/yaml/voice_activity_detection_eng_v1.0.yaml +++ b/yaml/voice_activity_detection_eng_v1.0.yaml @@ -8,7 +8,7 @@ info: version: '1.0.0' x-subscribelink: voice_activity_detection_eng servers: - - url: 'https://dev-apis.sentient.io' + - url: 'https://apis.sentient.io' tags: - name: "v1.0.0" description: "Published Date - Nov 30, 2020" @@ -26,7 +26,7 @@ paths: $ref: '#/components/schemas/success' example: results: - results: [{end: 23.72,seqNum: 1,start: 0.64}] + output: [{end: 23.72,seqNum: 1,start: 0.64}] message: Successfully Processed status: Success @@ -102,7 +102,7 @@ components: description: The result of the API call. example: { "" } properties: - results: + output: type: array example: [{end: 23.72,seqNum: 1,start: 0.64}] description: List of details of start and end time of utterances in the input audio From 3e26f49be88eae321be0bc7db95ed203739a105b Mon Sep 17 00:00:00 2001 From: rameshsentient <51635015+rameshsentient@users.noreply.github.com> Date: Wed, 9 Dec 2020 14:46:21 +0530 Subject: [PATCH 266/792] Update index.yaml --- yaml/index.yaml | 1 + 1 file changed, 1 insertion(+) diff --git a/yaml/index.yaml b/yaml/index.yaml index 5e6b47d83..4f04f532e 100644 --- a/yaml/index.yaml +++ b/yaml/index.yaml @@ -30,6 +30,7 @@ Voice: Voice Activity Detection ENG: title: voice_activity_detection_eng versions: + v1.0: "https://raw.githubusercontent.com/sentient-io/microservice-docs/dev/yaml/voice_activity_detection_eng_v1.0.yaml" v0.1: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/voice_activity_detection_eng.yaml" NLP: Inverse Text Normalisation ENG: From d1d8b7dba61c5136969f8204ecff9f9c16848b85 Mon Sep 17 00:00:00 2001 From: rameshsentient <51635015+rameshsentient@users.noreply.github.com> Date: Wed, 9 Dec 2020 14:52:35 +0530 Subject: [PATCH 267/792] Update automatic_speech_recognition_eng_sg_v1.0.yaml --- yaml/automatic_speech_recognition_eng_sg_v1.0.yaml | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/yaml/automatic_speech_recognition_eng_sg_v1.0.yaml b/yaml/automatic_speech_recognition_eng_sg_v1.0.yaml index 81a10b99c..0a1fdedb1 100644 --- a/yaml/automatic_speech_recognition_eng_sg_v1.0.yaml +++ b/yaml/automatic_speech_recognition_eng_sg_v1.0.yaml @@ -10,7 +10,7 @@ info: version: '1.0.0' x-subscribelink: automatic_speech_recognition_eng_sg servers: - - url: 'https://dev-apis.sentient.io' + - url: 'https://apis.sentient.io' tags: - name: "v1.0.0" description: "Published Date - Nov 30, 2020" @@ -28,7 +28,7 @@ paths: $ref: '#/components/schemas/success' example: results: - results: + output: - seqNum: 1 start: 0.64 end: 23.72 @@ -107,7 +107,7 @@ components: description: The result of the API call. example: { "" } properties: - results: + output: type: array example: [{ "" }] description: List of Json Objects From 3bc9507501dc114952fc9f181a8e6f31e3ac37b6 Mon Sep 17 00:00:00 2001 From: rameshsentient <51635015+rameshsentient@users.noreply.github.com> Date: Wed, 9 Dec 2020 14:53:32 +0530 Subject: [PATCH 268/792] Update index.yaml --- yaml/index.yaml | 1 + 1 file changed, 1 insertion(+) diff --git a/yaml/index.yaml b/yaml/index.yaml index 4f04f532e..45a023bce 100644 --- a/yaml/index.yaml +++ b/yaml/index.yaml @@ -2,6 +2,7 @@ Voice: Automatic Speech Recognition ENG (SG): title: automatic_speech_recognition_eng_sg versions: + v1.0: "https://raw.githubusercontent.com/sentient-io/microservice-docs/dev/yaml/automatic_speech_recognition_eng_sg_v1.0.yaml" v0.1: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/automatic_speech_recognition_eng_sg.yaml" Automatic Speech Recognition CHI (SG): title: automatic_speech_recognition_chi_sg From 9b79f1b258e74ada86df5523d57230a9fce7f46e Mon Sep 17 00:00:00 2001 From: rameshsentient <51635015+rameshsentient@users.noreply.github.com> Date: Wed, 9 Dec 2020 14:58:37 +0530 Subject: [PATCH 269/792] Update asr_with_voice_activity_detection_eng_sg_v1.0.yaml --- yaml/asr_with_voice_activity_detection_eng_sg_v1.0.yaml | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) diff --git a/yaml/asr_with_voice_activity_detection_eng_sg_v1.0.yaml b/yaml/asr_with_voice_activity_detection_eng_sg_v1.0.yaml index a31a86d35..26420f88c 100644 --- a/yaml/asr_with_voice_activity_detection_eng_sg_v1.0.yaml +++ b/yaml/asr_with_voice_activity_detection_eng_sg_v1.0.yaml @@ -3,14 +3,13 @@ info: title: ASR with Voice Activity Detection ENG (SG) description: |+ This Voice microservice combines Voice Activity Detection feature and Automatic Speech Recognition capability. It detects speech in an audio file (.wav format) and transcribes English speech content from the audio stream into text. The transcript text is timestamped for each utterance. An utterance is a continuous piece of speech beginning and ending with a clear pause. - This Voice microservice performs well on Singapore-accented English speech. For best performance, select the model which best matches the use-case: news_parliament, nsc_parliament, nscfull_8k. The size of your audio file should be **between 3 KB to 10 MB**. version: '1.0.0' x-subscribelink: asr_with_voice_activity_detection_eng_sg servers: - - url: 'https://dev-apis.sentient.io' + - url: 'https://apis.sentient.io' tags: - name: "v1.0.0" description: "Published Date - Nov 30, 2020" @@ -28,7 +27,7 @@ paths: $ref: '#/components/schemas/success' example: results: - results: + output: - seqNum: 1 start: 0.64 end: 23.72 @@ -107,7 +106,7 @@ components: description: The result of the API call. example: { "" } properties: - results: + output: type: array example: [{end: 23.72,seqNum: 1,start: 0.64,text: HELLO WORLD }] description: List of details of start and end time of utterances in the input audio From 13ec73a38988a04934f6cd92c44730c7739482a3 Mon Sep 17 00:00:00 2001 From: rameshsentient <51635015+rameshsentient@users.noreply.github.com> Date: Wed, 9 Dec 2020 14:59:49 +0530 Subject: [PATCH 270/792] Update index.yaml --- yaml/index.yaml | 1 + 1 file changed, 1 insertion(+) diff --git a/yaml/index.yaml b/yaml/index.yaml index 45a023bce..3c88505f4 100644 --- a/yaml/index.yaml +++ b/yaml/index.yaml @@ -27,6 +27,7 @@ Voice: ASR with Voice Activity Detection ENG (SG): title: asr_with_voice_activity_detection_eng_sg versions: + v1.0: "https://raw.githubusercontent.com/sentient-io/microservice-docs/dev/yaml/asr_with_voice_activity_detection_eng_sg_v1.0.yaml" v0.1: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/asr_with_voice_activity_detection_eng_sg.yaml" Voice Activity Detection ENG: title: voice_activity_detection_eng From 17d3223f72fefc58e2bfdf2c3714c33f8cc40879 Mon Sep 17 00:00:00 2001 From: rameshsentient <51635015+rameshsentient@users.noreply.github.com> Date: Wed, 9 Dec 2020 15:10:57 +0530 Subject: [PATCH 271/792] Update face_recognition_politicians_sg_v1.0.yaml --- yaml/face_recognition_politicians_sg_v1.0.yaml | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/yaml/face_recognition_politicians_sg_v1.0.yaml b/yaml/face_recognition_politicians_sg_v1.0.yaml index 2eda9f146..e3e44409d 100644 --- a/yaml/face_recognition_politicians_sg_v1.0.yaml +++ b/yaml/face_recognition_politicians_sg_v1.0.yaml @@ -11,7 +11,7 @@ info: version: '1.0.0' x-subscribelink: face_recognition_politicians_sg servers: - - url: 'https://dev-apis.sentient.io' + - url: 'https://apis.sentient.io' tags: - name: "v1.0.0" description: "Published Date - Nov 30, 2020" @@ -29,7 +29,7 @@ paths: $ref: '#/components/schemas/success' example: results: - results: {conf: 0.6588699206768599,identity: "Lee Hsien Loong",location: [67,339,196,210]} + output: {conf: 0.6588699206768599,identity: "Lee Hsien Loong",location: [67,339,196,210]} message: Successfully Processed status: Success '401': @@ -104,7 +104,7 @@ components: description: The result of the API call. example: { "" } properties: - results: + output: type: array example: {conf: 0.6588699206768599,identity: "Lee Hsien Loong",location: [67,339,196,210]} description: Details of the face recognised from the image From 8519344395d542883ac997d42f63852816087066 Mon Sep 17 00:00:00 2001 From: rameshsentient <51635015+rameshsentient@users.noreply.github.com> Date: Wed, 9 Dec 2020 15:14:08 +0530 Subject: [PATCH 272/792] Update index.yaml --- yaml/index.yaml | 1 + 1 file changed, 1 insertion(+) diff --git a/yaml/index.yaml b/yaml/index.yaml index 3c88505f4..b62d51d13 100644 --- a/yaml/index.yaml +++ b/yaml/index.yaml @@ -94,6 +94,7 @@ Computer Vision: Face Recognition Politicians (SG): title: face_recognition_politicians_sg versions: + v1.0: "https://raw.githubusercontent.com/sentient-io/microservice-docs/dev/yaml/face_recognition_politicians_sg_v1.0.yaml" v0.1: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/face_recognition_politicians_sg.yaml" People Counting: title: people_counting From 9bca1a97ef560abd17360211c4d4a06a61718140 Mon Sep 17 00:00:00 2001 From: rameshsentient <51635015+rameshsentient@users.noreply.github.com> Date: Wed, 9 Dec 2020 15:22:12 +0530 Subject: [PATCH 273/792] Update index.yaml --- yaml/index.yaml | 10 +++++++--- 1 file changed, 7 insertions(+), 3 deletions(-) diff --git a/yaml/index.yaml b/yaml/index.yaml index b62d51d13..1eb2e0f1d 100644 --- a/yaml/index.yaml +++ b/yaml/index.yaml @@ -27,12 +27,12 @@ Voice: ASR with Voice Activity Detection ENG (SG): title: asr_with_voice_activity_detection_eng_sg versions: - v1.0: "https://raw.githubusercontent.com/sentient-io/microservice-docs/dev/yaml/asr_with_voice_activity_detection_eng_sg_v1.0.yaml" + v1.0: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/asr_with_voice_activity_detection_eng_sg_v1.0.yaml" v0.1: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/asr_with_voice_activity_detection_eng_sg.yaml" Voice Activity Detection ENG: title: voice_activity_detection_eng versions: - v1.0: "https://raw.githubusercontent.com/sentient-io/microservice-docs/dev/yaml/voice_activity_detection_eng_v1.0.yaml" + v1.0: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/voice_activity_detection_eng_v1.0.yaml" v0.1: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/voice_activity_detection_eng.yaml" NLP: Inverse Text Normalisation ENG: @@ -94,7 +94,7 @@ Computer Vision: Face Recognition Politicians (SG): title: face_recognition_politicians_sg versions: - v1.0: "https://raw.githubusercontent.com/sentient-io/microservice-docs/dev/yaml/face_recognition_politicians_sg_v1.0.yaml" + v1.0: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/face_recognition_politicians_sg_v1.0.yaml" v0.1: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/face_recognition_politicians_sg.yaml" People Counting: title: people_counting @@ -108,6 +108,10 @@ Computer Vision: title: landmark_detection_jp versions: v0.1: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/landmark_detection_jp.yaml" + Demographic Classification: + title: demographic_classification + versions: + v0.1: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/Demographics_classification.yaml" Utility: Youtube Video Downloader: title: youtube_video_downloader From 35a56f821f67897112c92a52435bc5eb99ee509e Mon Sep 17 00:00:00 2001 From: rameshsentient <51635015+rameshsentient@users.noreply.github.com> Date: Wed, 9 Dec 2020 15:28:55 +0530 Subject: [PATCH 274/792] Update Demographics_classification.yaml --- yaml/Demographics_classification.yaml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/yaml/Demographics_classification.yaml b/yaml/Demographics_classification.yaml index 6c1f1c8d5..e455b6d9e 100644 --- a/yaml/Demographics_classification.yaml +++ b/yaml/Demographics_classification.yaml @@ -9,7 +9,7 @@ servers: - url: 'https://dev-apis.sentient.io' tags: - name: "v0.1.0" - description: "Published Date - November 30, 2020" + description: "Published Date - Nov 30, 2020" paths: /microservices/cv/democlass/v0/getpredictions: post: @@ -262,7 +262,7 @@ components: items: oneOf: - type: string - example: Published Date - November 30, 2020 + example: Published Date - Nov 30, 2020 description: Initial version release input: type: object From 778b19538314a43bb77306f28227283871971895 Mon Sep 17 00:00:00 2001 From: rameshsentient <51635015+rameshsentient@users.noreply.github.com> Date: Wed, 9 Dec 2020 15:43:42 +0530 Subject: [PATCH 275/792] Update Demographics_classification.yaml --- yaml/Demographics_classification.yaml | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/yaml/Demographics_classification.yaml b/yaml/Demographics_classification.yaml index e455b6d9e..b83372dc2 100644 --- a/yaml/Demographics_classification.yaml +++ b/yaml/Demographics_classification.yaml @@ -6,10 +6,10 @@ info: version: v0.1.0 x-subscribelink: TO FILL MANUALLY servers: - - url: 'https://dev-apis.sentient.io' + - url: 'https://apis.sentient.io' tags: - name: "v0.1.0" - description: "Published Date - Nov 30, 2020" + description: "Published Date - Dec 09, 2020" paths: /microservices/cv/democlass/v0/getpredictions: post: @@ -262,7 +262,7 @@ components: items: oneOf: - type: string - example: Published Date - Nov 30, 2020 + example: Published Date - Dec 09, 2020 description: Initial version release input: type: object From 1ee347d97465c42a5517a61b8d4744004eb316ff Mon Sep 17 00:00:00 2001 From: rameshsentient <51635015+rameshsentient@users.noreply.github.com> Date: Wed, 9 Dec 2020 15:45:04 +0530 Subject: [PATCH 276/792] Update page_profiler_jp.yaml --- yaml/page_profiler_jp.yaml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/yaml/page_profiler_jp.yaml b/yaml/page_profiler_jp.yaml index 3b20a30b2..bbcb12dd0 100644 --- a/yaml/page_profiler_jp.yaml +++ b/yaml/page_profiler_jp.yaml @@ -18,7 +18,7 @@ - url: 'https://apis.sentient.io' tags: - name: "v1.1.0" - description: "Published Date - Dec 07, 2020" + description: "Published Date - Dec 09, 2020" paths: /microservices/nlp/pageprofilerjp/v1/getpredictions: post: @@ -240,7 +240,7 @@ items: oneOf: - type: string - example: Published Date - Dec 07, 2020 + example: Published Date - Dec 09, 2020 description: Patch Update v1.0.0: type: array From 8c69f606764d7c62cc06cfbafe4ce1e45f359988 Mon Sep 17 00:00:00 2001 From: rameshsentient <51635015+rameshsentient@users.noreply.github.com> Date: Wed, 9 Dec 2020 15:45:32 +0530 Subject: [PATCH 277/792] Update page_profiler_thai.yaml --- yaml/page_profiler_thai.yaml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/yaml/page_profiler_thai.yaml b/yaml/page_profiler_thai.yaml index eee8fec2d..72bd6b657 100644 --- a/yaml/page_profiler_thai.yaml +++ b/yaml/page_profiler_thai.yaml @@ -18,7 +18,7 @@ - url: 'https://apis.sentient.io' tags: - name: "v1.1.0" - description: "Published Date - Dec 07, 2020" + description: "Published Date - Dec 09, 2020" paths: /microservices/nlp/pageprofilerthai/v1/getpredictions: post: @@ -252,7 +252,7 @@ items: oneOf: - type: string - example: Published Date - Dec 07, 2020 + example: Published Date - Dec 09, 2020 description: Patch Update v1.0.0: type: array From 91a9e4a7f8e6d802ae7a87f6205758033ddfc6af Mon Sep 17 00:00:00 2001 From: rameshsentient <51635015+rameshsentient@users.noreply.github.com> Date: Wed, 9 Dec 2020 15:46:14 +0530 Subject: [PATCH 278/792] Update face_recognition_politicians_sg_v1.0.yaml --- yaml/face_recognition_politicians_sg_v1.0.yaml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/yaml/face_recognition_politicians_sg_v1.0.yaml b/yaml/face_recognition_politicians_sg_v1.0.yaml index e3e44409d..921ba32ef 100644 --- a/yaml/face_recognition_politicians_sg_v1.0.yaml +++ b/yaml/face_recognition_politicians_sg_v1.0.yaml @@ -14,7 +14,7 @@ servers: - url: 'https://apis.sentient.io' tags: - name: "v1.0.0" - description: "Published Date - Nov 30, 2020" + description: "Published Date - Dec 09, 2020" paths: /microservices/cv/facerecognition/v1/getpredictions: post: @@ -236,7 +236,7 @@ components: items: oneOf: - type: string - example: Published Date - Nov 30,2020 + example: Published Date - Dec 09, 2020 description: Standardizing Output JSON and model update v0.1.0: From 1fc2254a4db2bd73a0817bc5dbedab0b1048943d Mon Sep 17 00:00:00 2001 From: rameshsentient <51635015+rameshsentient@users.noreply.github.com> Date: Wed, 9 Dec 2020 15:47:23 +0530 Subject: [PATCH 279/792] Update voice_activity_detection_eng_v1.0.yaml --- yaml/voice_activity_detection_eng_v1.0.yaml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/yaml/voice_activity_detection_eng_v1.0.yaml b/yaml/voice_activity_detection_eng_v1.0.yaml index 7fca01284..e138f3827 100644 --- a/yaml/voice_activity_detection_eng_v1.0.yaml +++ b/yaml/voice_activity_detection_eng_v1.0.yaml @@ -11,7 +11,7 @@ servers: - url: 'https://apis.sentient.io' tags: - name: "v1.0.0" - description: "Published Date - Nov 30, 2020" + description: "Published Date - Dec 09, 2020" paths: /microservices/voice/vad/v1/getpredictions: post: @@ -241,7 +241,7 @@ components: items: oneOf: - type: string - example: Published Date - Nov 30,2020 + example: Published Date - Dec 09, 2020 description: Standardizing Output JSON v0.1.0: type: array From 602d4af0f090f952656e748fe677f1bc7d33b9de Mon Sep 17 00:00:00 2001 From: rameshsentient <51635015+rameshsentient@users.noreply.github.com> Date: Wed, 9 Dec 2020 15:48:08 +0530 Subject: [PATCH 280/792] Update asr_with_voice_activity_detection_eng_sg_v1.0.yaml --- yaml/asr_with_voice_activity_detection_eng_sg_v1.0.yaml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/yaml/asr_with_voice_activity_detection_eng_sg_v1.0.yaml b/yaml/asr_with_voice_activity_detection_eng_sg_v1.0.yaml index 26420f88c..7de2daf84 100644 --- a/yaml/asr_with_voice_activity_detection_eng_sg_v1.0.yaml +++ b/yaml/asr_with_voice_activity_detection_eng_sg_v1.0.yaml @@ -12,7 +12,7 @@ servers: - url: 'https://apis.sentient.io' tags: - name: "v1.0.0" - description: "Published Date - Nov 30, 2020" + description: "Published Date - Dec 09, 2020" paths: /microservices/voice/vadasr/v1/getpredictions: post: @@ -270,7 +270,7 @@ components: items: oneOf: - type: string - example: Published Date - Nov 30,2020 + example: Published Date - Dec 09, 2020 description: Standardizing Output JSON v0.1.0: From 2ebab3796ca4f3b773b72f63f5b0475530b2e459 Mon Sep 17 00:00:00 2001 From: rameshsentient <51635015+rameshsentient@users.noreply.github.com> Date: Wed, 9 Dec 2020 15:49:32 +0530 Subject: [PATCH 281/792] Update automatic_speech_recognition_eng_sg_v1.0.yaml --- yaml/automatic_speech_recognition_eng_sg_v1.0.yaml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/yaml/automatic_speech_recognition_eng_sg_v1.0.yaml b/yaml/automatic_speech_recognition_eng_sg_v1.0.yaml index 0a1fdedb1..20be3c8b0 100644 --- a/yaml/automatic_speech_recognition_eng_sg_v1.0.yaml +++ b/yaml/automatic_speech_recognition_eng_sg_v1.0.yaml @@ -13,7 +13,7 @@ servers: - url: 'https://apis.sentient.io' tags: - name: "v1.0.0" - description: "Published Date - Nov 30, 2020" + description: "Published Date - Dec 09, 2020" paths: /microservices/voice/asr/v1/getpredictions: post: @@ -289,7 +289,7 @@ components: items: oneOf: - type: string - example: Published Date - Nov 30,2020 + example: Published Date - Dec 09, 2020 description: Standardizing Output JSON v0.1.0: From 7c576645ee4e5501b0febe29c40747315a6dee93 Mon Sep 17 00:00:00 2001 From: rameshsentient <51635015+rameshsentient@users.noreply.github.com> Date: Wed, 9 Dec 2020 16:44:18 +0530 Subject: [PATCH 282/792] Update index.yaml --- yaml/index.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/yaml/index.yaml b/yaml/index.yaml index 1eb2e0f1d..bd5dc7cd5 100644 --- a/yaml/index.yaml +++ b/yaml/index.yaml @@ -2,7 +2,7 @@ Voice: Automatic Speech Recognition ENG (SG): title: automatic_speech_recognition_eng_sg versions: - v1.0: "https://raw.githubusercontent.com/sentient-io/microservice-docs/dev/yaml/automatic_speech_recognition_eng_sg_v1.0.yaml" + v1.0: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/automatic_speech_recognition_eng_sg_v1.0.yaml" v0.1: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/automatic_speech_recognition_eng_sg.yaml" Automatic Speech Recognition CHI (SG): title: automatic_speech_recognition_chi_sg From 43dbf4a82998731aad96050763eb66fa86295ec5 Mon Sep 17 00:00:00 2001 From: rameshsentient <51635015+rameshsentient@users.noreply.github.com> Date: Wed, 9 Dec 2020 16:50:21 +0530 Subject: [PATCH 283/792] Update Demographics_classification.yaml --- yaml/Demographics_classification.yaml | 1 + 1 file changed, 1 insertion(+) diff --git a/yaml/Demographics_classification.yaml b/yaml/Demographics_classification.yaml index b83372dc2..549582343 100644 --- a/yaml/Demographics_classification.yaml +++ b/yaml/Demographics_classification.yaml @@ -3,6 +3,7 @@ info: title: Demographic Classification description: |+ This Computer Vision microservice detects for faces from an input image and predicts the demographics of each face (age, gender and race). The image is given as an input encoded using base64. The microservice will a face detector and subsequently models to predict age, gender and race. The results will then be returned back to the user as a JSON output together with bounding box coordinates for each face.Races include: Asian, Indian, White, Black, Middle Eastern and Latino Hispanic + The size of your image file should **not exceed 5 MB**, and the image dimension should be **at least 416x416 pixels**. version: v0.1.0 x-subscribelink: TO FILL MANUALLY servers: From d90686471f8fdf3bc6601ea856745a31ef1e8654 Mon Sep 17 00:00:00 2001 From: priyaPeristera Date: Wed, 9 Dec 2020 23:19:02 +1100 Subject: [PATCH 284/792] Change the name --- ...s_classification.yaml => demographics_classification.yaml} | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) rename yaml/{Demographics_classification.yaml => demographics_classification.yaml} (99%) diff --git a/yaml/Demographics_classification.yaml b/yaml/demographics_classification.yaml similarity index 99% rename from yaml/Demographics_classification.yaml rename to yaml/demographics_classification.yaml index 549582343..b61e9106e 100644 --- a/yaml/Demographics_classification.yaml +++ b/yaml/demographics_classification.yaml @@ -1,11 +1,11 @@ openapi: 3.0.1 info: - title: Demographic Classification + title: Demographics Classification description: |+ This Computer Vision microservice detects for faces from an input image and predicts the demographics of each face (age, gender and race). The image is given as an input encoded using base64. The microservice will a face detector and subsequently models to predict age, gender and race. The results will then be returned back to the user as a JSON output together with bounding box coordinates for each face.Races include: Asian, Indian, White, Black, Middle Eastern and Latino Hispanic The size of your image file should **not exceed 5 MB**, and the image dimension should be **at least 416x416 pixels**. version: v0.1.0 - x-subscribelink: TO FILL MANUALLY + x-subscribelink: demographics_classification servers: - url: 'https://apis.sentient.io' tags: From 5849842571092f4edc1e21af584c88094fdad277 Mon Sep 17 00:00:00 2001 From: priyaPeristera Date: Wed, 9 Dec 2020 23:20:23 +1100 Subject: [PATCH 285/792] Update demo class details --- yaml/index.yaml | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/yaml/index.yaml b/yaml/index.yaml index bd5dc7cd5..7dff0c4f0 100644 --- a/yaml/index.yaml +++ b/yaml/index.yaml @@ -108,10 +108,10 @@ Computer Vision: title: landmark_detection_jp versions: v0.1: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/landmark_detection_jp.yaml" - Demographic Classification: - title: demographic_classification + Demographics Classification: + title: demographics_classification versions: - v0.1: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/Demographics_classification.yaml" + v0.1: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/demographics_classification.yaml" Utility: Youtube Video Downloader: title: youtube_video_downloader From bca6733fe80990495b3572ccb40004df64a224c2 Mon Sep 17 00:00:00 2001 From: priyaPeristera Date: Wed, 9 Dec 2020 23:23:56 +1100 Subject: [PATCH 286/792] Remove model from input parameters --- yaml/face_recognition_politicians_sg_v1.0.yaml | 10 ---------- 1 file changed, 10 deletions(-) diff --git a/yaml/face_recognition_politicians_sg_v1.0.yaml b/yaml/face_recognition_politicians_sg_v1.0.yaml index 921ba32ef..bbe6898c0 100644 --- a/yaml/face_recognition_politicians_sg_v1.0.yaml +++ b/yaml/face_recognition_politicians_sg_v1.0.yaml @@ -252,16 +252,6 @@ components: - model - image_base64 properties: - model: - x-name: model - type: string - default: true - example: sg-parliament-2019 - description: |+ - Model names. - sg-parliament-2019 is trained on Singapore Members of Parliament - 2019. - sg-parliament-2020 is trained on Singapore Members of Parliament - 2020. - sg-jp-2020 is trained on Singapore and Japan public figures - 2020. image_base64: x-name: image_base64 type: string From e46e4541c18d9f242eb3609ee331383f6b3defb2 Mon Sep 17 00:00:00 2001 From: priyaPeristera Date: Wed, 9 Dec 2020 23:40:30 +1100 Subject: [PATCH 287/792] Update the Filter details --- yaml/face_recognition_politicians_sg_v1.0.yaml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/yaml/face_recognition_politicians_sg_v1.0.yaml b/yaml/face_recognition_politicians_sg_v1.0.yaml index bbe6898c0..6b15216bf 100644 --- a/yaml/face_recognition_politicians_sg_v1.0.yaml +++ b/yaml/face_recognition_politicians_sg_v1.0.yaml @@ -280,9 +280,9 @@ components: x-name: filter type: array default: false - example: ["Japan", "television_actors"] + example: ["japan", "television_actors"] description: |+ - Filter list of attributes to reduce wrong matches. Supported attributes are model-dependent. + Filter list of attributes to reduce wrong matches. securitySchemes: APIAuthorizer: From 0064dbb565a254407c7deb9b74bba261caf79a7c Mon Sep 17 00:00:00 2001 From: Priyadharshini <57977344+priyadharshini-sent@users.noreply.github.com> Date: Thu, 10 Dec 2020 15:24:10 +0530 Subject: [PATCH 288/792] Update face_recognition_politicians_sg_v1.0.yaml --- yaml/face_recognition_politicians_sg_v1.0.yaml | 2 ++ 1 file changed, 2 insertions(+) diff --git a/yaml/face_recognition_politicians_sg_v1.0.yaml b/yaml/face_recognition_politicians_sg_v1.0.yaml index 6b15216bf..b252bf1a6 100644 --- a/yaml/face_recognition_politicians_sg_v1.0.yaml +++ b/yaml/face_recognition_politicians_sg_v1.0.yaml @@ -9,6 +9,8 @@ info: The size of your image file should **not exceed 5 MB**, and the image dimension should be **at least 416x416 pixels**. version: '1.0.0' + Suggested Use Cases: + - For solutions related to identifying the speaker for auto-tagging, or matching the transcription to the person that is a Member of the Singapore Parliament. x-subscribelink: face_recognition_politicians_sg servers: - url: 'https://apis.sentient.io' From eb941ec2b280e2367c1a895bfab4ba2866e565f4 Mon Sep 17 00:00:00 2001 From: Priyadharshini <57977344+priyadharshini-sent@users.noreply.github.com> Date: Thu, 10 Dec 2020 15:25:28 +0530 Subject: [PATCH 289/792] Update face_recognition_politicians_sg_v1.0.yaml --- yaml/face_recognition_politicians_sg_v1.0.yaml | 1 + 1 file changed, 1 insertion(+) diff --git a/yaml/face_recognition_politicians_sg_v1.0.yaml b/yaml/face_recognition_politicians_sg_v1.0.yaml index b252bf1a6..e40ee4885 100644 --- a/yaml/face_recognition_politicians_sg_v1.0.yaml +++ b/yaml/face_recognition_politicians_sg_v1.0.yaml @@ -9,6 +9,7 @@ info: The size of your image file should **not exceed 5 MB**, and the image dimension should be **at least 416x416 pixels**. version: '1.0.0' + x-additionalinfo: |+ Suggested Use Cases: - For solutions related to identifying the speaker for auto-tagging, or matching the transcription to the person that is a Member of the Singapore Parliament. x-subscribelink: face_recognition_politicians_sg From f26679ec0e3deaa9d12440f5b789f7addc93079c Mon Sep 17 00:00:00 2001 From: Priyadharshini <57977344+priyadharshini-sent@users.noreply.github.com> Date: Thu, 10 Dec 2020 15:26:00 +0530 Subject: [PATCH 290/792] Update asr_with_voice_activity_detection_eng_sg_v1.0.yaml --- yaml/asr_with_voice_activity_detection_eng_sg_v1.0.yaml | 3 +++ 1 file changed, 3 insertions(+) diff --git a/yaml/asr_with_voice_activity_detection_eng_sg_v1.0.yaml b/yaml/asr_with_voice_activity_detection_eng_sg_v1.0.yaml index 7de2daf84..3ea358a1a 100644 --- a/yaml/asr_with_voice_activity_detection_eng_sg_v1.0.yaml +++ b/yaml/asr_with_voice_activity_detection_eng_sg_v1.0.yaml @@ -7,6 +7,9 @@ info: The size of your audio file should be **between 3 KB to 10 MB**. version: '1.0.0' + x-additionalinfo: |+ + Suggested Use Cases: + - Combine this with the Text-to-Speech API to deliver voice-enabled experiences in IoT (Internet of Things) applications, such as implementing voice commands like “turn the volume up". x-subscribelink: asr_with_voice_activity_detection_eng_sg servers: - url: 'https://apis.sentient.io' From a588532b04b3905c8ec1cc090654cdb1873b7f1c Mon Sep 17 00:00:00 2001 From: Priyadharshini <57977344+priyadharshini-sent@users.noreply.github.com> Date: Thu, 10 Dec 2020 15:26:33 +0530 Subject: [PATCH 291/792] Update automatic_speech_recognition_eng_sg_v1.0.yaml --- yaml/automatic_speech_recognition_eng_sg_v1.0.yaml | 3 +++ 1 file changed, 3 insertions(+) diff --git a/yaml/automatic_speech_recognition_eng_sg_v1.0.yaml b/yaml/automatic_speech_recognition_eng_sg_v1.0.yaml index 20be3c8b0..a91da2bb8 100644 --- a/yaml/automatic_speech_recognition_eng_sg_v1.0.yaml +++ b/yaml/automatic_speech_recognition_eng_sg_v1.0.yaml @@ -8,6 +8,9 @@ info: The size of your audio file should be **between 3 KB to 10 MB**. version: '1.0.0' + x-additionalinfo: |+ + Suggested Use Cases: + - Combine this with the Text-to-Speech API to deliver voice-enabled experiences in IoT (Internet of Things) applications, such as implementing voice commands. x-subscribelink: automatic_speech_recognition_eng_sg servers: - url: 'https://apis.sentient.io' From be85cde89256f2c74dff12d857c2124ba6ebb3d3 Mon Sep 17 00:00:00 2001 From: Priyadharshini <57977344+priyadharshini-sent@users.noreply.github.com> Date: Thu, 10 Dec 2020 15:27:38 +0530 Subject: [PATCH 292/792] Update voice_activity_detection_eng_v1.0.yaml --- yaml/voice_activity_detection_eng_v1.0.yaml | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/yaml/voice_activity_detection_eng_v1.0.yaml b/yaml/voice_activity_detection_eng_v1.0.yaml index e138f3827..63e4a4f72 100644 --- a/yaml/voice_activity_detection_eng_v1.0.yaml +++ b/yaml/voice_activity_detection_eng_v1.0.yaml @@ -6,6 +6,12 @@ info: An utterance is the smallest unit of speech. It is a continuous piece of speech beginning and ending with a clear pause. version: '1.0.0' + x-additionalinfo: |+ + Suggested Use Cases: + - Narrate a blurb or chunk of text in English + - Improve customer service - empower a customer service system by adding IVR (interactive voice response) and agent conversations to call centers. Perform analytics on conversation data to gain more insights into the calls and customers. + - Enable voice control - implement voice commands such as “turn the volume up,” and voice search such as saying “what is the temperature in Paris?” + - Transcribe multimedia content - transcribe audio and video to include captions and improve audience reach and experience. For example, this microservice can be used for indexing or subtitling video and/or multispeaker content; similar to video captioning on YouTube. x-subscribelink: voice_activity_detection_eng servers: - url: 'https://apis.sentient.io' From a68ae134201fc4740f5f66caf7324e025e43d376 Mon Sep 17 00:00:00 2001 From: Priyadharshini <57977344+priyadharshini-sent@users.noreply.github.com> Date: Thu, 10 Dec 2020 15:55:46 +0530 Subject: [PATCH 293/792] Update face_recognition_politicians_sg_v1.0.yaml --- yaml/face_recognition_politicians_sg_v1.0.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/yaml/face_recognition_politicians_sg_v1.0.yaml b/yaml/face_recognition_politicians_sg_v1.0.yaml index e40ee4885..a113ff1e6 100644 --- a/yaml/face_recognition_politicians_sg_v1.0.yaml +++ b/yaml/face_recognition_politicians_sg_v1.0.yaml @@ -1,6 +1,6 @@ openapi: 3.0.1 info: - title: Face Recognition Politicians (SG) + title: Face Recognition description: |+ This Computer Vision microservice recognises faces from input image files of Singapore Members of Parliament and Japan Public figures. From 0f9e13a94e71b6c8548c0a6018940c82dfa1f44a Mon Sep 17 00:00:00 2001 From: Priyadharshini <57977344+priyadharshini-sent@users.noreply.github.com> Date: Thu, 10 Dec 2020 15:56:26 +0530 Subject: [PATCH 294/792] Update face_recognition_politicians_sg.yaml --- yaml/face_recognition_politicians_sg.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/yaml/face_recognition_politicians_sg.yaml b/yaml/face_recognition_politicians_sg.yaml index 5358880be..6e6d96eb0 100644 --- a/yaml/face_recognition_politicians_sg.yaml +++ b/yaml/face_recognition_politicians_sg.yaml @@ -1,6 +1,6 @@ openapi: 3.0.1 info: - title: Face Recognition Politicians (SG) + title: Face Recognition description: |+ This Computer Vision microservice recognises faces from input image files of the Members of Singapore Parliament. From 29a4f9cbe17f48b0028a3735afc1a7fa0fbf4507 Mon Sep 17 00:00:00 2001 From: Priyadharshini <57977344+priyadharshini-sent@users.noreply.github.com> Date: Thu, 10 Dec 2020 15:57:02 +0530 Subject: [PATCH 295/792] Update face_recognition_politicians_sg_v1.0.yaml --- yaml/face_recognition_politicians_sg_v1.0.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/yaml/face_recognition_politicians_sg_v1.0.yaml b/yaml/face_recognition_politicians_sg_v1.0.yaml index a113ff1e6..9ac3128f9 100644 --- a/yaml/face_recognition_politicians_sg_v1.0.yaml +++ b/yaml/face_recognition_politicians_sg_v1.0.yaml @@ -10,7 +10,7 @@ info: The size of your image file should **not exceed 5 MB**, and the image dimension should be **at least 416x416 pixels**. version: '1.0.0' x-additionalinfo: |+ - Suggested Use Cases: + Suggested Use Cases: - For solutions related to identifying the speaker for auto-tagging, or matching the transcription to the person that is a Member of the Singapore Parliament. x-subscribelink: face_recognition_politicians_sg servers: From 134449025e3e2bf422a351932e1dbc3826bcc1ee Mon Sep 17 00:00:00 2001 From: Priyadharshini <57977344+priyadharshini-sent@users.noreply.github.com> Date: Thu, 10 Dec 2020 16:01:08 +0530 Subject: [PATCH 296/792] Update index.yaml --- yaml/index.yaml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/yaml/index.yaml b/yaml/index.yaml index 7dff0c4f0..362cafc56 100644 --- a/yaml/index.yaml +++ b/yaml/index.yaml @@ -91,8 +91,8 @@ Computer Vision: title: object_detection versions: v0.1: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/object_detection.yaml" - Face Recognition Politicians (SG): - title: face_recognition_politicians_sg + Face Recognition: + title: face_recognition versions: v1.0: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/face_recognition_politicians_sg_v1.0.yaml" v0.1: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/face_recognition_politicians_sg.yaml" From 737b9a1f4b452e9f0ebbc3ecf1c62120c2da3ef4 Mon Sep 17 00:00:00 2001 From: Priyadharshini <57977344+priyadharshini-sent@users.noreply.github.com> Date: Thu, 10 Dec 2020 16:01:38 +0530 Subject: [PATCH 297/792] Update face_recognition_politicians_sg_v1.0.yaml --- yaml/face_recognition_politicians_sg_v1.0.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/yaml/face_recognition_politicians_sg_v1.0.yaml b/yaml/face_recognition_politicians_sg_v1.0.yaml index 9ac3128f9..adb445c97 100644 --- a/yaml/face_recognition_politicians_sg_v1.0.yaml +++ b/yaml/face_recognition_politicians_sg_v1.0.yaml @@ -12,7 +12,7 @@ info: x-additionalinfo: |+ Suggested Use Cases: - For solutions related to identifying the speaker for auto-tagging, or matching the transcription to the person that is a Member of the Singapore Parliament. - x-subscribelink: face_recognition_politicians_sg + x-subscribelink: face_recognition servers: - url: 'https://apis.sentient.io' tags: From 459788b16fce0710866f457ef9a012abe3c43d6a Mon Sep 17 00:00:00 2001 From: Priyadharshini <57977344+priyadharshini-sent@users.noreply.github.com> Date: Thu, 10 Dec 2020 16:02:00 +0530 Subject: [PATCH 298/792] Update face_recognition_politicians_sg.yaml --- yaml/face_recognition_politicians_sg.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/yaml/face_recognition_politicians_sg.yaml b/yaml/face_recognition_politicians_sg.yaml index 6e6d96eb0..ad36e7b5f 100644 --- a/yaml/face_recognition_politicians_sg.yaml +++ b/yaml/face_recognition_politicians_sg.yaml @@ -9,7 +9,7 @@ info: Suggested Use Cases: - For solutions related to identifying the speaker for auto-tagging, or matching the transcription to the person that is a Member of the Singapore Parliament. version: '0.1.0' - x-subscribelink: face_recognition_politicians_sg + x-subscribelink: face_recognition servers: - url: 'https://apis.sentient.io' tags: From 242d5c71891a500771fa69e3014efa62681781a2 Mon Sep 17 00:00:00 2001 From: Priyadharshini <57977344+priyadharshini-sent@users.noreply.github.com> Date: Thu, 10 Dec 2020 16:03:23 +0530 Subject: [PATCH 299/792] Update face_recognition_politicians_sg.yaml --- yaml/face_recognition_politicians_sg.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/yaml/face_recognition_politicians_sg.yaml b/yaml/face_recognition_politicians_sg.yaml index ad36e7b5f..2c050143d 100644 --- a/yaml/face_recognition_politicians_sg.yaml +++ b/yaml/face_recognition_politicians_sg.yaml @@ -7,7 +7,7 @@ info: This microservice returns the identity of the person, the bounding box in image coordinates, and the confidence of the prediction. x-additionalinfo: |+ Suggested Use Cases: - - For solutions related to identifying the speaker for auto-tagging, or matching the transcription to the person that is a Member of the Singapore Parliament. + - - For solutions related to identifying the speaker for auto-tagging, or matching the transcription to a person that is a Singaporean politician, or a Singaporean/Japanese public figure. version: '0.1.0' x-subscribelink: face_recognition servers: From 5be26ae192e5ea63cb1ca9bd8bf9340b8741567e Mon Sep 17 00:00:00 2001 From: Priyadharshini <57977344+priyadharshini-sent@users.noreply.github.com> Date: Thu, 10 Dec 2020 16:03:46 +0530 Subject: [PATCH 300/792] Update face_recognition_politicians_sg_v1.0.yaml --- yaml/face_recognition_politicians_sg_v1.0.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/yaml/face_recognition_politicians_sg_v1.0.yaml b/yaml/face_recognition_politicians_sg_v1.0.yaml index adb445c97..b950e347a 100644 --- a/yaml/face_recognition_politicians_sg_v1.0.yaml +++ b/yaml/face_recognition_politicians_sg_v1.0.yaml @@ -11,7 +11,7 @@ info: version: '1.0.0' x-additionalinfo: |+ Suggested Use Cases: - - For solutions related to identifying the speaker for auto-tagging, or matching the transcription to the person that is a Member of the Singapore Parliament. + - - For solutions related to identifying the speaker for auto-tagging, or matching the transcription to a person that is a Singaporean politician, or a Singaporean/Japanese public figure. x-subscribelink: face_recognition servers: - url: 'https://apis.sentient.io' From f76abe9502fe49b79c65deb52054d892207160a3 Mon Sep 17 00:00:00 2001 From: Priyadharshini <57977344+priyadharshini-sent@users.noreply.github.com> Date: Thu, 10 Dec 2020 16:05:33 +0530 Subject: [PATCH 301/792] Update face_recognition_politicians_sg_v1.0.yaml --- yaml/face_recognition_politicians_sg_v1.0.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/yaml/face_recognition_politicians_sg_v1.0.yaml b/yaml/face_recognition_politicians_sg_v1.0.yaml index b950e347a..abb1dbd5f 100644 --- a/yaml/face_recognition_politicians_sg_v1.0.yaml +++ b/yaml/face_recognition_politicians_sg_v1.0.yaml @@ -11,7 +11,7 @@ info: version: '1.0.0' x-additionalinfo: |+ Suggested Use Cases: - - - For solutions related to identifying the speaker for auto-tagging, or matching the transcription to a person that is a Singaporean politician, or a Singaporean/Japanese public figure. + - For solutions related to identifying the speaker for auto-tagging, or matching the transcription to a person that is a Singaporean politician, or a Singaporean/Japanese public figure. x-subscribelink: face_recognition servers: - url: 'https://apis.sentient.io' From 66fd6255a9988286f42b82c65c0dec9e32f2166f Mon Sep 17 00:00:00 2001 From: Priyadharshini <57977344+priyadharshini-sent@users.noreply.github.com> Date: Thu, 10 Dec 2020 16:05:52 +0530 Subject: [PATCH 302/792] Update face_recognition_politicians_sg.yaml --- yaml/face_recognition_politicians_sg.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/yaml/face_recognition_politicians_sg.yaml b/yaml/face_recognition_politicians_sg.yaml index 2c050143d..82c481cf3 100644 --- a/yaml/face_recognition_politicians_sg.yaml +++ b/yaml/face_recognition_politicians_sg.yaml @@ -7,7 +7,7 @@ info: This microservice returns the identity of the person, the bounding box in image coordinates, and the confidence of the prediction. x-additionalinfo: |+ Suggested Use Cases: - - - For solutions related to identifying the speaker for auto-tagging, or matching the transcription to a person that is a Singaporean politician, or a Singaporean/Japanese public figure. + - For solutions related to identifying the speaker for auto-tagging, or matching the transcription to a person that is a Singaporean politician, or a Singaporean/Japanese public figure. version: '0.1.0' x-subscribelink: face_recognition servers: From e46a2ed2819e21d22673abd8076813d99de77283 Mon Sep 17 00:00:00 2001 From: Priyadharshini <57977344+priyadharshini-sent@users.noreply.github.com> Date: Thu, 10 Dec 2020 16:16:19 +0530 Subject: [PATCH 303/792] Update face_recognition_politicians_sg_v1.0.yaml --- yaml/face_recognition_politicians_sg_v1.0.yaml | 11 +++++------ 1 file changed, 5 insertions(+), 6 deletions(-) diff --git a/yaml/face_recognition_politicians_sg_v1.0.yaml b/yaml/face_recognition_politicians_sg_v1.0.yaml index abb1dbd5f..73119a31d 100644 --- a/yaml/face_recognition_politicians_sg_v1.0.yaml +++ b/yaml/face_recognition_politicians_sg_v1.0.yaml @@ -2,12 +2,11 @@ openapi: 3.0.1 info: title: Face Recognition description: |+ - This Computer Vision microservice recognises faces from input image files of Singapore Members of Parliament and Japan Public figures. - - This microservice returns the identity of the person, the bounding box in image coordinates, and the confidence of the prediction. - Some models also provide the option to filter the returned identity based on predefined attributes" - - The size of your image file should **not exceed 5 MB**, and the image dimension should be **at least 416x416 pixels**. + This Computer Vision microservice recognises faces of Singaporean and Japanese public figures (e.g. athletes, business leaders, celebrities, politicians, TV personalities, etc). + + This microservice returns the identity of the person, the bounding box in image coordinates, and the confidence of the prediction. Users can further filter + + Help us grow this microservice! [Let us know](https://www.sentient.io/contact) which other public figures you would like us this microservice to also recognise (e.g. a new country or a new category). We will expand the capability of this microservices based on user feedback and demand. version: '1.0.0' x-additionalinfo: |+ Suggested Use Cases: From b1b9730258e530682d09767acdbc003c941003f2 Mon Sep 17 00:00:00 2001 From: Priyadharshini <57977344+priyadharshini-sent@users.noreply.github.com> Date: Thu, 10 Dec 2020 16:18:52 +0530 Subject: [PATCH 304/792] Update face_recognition_politicians_sg.yaml --- yaml/face_recognition_politicians_sg.yaml | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/yaml/face_recognition_politicians_sg.yaml b/yaml/face_recognition_politicians_sg.yaml index 82c481cf3..e2d4f0946 100644 --- a/yaml/face_recognition_politicians_sg.yaml +++ b/yaml/face_recognition_politicians_sg.yaml @@ -2,9 +2,11 @@ openapi: 3.0.1 info: title: Face Recognition description: |+ - This Computer Vision microservice recognises faces from input image files of the Members of Singapore Parliament. + This Computer Vision microservice recognises faces of Singaporean and Japanese public figures (e.g. athletes, business leaders, celebrities, politicians, TV personalities, etc). - This microservice returns the identity of the person, the bounding box in image coordinates, and the confidence of the prediction. + This microservice returns the identity of the person, the bounding box in image coordinates, and the confidence of the prediction. Users can further filter + + Help us grow this microservice! [Let us know](https://www.sentient.io/contact) which other public figures you would like us this microservice to also recognise (e.g. a new country or a new category). We will expand the capability of this microservices based on user feedback and demand. x-additionalinfo: |+ Suggested Use Cases: - For solutions related to identifying the speaker for auto-tagging, or matching the transcription to a person that is a Singaporean politician, or a Singaporean/Japanese public figure. From 30578be911c986e1048f05697cd3027b55043fa3 Mon Sep 17 00:00:00 2001 From: wchia <62536464+wchia@users.noreply.github.com> Date: Fri, 11 Dec 2020 17:13:03 +0800 Subject: [PATCH 305/792] Rename face_recognition_politicians_sg_v1.0.yaml to face_recognition_v1.0.yaml --- ...nition_politicians_sg_v1.0.yaml => face_recognition_v1.0.yaml} | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename yaml/{face_recognition_politicians_sg_v1.0.yaml => face_recognition_v1.0.yaml} (100%) diff --git a/yaml/face_recognition_politicians_sg_v1.0.yaml b/yaml/face_recognition_v1.0.yaml similarity index 100% rename from yaml/face_recognition_politicians_sg_v1.0.yaml rename to yaml/face_recognition_v1.0.yaml From d93e25adfd8771bad0e04c4972c3f4ddc108414c Mon Sep 17 00:00:00 2001 From: wchia <62536464+wchia@users.noreply.github.com> Date: Fri, 11 Dec 2020 17:13:58 +0800 Subject: [PATCH 306/792] Update face_recognition_v1.0.yaml Changed description --- yaml/face_recognition_v1.0.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/yaml/face_recognition_v1.0.yaml b/yaml/face_recognition_v1.0.yaml index 73119a31d..29eab541b 100644 --- a/yaml/face_recognition_v1.0.yaml +++ b/yaml/face_recognition_v1.0.yaml @@ -4,7 +4,7 @@ info: description: |+ This Computer Vision microservice recognises faces of Singaporean and Japanese public figures (e.g. athletes, business leaders, celebrities, politicians, TV personalities, etc). - This microservice returns the identity of the person, the bounding box in image coordinates, and the confidence of the prediction. Users can further filter + This microservice returns the identity of the person, the bounding box in image coordinates, and the confidence of the prediction. Users can further filter the results by countries, categories or even down to the individual names. Help us grow this microservice! [Let us know](https://www.sentient.io/contact) which other public figures you would like us this microservice to also recognise (e.g. a new country or a new category). We will expand the capability of this microservices based on user feedback and demand. version: '1.0.0' From cc0096145cdf570d8ee8d0ffc88491fcc9d97740 Mon Sep 17 00:00:00 2001 From: wchia <62536464+wchia@users.noreply.github.com> Date: Fri, 11 Dec 2020 17:18:37 +0800 Subject: [PATCH 307/792] Update index.yaml Changed reference to face recognition YAML file --- yaml/index.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/yaml/index.yaml b/yaml/index.yaml index 362cafc56..f383be904 100644 --- a/yaml/index.yaml +++ b/yaml/index.yaml @@ -94,7 +94,7 @@ Computer Vision: Face Recognition: title: face_recognition versions: - v1.0: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/face_recognition_politicians_sg_v1.0.yaml" + v1.0: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/face_recognition_v1.0.yaml" v0.1: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/face_recognition_politicians_sg.yaml" People Counting: title: people_counting From 2bd15ce1b6fcbcbad7bb9730f3affab6d3152ecc Mon Sep 17 00:00:00 2001 From: Priyadharshini Date: Tue, 15 Dec 2020 14:18:35 +0530 Subject: [PATCH 308/792] merge dev changes --- ..._voice_activity_detection_eng_sg_v1.0.yaml | 22 ++++--- ...omatic_speech_recognition_eng_sg_v1.0.yaml | 22 ++++--- yaml/face_recognition_v1.0.yaml | 62 ++++++++++++++++++- 3 files changed, 87 insertions(+), 19 deletions(-) diff --git a/yaml/asr_with_voice_activity_detection_eng_sg_v1.0.yaml b/yaml/asr_with_voice_activity_detection_eng_sg_v1.0.yaml index 3ea358a1a..313ea595d 100644 --- a/yaml/asr_with_voice_activity_detection_eng_sg_v1.0.yaml +++ b/yaml/asr_with_voice_activity_detection_eng_sg_v1.0.yaml @@ -3,10 +3,10 @@ info: title: ASR with Voice Activity Detection ENG (SG) description: |+ This Voice microservice combines Voice Activity Detection feature and Automatic Speech Recognition capability. It detects speech in an audio file (.wav format) and transcribes English speech content from the audio stream into text. The transcript text is timestamped for each utterance. An utterance is a continuous piece of speech beginning and ending with a clear pause. - This Voice microservice performs well on Singapore-accented English speech. For best performance, select the model which best matches the use-case: news_parliament, nsc_parliament, nscfull_8k. + This microservice performs well on Singaporean-accented English speech. For best performance, select the model which best matches the use-case, whether for prepared speech (16kHz) or telephony (8kHz). The size of your audio file should be **between 3 KB to 10 MB**. - version: '1.0.0' + version: '1.1.0' x-additionalinfo: |+ Suggested Use Cases: - Combine this with the Text-to-Speech API to deliver voice-enabled experiences in IoT (Internet of Things) applications, such as implementing voice commands like “turn the volume up". @@ -14,13 +14,13 @@ info: servers: - url: 'https://apis.sentient.io' tags: -- name: "v1.0.0" - description: "Published Date - Dec 09, 2020" +- name: "v1.1.0" + description: "Published Date - Dec 14, 2020" paths: /microservices/voice/vadasr/v1/getpredictions: post: tags: - - v1.0.0 + - v1.1.0 responses: '200': description: success response @@ -236,9 +236,8 @@ components: description: |+ Model selection. For best performance, select the model which best matches the use-case: - 1. news_parliament - 16 kHz, mono channel, .wav format. Trained on Singapore news and parliament corpus. - 2. nsc_parliament - 16 kHz, mono channel, .wav format. Trained on National Speech Corpus and parliament corpus. - 3. nscfull_8k - 8 kHz, mono channel, .wav format. Trained on National Speech Corpus. Trained on Full National Speech Corpus corpus. + 1. prepared_speech - Better suited for transcribing prepared / formal speech (e.g. news or parliamentary speeches). 16 kHz, mono channel, .wav format. + 2. telephony - Better suited for conversational speech or telephony use cases. 8 kHz, mono channel, .wav format. wav_base64: x-name: wav_base64 type: string @@ -268,6 +267,13 @@ components: versions: type: object properties: + v1.1.0: + type: array + items: + oneOf: + - type: string + example: Published Date - Dec 14, 2020 + description: Model name update v1.0.0: type: array items: diff --git a/yaml/automatic_speech_recognition_eng_sg_v1.0.yaml b/yaml/automatic_speech_recognition_eng_sg_v1.0.yaml index a91da2bb8..0dd4712df 100644 --- a/yaml/automatic_speech_recognition_eng_sg_v1.0.yaml +++ b/yaml/automatic_speech_recognition_eng_sg_v1.0.yaml @@ -4,10 +4,10 @@ info: description: |+ This Voice microservice transcribes the input audio stream into text. - This microservice performs well on Singaporean-accented English speech. For best performance, select the model which best matches the use-case: news_parliament, nsc_parliament and nscfull_8k. + This microservice performs well on Singaporean-accented English speech. For best performance, select the model which best matches the use-case, whether for prepared speech (16kHz) or telephony (8kHz). The size of your audio file should be **between 3 KB to 10 MB**. - version: '1.0.0' + version: '1.1.0' x-additionalinfo: |+ Suggested Use Cases: - Combine this with the Text-to-Speech API to deliver voice-enabled experiences in IoT (Internet of Things) applications, such as implementing voice commands. @@ -15,13 +15,13 @@ info: servers: - url: 'https://apis.sentient.io' tags: -- name: "v1.0.0" - description: "Published Date - Dec 09, 2020" +- name: "v1.1.0" + description: "Published Date - Dec 14, 2020" paths: /microservices/voice/asr/v1/getpredictions: post: tags: - - v1.0.0 + - v1.1.0 responses: '200': description: success response @@ -240,9 +240,8 @@ components: description: |+ Model selection. For best performance, select the model which best matches the use-case: - 1. news_parliament - 16 kHz, mono channel, .wav format. Trained on Singapore news and parliament corpus. - 2. nsc_parliament - 16 kHz, mono channel, .wav format. Trained on National Speech Corpus and parliament corpus. - 3. nscfull_8k - 8 kHz, mono channel, .wav format. Trained on National Speech Corpus. Trained on Full National Speech Corpus corpus. + 1. prepared_speech - Better suited for transcribing prepared / formal speech (e.g. news or parliamentary speeches). 16 kHz, mono channel, .wav format. + 2. telephony - Better suited for conversational speech or telephony use cases. 8 kHz, mono channel, .wav format. wav_base64: x-name: wav_base64 type: string @@ -287,6 +286,13 @@ components: versions: type: object properties: + v1.1.0: + type: array + items: + oneOf: + - type: string + example: Published Date - Dec 14, 2020 + description: Model name update v1.0.0: type: array items: diff --git a/yaml/face_recognition_v1.0.yaml b/yaml/face_recognition_v1.0.yaml index 29eab541b..be5aacab7 100644 --- a/yaml/face_recognition_v1.0.yaml +++ b/yaml/face_recognition_v1.0.yaml @@ -4,13 +4,63 @@ info: description: |+ This Computer Vision microservice recognises faces of Singaporean and Japanese public figures (e.g. athletes, business leaders, celebrities, politicians, TV personalities, etc). - This microservice returns the identity of the person, the bounding box in image coordinates, and the confidence of the prediction. Users can further filter the results by countries, categories or even down to the individual names. + This microservice returns the identity of the person, the bounding box in image coordinates, and the confidence of the prediction. Users can further filter the results by countries, profession or even down to the individual names. Help us grow this microservice! [Let us know](https://www.sentient.io/contact) which other public figures you would like us this microservice to also recognise (e.g. a new country or a new category). We will expand the capability of this microservices based on user feedback and demand. version: '1.0.0' x-additionalinfo: |+ - Suggested Use Cases: + **Full List of Filters** + Users may choose to filter the output using any of these filters below. + + 1. Countries: + - Japan + - Singapore + + 2. Categories: + - Olympic_medalist + - Paralympic_competitors + - Paralympic_medalist + - athletes + - bloggers + - broadcast_news_analysts + - business_executives + - business_leaders + - celebrities + - chairmen_of_corporations + - chief_executives + - columnists + - female_pop_singers + - female_singers + - film_actors + - film_actresses + - film_directors + - film_people + - film_producers + - journalists + - male_pop_singers + - male_singers + - participants_in_reality_television_series + - people_of_interest + - photojournalists + - politicians + - pop_singers + - radio_people + - screenwriters + - singer-songwriters + - social_media_personalities + - sportsman + - television_actors + - television_actresses + - television_personalities + - television_presenters + + 3. Individual Names + If you happen to know the individual names of the faces you hope to recognise, you may also put in the individual names as a filter. + + **Suggested Use Cases** - For solutions related to identifying the speaker for auto-tagging, or matching the transcription to a person that is a Singaporean politician, or a Singaporean/Japanese public figure. + + x-subscribelink: face_recognition servers: - url: 'https://apis.sentient.io' @@ -284,7 +334,13 @@ components: default: false example: ["japan", "television_actors"] description: |+ - Filter list of attributes to reduce wrong matches. + Optional filters that allows the user to refine the output. There are 3 types of filters: + + 1. Countries - e.g. "Singapore", "Japan" + 2. Professions - e.g. "atheletes", "pop_singers" + 3. Individual person names - e.g. "Lee Hsien Loong". Useful if the user only wants to detect for specific people. + + See "Additional Information" section for full list of available filters securitySchemes: APIAuthorizer: From bc0ee33335c6d4e59523179b8ea7cf542c4061f4 Mon Sep 17 00:00:00 2001 From: Priyadharshini <57977344+priyadharshini-sent@users.noreply.github.com> Date: Thu, 17 Dec 2020 17:14:06 +0530 Subject: [PATCH 309/792] Update wikipedia_retrieval.yaml --- yaml/wikipedia_retrieval.yaml | 3 +++ 1 file changed, 3 insertions(+) diff --git a/yaml/wikipedia_retrieval.yaml b/yaml/wikipedia_retrieval.yaml index f7ccc3b9d..00dd90397 100644 --- a/yaml/wikipedia_retrieval.yaml +++ b/yaml/wikipedia_retrieval.yaml @@ -293,14 +293,17 @@ components: pageid: type: integer default: true + example: 1 description: The Wikipedia id of the page requested. language: type: string default: false + example: description: Indicates the language in which the Wikipedia page is written. Default is English, for other languages give the input as ISO 639-1 language code filter_key: type: string default: false + example: all description: Indicates the filter criteria of the output result fields. The default return set includes pageid, url, and summary.“all” - returns all the fields. You can also filter by individual fields using the list value. Possible values are pageid, url, summary, content, links, and images securitySchemes: APIAuthorizer: From ba6c6cdc54a522246389c891bf393df2be34a778 Mon Sep 17 00:00:00 2001 From: Priyadharshini <57977344+priyadharshini-sent@users.noreply.github.com> Date: Thu, 17 Dec 2020 17:18:41 +0530 Subject: [PATCH 310/792] Update wikipedia_retrieval.yaml --- yaml/wikipedia_retrieval.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/yaml/wikipedia_retrieval.yaml b/yaml/wikipedia_retrieval.yaml index 00dd90397..4980ed240 100644 --- a/yaml/wikipedia_retrieval.yaml +++ b/yaml/wikipedia_retrieval.yaml @@ -298,7 +298,7 @@ components: language: type: string default: false - example: + example: en description: Indicates the language in which the Wikipedia page is written. Default is English, for other languages give the input as ISO 639-1 language code filter_key: type: string From 6e31ba9ad8b191b3d8f2c20482383f82c4a8f8e3 Mon Sep 17 00:00:00 2001 From: Priyadharshini <57977344+priyadharshini-sent@users.noreply.github.com> Date: Thu, 17 Dec 2020 17:21:12 +0530 Subject: [PATCH 311/792] Update wikipedia_retrieval.yaml --- yaml/wikipedia_retrieval.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/yaml/wikipedia_retrieval.yaml b/yaml/wikipedia_retrieval.yaml index 4980ed240..bfb92d770 100644 --- a/yaml/wikipedia_retrieval.yaml +++ b/yaml/wikipedia_retrieval.yaml @@ -293,7 +293,7 @@ components: pageid: type: integer default: true - example: 1 + example: 27318 description: The Wikipedia id of the page requested. language: type: string From eb17befe9fb378f142742d9b18f4c7d90422ee02 Mon Sep 17 00:00:00 2001 From: Priyadharshini <57977344+priyadharshini-sent@users.noreply.github.com> Date: Thu, 17 Dec 2020 17:23:00 +0530 Subject: [PATCH 312/792] Update wikipedia_retrieval.yaml --- yaml/wikipedia_retrieval.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/yaml/wikipedia_retrieval.yaml b/yaml/wikipedia_retrieval.yaml index bfb92d770..85821cfde 100644 --- a/yaml/wikipedia_retrieval.yaml +++ b/yaml/wikipedia_retrieval.yaml @@ -299,7 +299,7 @@ components: type: string default: false example: en - description: Indicates the language in which the Wikipedia page is written. Default is English, for other languages give the input as ISO 639-1 language code + description: Indicates the language in which the Wikipedia page is written. Default is English, for other languages give the input as ISO 639-1 language code. Please refer this link for language code https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes. filter_key: type: string default: false From 6ac94a3b8e57d1c2f1df5f8ddc8a8b5d23a6642f Mon Sep 17 00:00:00 2001 From: priyaPeristera Date: Mon, 21 Dec 2020 13:53:29 +1100 Subject: [PATCH 313/792] update the platform key --- yaml/base64-file-decode.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/yaml/base64-file-decode.yaml b/yaml/base64-file-decode.yaml index 79983132b..f725d029a 100644 --- a/yaml/base64-file-decode.yaml +++ b/yaml/base64-file-decode.yaml @@ -7,7 +7,7 @@ info: Suggested Use Cases: - As a post-processor for microservices that only outputs Base64 encoded text version: '0.0.1' - x-subscribelink: base64_file_decode + x-subscribelink: base64_decode servers: - url: 'https://apis.sentient.io' tags: From 752064cad4ab44e430842325bc80f0ce71f144e4 Mon Sep 17 00:00:00 2001 From: priyaPeristera Date: Mon, 21 Dec 2020 13:55:00 +1100 Subject: [PATCH 314/792] Update the platform key --- yaml/base64-file-encode.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/yaml/base64-file-encode.yaml b/yaml/base64-file-encode.yaml index 35b9e25a2..5e8e1090f 100644 --- a/yaml/base64-file-encode.yaml +++ b/yaml/base64-file-encode.yaml @@ -7,7 +7,7 @@ info: Suggested Use Cases: - As a pre-processor for microservices that only takes in Base64 inputs version: '0.0.1' - x-subscribelink: base64_file_encode + x-subscribelink: base64_encode servers: - url: 'https://apis.sentient.io' tags: From 28e0faf6ebe0b65345b5c8fb5696bfb7f1506dd0 Mon Sep 17 00:00:00 2001 From: priyaPeristera Date: Mon, 21 Dec 2020 13:58:44 +1100 Subject: [PATCH 315/792] Update file name and key for base64 Update file name and key for base64 Decoder and Encoder --- yaml/index.yaml | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/yaml/index.yaml b/yaml/index.yaml index f383be904..468a307db 100644 --- a/yaml/index.yaml +++ b/yaml/index.yaml @@ -173,14 +173,14 @@ Utility: title: urls_retrieval versions: v0.2: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/urls_retrieval.yaml" - Base64 File Encode: - title: base64_file_encode + Base64 Encoder: + title: base64_encoder versions: - v0.1: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/base64-file-encode.yaml" - Base64 File Decode: - title: base64_file_decode + v0.1: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/base64-encoder.yaml" + Base64 Decoder: + title: base64_decoder versions: - v0.1: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/base64-file-decode.yaml" + v0.1: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/base64-decoder.yaml" Data: HDB Commercial Directories (SG): title: commercial_directories_hdb_sg From d61ede810a10f7a6247e5f94dd43c8b5f2d3ae66 Mon Sep 17 00:00:00 2001 From: priyaPeristera Date: Mon, 21 Dec 2020 13:59:39 +1100 Subject: [PATCH 316/792] Update the file name and key --- yaml/{base64-file-decode.yaml => base64-decoder.yaml} | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) rename yaml/{base64-file-decode.yaml => base64-decoder.yaml} (99%) diff --git a/yaml/base64-file-decode.yaml b/yaml/base64-decoder.yaml similarity index 99% rename from yaml/base64-file-decode.yaml rename to yaml/base64-decoder.yaml index f725d029a..720f208c7 100644 --- a/yaml/base64-file-decode.yaml +++ b/yaml/base64-decoder.yaml @@ -7,7 +7,7 @@ info: Suggested Use Cases: - As a post-processor for microservices that only outputs Base64 encoded text version: '0.0.1' - x-subscribelink: base64_decode + x-subscribelink: base64_decoder servers: - url: 'https://apis.sentient.io' tags: From a5a47478e80ddb90d9fb0b1d7f73210110a0be41 Mon Sep 17 00:00:00 2001 From: priyaPeristera Date: Mon, 21 Dec 2020 14:00:08 +1100 Subject: [PATCH 317/792] Update file name and key --- yaml/{base64-file-encode.yaml => base64-encoder.yaml} | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) rename yaml/{base64-file-encode.yaml => base64-encoder.yaml} (99%) diff --git a/yaml/base64-file-encode.yaml b/yaml/base64-encoder.yaml similarity index 99% rename from yaml/base64-file-encode.yaml rename to yaml/base64-encoder.yaml index 5e8e1090f..00266a723 100644 --- a/yaml/base64-file-encode.yaml +++ b/yaml/base64-encoder.yaml @@ -7,7 +7,7 @@ info: Suggested Use Cases: - As a pre-processor for microservices that only takes in Base64 inputs version: '0.0.1' - x-subscribelink: base64_encode + x-subscribelink: base64_encoder servers: - url: 'https://apis.sentient.io' tags: From df08b16c49ab08408b51a3e5a1eafefab8a58879 Mon Sep 17 00:00:00 2001 From: Priyadharshini Date: Mon, 11 Jan 2021 16:14:47 +0530 Subject: [PATCH 318/792] latest doc desc update --- yaml/automatic_speech_recognition_chi_sg.yaml | 2 +- yaml/automatic_voice_recognition_eng.yaml | 3 +- yaml/base64-file-decode.yaml | 220 +++++++++++++++ yaml/base64-file-encode.yaml | 237 ++++++++++++++++ yaml/demographics_classification.yaml | 5 +- yaml/face_recognition_v1.0.yaml | 19 +- yaml/landmark_detection_jp_v1.0.yaml | 260 +++++++++++++++++ yaml/landmark_detection_sg_v1.0.yaml | 264 ++++++++++++++++++ yaml/page_profiler_jp.yaml | 8 +- yaml/people_counting_v1.0.yaml | 259 +++++++++++++++++ yaml/text-to-speech_chi.yaml | 2 +- yaml/text-to-speech_eng.yaml | 2 +- yaml/video-to-audio_convertor.yaml | 4 +- yaml/voice_activity_detection_eng_v1.0.yaml | 2 +- 14 files changed, 1269 insertions(+), 18 deletions(-) create mode 100644 yaml/base64-file-decode.yaml create mode 100644 yaml/base64-file-encode.yaml create mode 100644 yaml/landmark_detection_jp_v1.0.yaml create mode 100644 yaml/landmark_detection_sg_v1.0.yaml create mode 100644 yaml/people_counting_v1.0.yaml diff --git a/yaml/automatic_speech_recognition_chi_sg.yaml b/yaml/automatic_speech_recognition_chi_sg.yaml index ea88f5a13..d2b110fc4 100644 --- a/yaml/automatic_speech_recognition_chi_sg.yaml +++ b/yaml/automatic_speech_recognition_chi_sg.yaml @@ -205,7 +205,7 @@ components: default: true example: data:audio/wav;base64,UklGRkbiBABXQVZFZm10IBAAAAABA... description: |+ - Input file in base64 format. + Input audio file in base64 format. Input file needs to be prefixed by the data type and encoding. diff --git a/yaml/automatic_voice_recognition_eng.yaml b/yaml/automatic_voice_recognition_eng.yaml index 9f6dce44b..94fbad094 100644 --- a/yaml/automatic_voice_recognition_eng.yaml +++ b/yaml/automatic_voice_recognition_eng.yaml @@ -197,7 +197,8 @@ components: default: true example: data:audio/wav;base64,UklGRkbiBABXQVZFZm10IBAAAAABA... description: |+ - Input file in base64 format and needs to be prefixed by the data type and encoding + Input audio file in base64 format. It also needs to be prefixed by the data type and encoding. + data:audio/wav;base64, versions: type: object diff --git a/yaml/base64-file-decode.yaml b/yaml/base64-file-decode.yaml new file mode 100644 index 000000000..92842bbc8 --- /dev/null +++ b/yaml/base64-file-decode.yaml @@ -0,0 +1,220 @@ +openapi: 3.0.1 +info: + title: Base64 Decoder + description: |+ + This Utility microservice converts a Base64 encoded text string to a binary file.

For the reverse process (convert binary file to Base64 encoded text string), check out the Base64 File Encode microservice. + x-additionalinfo: |+ + Suggested Use Cases: + - As a post-processor for microservices that only outputs Base64 encoded text + version: '0.0.1' + x-subscribelink: base64_decoder +servers: + - url: 'https://apis.sentient.io' +tags: +- name: "v0.0.1" + description: "Published Date - Oct 30, 2020" +paths: + /microservices/utility/base64decode/v0/getresults: + post: + tags: + - "0.0.1" + responses: + '200': + description: success response + content: + application/json: + schema: + $ref: '#/components/schemas/success' + example: + url: https://storage.googleapis.com/base64decode_dev/24f03729131e469181a2fc22eb3a627a.zip?X-Goog-Algorithm=GOOG4-RSA-SHA256&X-Goog-Credential=sentient-dev-bigquery%40sentient-207310.iam.gserviceaccount.com%2F20201015%2Fa... + message: Successfully Processed + status: Success + '401': + description: Unauthorized + content: + application/json: + schema: + $ref: '#/components/schemas/unauthorized' + '402': + description: Payment Required + content: + application/json: + schema: + $ref: '#/components/schemas/paymentrequired' + '403': + description: Forbidden + content: + application/json: + schema: + $ref: '#/components/schemas/forbidden' + '404': + description: Not Found + content: + application/json: + schema: + $ref: '#/components/schemas/notfound' + '419': + description: Input Field Missing + content: + application/json: + schema: + $ref: '#/components/schemas/inputfieldmissing' + '420': + description: Input Limit Exceeded + content: + application/json: + schema: + $ref: '#/components/schemas/inputlimitexceeded' + '422': + description: Invalid Input + content: + application/json: + schema: + $ref: '#/components/schemas/invalidinput' + '500': + description: Internal Server Error + content: + application/json: + schema: + $ref: '#/components/schemas/servererror' + '504': + description: Gateway Timeout + content: + application/json: + schema: + $ref: '#/components/schemas/gatewaytimeout' + security: + - APIAuthorizer: [] + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/input' + required: true +components: + schemas: + success: + type: object + properties: + message: + type: string + example: Successfully Processed + description: Detail description on the api status + status: + type: string + example: Success + description: The status of the API call success/failure + url: + type: string + example: https://storage.googleapis.com/base64decode/24f03729131e469181a2fc22eb3a627a.zip?X-Goog-Algorithm=GOOG4-RSA-SHA256&X-Goog-Credential=sentient-dev-bigquery%40sentient-207310.iam.gserviceaccount.com%2F20201015%2Fauto%2Fstora... + description: Pre-signed URL to download the file + unauthorized: + type: object + properties: + message: + type: string + example: Missing Authentication Token + status: + type: string + example: Failure + forbidden: + type: object + properties: + message: + type: string + example: Access Denied Unauthorized User + status: + type: string + example: Failure + paymentrequired: + type: object + properties: + message: + type: string + example: Insufficient Credits Kindly Top Up + status: + type: string + example: Failure + notfound: + type: object + properties: + message: + type: string + example: Invalid Request URL + status: + type: string + example: Failure + servererror: + type: object + properties: + message: + type: string + example: Internal Server Error + status: + type: string + example: Failure + gatewaytimeout: + type: object + properties: + message: + type: string + example: Request Timeout + status: + type: string + example: Failure + inputfieldmissing: + type: object + properties: + message: + type: string + example: Input Field Missing + status: + type: string + example: Failure + inputlimitexceeded: + type: object + properties: + message: + type: string + example: Input Limit Exceeded + status: + type: string + example: Failure + invalidinput: + type: object + properties: + message: + type: string + example: Invalid Input + status: + type: string + example: Failure + versions: + type: object + properties: + v0.0.1: + type: array + items: + oneOf: + - type: string + example: Published Date - Oct 30,2020 + description: Initial version release + input: + type: object + required: + - base64 + properties: + base64: + x-name: base64 + type: string + default: true + example: UklGRoboDgBXQVZFZm10IBAAAAABAAEAgD4AAAB9AAACABAATElTVBoAAABJTkZPSVNGVA4AAABMYXZmNTguMjAuMTAwAGRhdGFA6A4AAAAAAAAAAAAAAAAAAAAAAAAA... + description: |+ + Input a base64 encoded string. + securitySchemes: + APIAuthorizer: + type: apiKey + name: x-api-key + in: header + x-amazon-apigateway-authtype: custom + description: Authentication is done using the x-api-key in the request header diff --git a/yaml/base64-file-encode.yaml b/yaml/base64-file-encode.yaml new file mode 100644 index 000000000..932e76d0b --- /dev/null +++ b/yaml/base64-file-encode.yaml @@ -0,0 +1,237 @@ +openapi: 3.0.1 +info: + title: Base64 Encoder + description: |+ + This Utility microservice converts an uploaded file to Base64 encoded text (also known as a binary file to text converter). This microservice supports most documents, images, audio, video, archive and font files. See documentation for the detailed list of supported file formats.

User can choose the output base64 text string in 5 different formats (plain text, JSON, hyperlink, datauri, XML).

For the reverse process (converting Base64 string back to binary file), check out the Base 64 File Decode microservice. + x-additionalinfo: |+ + Suggested Use Cases: + - As a pre-processor for microservices that only takes in Base64 inputs + version: '0.0.1' + x-subscribelink: base64_encoder +servers: + - url: 'https://apis.sentient.io' +tags: +- name: "v0.0.1" + description: "Published Date - Oct 30, 2020" +paths: + /microservices/utility/base64encode/v0/getresults: + post: + tags: + - v0.0.1 + responses: + '200': + description: success response + content: + application/json: + schema: + $ref: '#/components/schemas/success' + example: + results: + base64: /9j/4AAQSkZJRgABAQAAAQABAAD/2wCEAAMCAggIBQUICAUGBQUGBgYGBgUFBQYGBgYGBgYGBgYGBgYGBQYGBgYGBgYGBgoGBgcICQkJBgYLDgoIDQYICQgBAwQEBgUGCAYGCAgHBwcICAgICAgBAABAgMFBgcECP.... + message: Successfully Processed + status: Success + '401': + description: Unauthorized + content: + application/json: + schema: + $ref: '#/components/schemas/unauthorized' + '402': + description: Payment Required + content: + application/json: + schema: + $ref: '#/components/schemas/paymentrequired' + '403': + description: Forbidden + content: + application/json: + schema: + $ref: '#/components/schemas/forbidden' + '404': + description: Not Found + content: + application/json: + schema: + $ref: '#/components/schemas/notfound' + '419': + description: Input Field Missing + content: + application/json: + schema: + $ref: '#/components/schemas/inputfieldmissing' + '420': + description: Input Limit Exceeded + content: + application/json: + schema: + $ref: '#/components/schemas/inputlimitexceeded' + '422': + description: Invalid Input + content: + application/json: + schema: + $ref: '#/components/schemas/invalidinput' + '500': + description: Internal Server Error + content: + application/json: + schema: + $ref: '#/components/schemas/servererror' + '504': + description: Gateway Timeout + content: + application/json: + schema: + $ref: '#/components/schemas/gatewaytimeout' + security: + - APIAuthorizer: [] + requestBody: + description: Input parameters

FieldType Description
filePathFileRequired. The file object
typeStringOptional. type of return data as xml/hyperlink/json/datauri/plaintext. plaintext is default if none selected


+ content: + multipart/form-data: + schema: + $ref: '#/components/schemas/input' + # required: true +components: + schemas: + success: + type: object + properties: + results: + type: object + example: { "" } + description: Json Object of returned results + properties: + base64: + type: string + description: Base64 encoded text converted to the requested output format. + example: /9j/4AAQSkZJRgABAQAAAQABAAD/2wCEAAMCAggIBQUICAUGBQUGBgYGBgUFBQYGBgYGBgYGBgYGBgYGBQYGBgYGBgYGBgoGBgcICQkJBgYLDgoIDQYICQgBAwQEBgUGCAYGCAgHBwcICAgICAgBAABAgMFBgcECP.... + message: + type: string + example: Successfully Processed + description: Detail description on the API status + status: + type: string + example: Success + description: The status of the API call success/failure + unauthorized: + type: object + properties: + message: + type: string + example: Missing Authentication Token + status: + type: string + example: Failure + forbidden: + type: object + properties: + message: + type: string + example: Access Denied Unauthorized User + status: + type: string + example: Failure + paymentrequired: + type: object + properties: + message: + type: string + example: Insufficient Credits Kindly Top Up + status: + type: string + example: Failure + notfound: + type: object + properties: + message: + type: string + example: Invalid Request URL + status: + type: string + example: Failure + servererror: + type: object + properties: + message: + type: string + example: Internal Server Error + status: + type: string + example: Failure + gatewaytimeout: + type: object + properties: + message: + type: string + example: Request Timeout + status: + type: string + example: Failure + inputfieldmissing: + type: object + properties: + message: + type: string + example: Input Field Missing + status: + type: string + example: Failure + inputlimitexceeded: + type: object + properties: + message: + type: string + example: Input Limit Exceeded + status: + type: string + example: Failure + invalidinput: + type: object + properties: + message: + type: string + example: Invalid Input + status: + type: string + example: Failure + input: + type: object + required: + - filePath + properties: + filePath: + type: string + format: binary + example: sample.txt + default: true + description: The file object. + format: + type: string + example: "xml" + default: false + description: |+ + The output format. Possible values are: + 1. plaintext (default) + 2. json + 3. hyperlink + 4. datauri + 5. xml + versions: + type: object + properties: + v0.0.1: + type: array + items: + oneOf: + - type: string + example: Published Date - Oct 30, 2020 + description: Initial version release + securitySchemes: + APIAuthorizer: + type: apiKey + name: x-api-key + in: header + x-amazon-apigateway-authtype: custom + description: Authentication is done using the x-api-key in the request header diff --git a/yaml/demographics_classification.yaml b/yaml/demographics_classification.yaml index b61e9106e..9eb789d16 100644 --- a/yaml/demographics_classification.yaml +++ b/yaml/demographics_classification.yaml @@ -4,6 +4,9 @@ info: description: |+ This Computer Vision microservice detects for faces from an input image and predicts the demographics of each face (age, gender and race). The image is given as an input encoded using base64. The microservice will a face detector and subsequently models to predict age, gender and race. The results will then be returned back to the user as a JSON output together with bounding box coordinates for each face.Races include: Asian, Indian, White, Black, Middle Eastern and Latino Hispanic The size of your image file should **not exceed 5 MB**, and the image dimension should be **at least 416x416 pixels**. + x-additionalinfo: |+ + Suggested Use Cases: + - This microservice can be used as a solution to help businesses better understand and connect with their customers, engage new prospects and increase revenue. For example, it can be used to improve visitor experience and optimize operations in retail, leisure, and other sectors by identifying the type of demogrpahic that frequents a certain place the most. It can also be used to create intelligent prospect lists that ensure one is always maximizing their marketing investment. version: v0.1.0 x-subscribelink: demographics_classification servers: @@ -278,7 +281,7 @@ components: default: True example: /9j/4AAQSkZJRgABAQEASABIAAD/2wBDAAMCAgMCAgMDAwMEAwMEBQgFBQQEBQoHBwYIDAoMDAsKCwsNDhIQDQ4RDgsLEBYQERMUFRUVDA8XGBYUG... description: |+ - input image's base64 string representation + Input image file in base64 format. securitySchemes: diff --git a/yaml/face_recognition_v1.0.yaml b/yaml/face_recognition_v1.0.yaml index be5aacab7..05981350a 100644 --- a/yaml/face_recognition_v1.0.yaml +++ b/yaml/face_recognition_v1.0.yaml @@ -7,7 +7,7 @@ info: This microservice returns the identity of the person, the bounding box in image coordinates, and the confidence of the prediction. Users can further filter the results by countries, profession or even down to the individual names. Help us grow this microservice! [Let us know](https://www.sentient.io/contact) which other public figures you would like us this microservice to also recognise (e.g. a new country or a new category). We will expand the capability of this microservices based on user feedback and demand. - version: '1.0.0' + version: '1.0.1' x-additionalinfo: |+ **Full List of Filters** Users may choose to filter the output using any of these filters below. @@ -63,15 +63,15 @@ info: x-subscribelink: face_recognition servers: - - url: 'https://apis.sentient.io' + - url: 'https://dev-apis.sentient.io' tags: -- name: "v1.0.0" - description: "Published Date - Dec 09, 2020" +- name: "v1.0.1" + description: "Published Date - Jan 08, 2021" paths: /microservices/cv/facerecognition/v1/getpredictions: post: tags: - - v1.0.0 + - v1.0.1 responses: '200': description: success response @@ -283,6 +283,13 @@ components: versions: type: object properties: + v1.0.1: + type: array + items: + oneOf: + - type: string + example: Published Date - Jan 08, 2021 + description: Bug fix - Threshold value v1.0.0: type: array items: @@ -310,7 +317,7 @@ components: default: true example: UklGRkbiBABXQVZFZm10IBAAAAABA... description: |+ - Input image file in base64 format + Input image file in base64 format. file_type: x-name: file_type type: string diff --git a/yaml/landmark_detection_jp_v1.0.yaml b/yaml/landmark_detection_jp_v1.0.yaml new file mode 100644 index 000000000..e0e2a920e --- /dev/null +++ b/yaml/landmark_detection_jp_v1.0.yaml @@ -0,0 +1,260 @@ +openapi: 3.0.1 +info: + title: Landmark Detection (JP) + description: |+ + This Computer Vision microservice identifies Japan landmarks from multiple input images. + + The microservice returns the detected landmark and confidence score. + + The size of your image file should **not exceed 5 MB**. + x-additionalinfo: |+ + Suggested Use Cases: + - Can be used for geo-targeting apps with map feature or property development planning resource apps. + version: '1.0.0' + x-subscribelink: landmark_detection_jp +servers: + - url: 'https://dev-apis.sentient.io' +tags: +- name: "v1.0.0" + description: "Published Date - Dec 31, 2020" +paths: + /microservices/cv/landmarkjp/v1/getpredictions: + post: + tags: + - v1.0.0 + responses: + '200': + description: success response + content: + application/json: + schema: + $ref: '#/components/schemas/success' + example: + results: + confidence: 100% + landmark: Gion + message: Successfully Processed + status: Success + '401': + description: Unauthorized + content: + application/json: + schema: + $ref: '#/components/schemas/unauthorized' + '402': + description: Payment Required + content: + application/json: + schema: + $ref: '#/components/schemas/paymentrequired' + '403': + description: Forbidden + content: + application/json: + schema: + $ref: '#/components/schemas/forbidden' + '404': + description: Not Found + content: + application/json: + schema: + $ref: '#/components/schemas/notfound' + '419': + description: Input Field Missing + content: + application/json: + schema: + $ref: '#/components/schemas/inputfieldmissing' + '420': + description: Input Limit Exceeded + content: + application/json: + schema: + $ref: '#/components/schemas/inputlimitexceeded' + '422': + description: Invalid Input + content: + application/json: + schema: + $ref: '#/components/schemas/invalidinput' + '500': + description: Internal Server Error + content: + application/json: + schema: + $ref: '#/components/schemas/servererror' + '504': + description: Gateway Timeout + content: + application/json: + schema: + $ref: '#/components/schemas/gatewaytimeout' + security: + - APIAuthorizer: [] + + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/input' + required: true + + +components: + schemas: + success: + type: object + properties: + results: + type: object + description: The result of the API call. + example: { "" } + properties: + confidence: + x-name: confidence + type: string + example: 100% + description: Confidence score of identification. Higher is more confidence. + landmark: + x-name: landmark + type: string + example: Gion + description: Name of the landmark + message: + type: string + example: Successfully Processed + description: Detail description on the API status + status: + type: string + example: Success + description: The status of the API call success/failure + + + + unauthorized: + type: object + properties: + message: + type: string + example: Missing Authentication Token + status: + type: string + example: Failure + restricted: + type: object + properties: + message: + type: string + example: The content is restricted + status: + type: string + example: Failure + forbidden: + type: object + properties: + message: + type: string + example: Access Denied Unauthorized User + status: + type: string + example: Failure + paymentrequired: + type: object + properties: + message: + type: string + example: Insufficient Credits Kindly Top Up + status: + type: string + example: Failure + notfound: + type: object + properties: + message: + type: string + example: Invalid Request + status: + type: string + example: Failure + servererror: + type: object + properties: + message: + type: string + example: Internal Server Error + status: + type: string + example: Failure + gatewaytimeout: + type: object + properties: + message: + type: string + example: Request Timeout + status: + type: string + example: Failure + inputfieldmissing: + type: object + properties: + message: + type: string + example: Input Field Missing + status: + type: string + example: Failure + inputlimitexceeded: + type: object + properties: + message: + type: string + example: Input Limit Exceeded + status: + type: string + example: Failure + invalidinput: + type: object + properties: + message: + type: string + example: Invalid Input + status: + type: string + example: Failure + versions: + type: object + properties: + v1.0.0: + type: array + items: + oneOf: + - type: string + example: Published Date - Dec 31, 2020 + description: Standardizing Output JSON + v0.1.0: + type: array + items: + oneOf: + - type: string + example: Published Date - Jul 30,2020 + description: Initial version release + input: + type: object + properties: + image_base64: + x-name: image_base64 + type: string + default: true + example: UklGRkbiBABXQVZFZm10IBAAAAABA... + description: |+ + Input image file in base64 format. + + Supported formats: blp, bmp, bufr, cur, dcx, dds, dib, eps, ps, fit, fits, flc, fli, fpx, ftc, ftu, gbr, gif, grib, h5, hd5, icns, ico, im, iim, jpeg, jp2, mic, mpeg, msp, pcd, pcx, pxr, png, ppm, psd, sgi, ras, tga, tiff, wmf, xbm, xpm. + + securitySchemes: + APIAuthorizer: + type: apiKey + name: x-api-key + in: header + x-amazon-apigateway-authtype: custom + description: Authentication is done using the x-api-key in the request header diff --git a/yaml/landmark_detection_sg_v1.0.yaml b/yaml/landmark_detection_sg_v1.0.yaml new file mode 100644 index 000000000..13f03ef47 --- /dev/null +++ b/yaml/landmark_detection_sg_v1.0.yaml @@ -0,0 +1,264 @@ +openapi: 3.0.1 +info: + title: Landmark Detection (SG) + description: |+ + This Computer Vision microservice identifies Singapore landmarks from multiple input images. + + This microservice returns the detected landmark and confidence score. + + The size of your image file should **not exceed 5 MB**. + x-additionalinfo: |+ + Suggested Use Cases: + - Can be used for geo-targeting apps with map feature or property development planning resource apps. + version: '1.0.0' + x-subscribelink: landmark_detection_sg +servers: + - url: 'https://dev-apis.sentient.io' +tags: +- name: "v1.0.0" + description: "Published Date - Dec 31, 2020" +paths: + /microservices/cv/landmarksg/v1/getpredictions: + post: + tags: + - v1.0.0 + + responses: + '200': + description: success response + content: + application/json: + schema: + $ref: '#/components/schemas/success' + example: + results: + confidence: 100% + landmark: Artscience Museum + message: Successfully Processed + status: Success + + '401': + description: Unauthorized + content: + application/json: + schema: + $ref: '#/components/schemas/unauthorized' + '402': + description: Payment Required + content: + application/json: + schema: + $ref: '#/components/schemas/paymentrequired' + '403': + description: Forbidden + content: + application/json: + schema: + $ref: '#/components/schemas/forbidden' + '404': + description: Not Found + content: + application/json: + schema: + $ref: '#/components/schemas/notfound' + '419': + description: Input Field Missing + content: + application/json: + schema: + $ref: '#/components/schemas/inputfieldmissing' + '420': + description: Input Limit Exceeded + content: + application/json: + schema: + $ref: '#/components/schemas/inputlimitexceeded' + '422': + description: Invalid Input + content: + application/json: + schema: + $ref: '#/components/schemas/invalidinput' + '500': + description: Internal Server Error + content: + application/json: + schema: + $ref: '#/components/schemas/servererror' + '504': + description: Gateway Timeout + content: + application/json: + schema: + $ref: '#/components/schemas/gatewaytimeout' + security: + - APIAuthorizer: [] + + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/input' + required: true + + +components: + schemas: + success: + type: object + properties: + results: + type: object + description: The result of the API call. + example: { "" } + properties: + confidence: + x-name: confidence + type: string + example: 100% + description: Confidence score of identification. Higher is more confidence. + landmark: + x-name: landmark + type: string + example: Artscience Museum + description: Name of the landmark + message: + type: string + example: Successfully Processed + description: Detail description on the API status + status: + type: string + example: Success + description: The status of the API call success/failure + + + + unauthorized: + type: object + properties: + message: + type: string + example: Missing Authentication Token + status: + type: string + example: Failure + restricted: + type: object + properties: + message: + type: string + example: The content is restricted + status: + type: string + example: Failure + forbidden: + type: object + properties: + message: + type: string + example: Access Denied Unauthorized User + status: + type: string + example: Failure + paymentrequired: + type: object + properties: + message: + type: string + example: Insufficient Credits Kindly Top Up + status: + type: string + example: Failure + notfound: + type: object + properties: + message: + type: string + example: Invalid Request + status: + type: string + example: Failure + servererror: + type: object + properties: + message: + type: string + example: Internal Server Error + status: + type: string + example: Failure + gatewaytimeout: + type: object + properties: + message: + type: string + example: Request Timeout + status: + type: string + example: Failure + inputfieldmissing: + type: object + properties: + message: + type: string + example: Input Field Missing + status: + type: string + example: Failure + inputlimitexceeded: + type: object + properties: + message: + type: string + example: Input Limit Exceeded + status: + type: string + example: Failure + invalidinput: + type: object + properties: + message: + type: string + example: Invalid Input + status: + type: string + example: Failure + versions: + type: object + properties: + v1.0.0: + type: array + items: + oneOf: + - type: string + example: Published Date - Dec 31, 2020 + description: Standardizing Output JSON + v0.1.0: + type: array + items: + oneOf: + - type: string + example: Published Date - Jul 30,2020 + description: Initial version release + input: + type: object + required: + - image_base64 + properties: + image_base64: + x-name: image_base64 + type: string + default: true + example: UklGRkbiBABXQVZFZm10IBAAAAABA... + description: |+ + Input image file in base64 format. + + Supported formats: blp, bmp, bufr, cur, dcx, dds, dib, eps, ps, fit, fits, flc, fli, fpx, ftc, ftu, gbr, gif, grib, h5, hd5, icns, ico, im, iim, jpeg, jp2, mic, mpeg, msp, pcd, pcx, pxr, png, ppm, psd, sgi, ras, tga, tiff, wmf, xbm, xpm. + + securitySchemes: + APIAuthorizer: + type: apiKey + name: x-api-key + in: header + x-amazon-apigateway-authtype: custom + description: Authentication is done using the x-api-key in the request header diff --git a/yaml/page_profiler_jp.yaml b/yaml/page_profiler_jp.yaml index bbcb12dd0..d6180b42d 100644 --- a/yaml/page_profiler_jp.yaml +++ b/yaml/page_profiler_jp.yaml @@ -126,22 +126,22 @@ x-name: Company type: array example: [ 和歌山製鉄所 ] - description: name of Company found in the text string + description: name of company found in the text string Date: x-name: Date type: array example: [ 7日,2023年9月,22年9月 ] - description: name of Date found in the text string + description: name of date found in the text string Domestic_Region: x-name: Domestic_Region type: array example: [ 呉製鉄所 ] - description: name of Domestic_Region found in the text string + description: name of domestic_region found in the text string Material: x-name: Material type: array example: [ 鉄鋼最大手 ] - description: name of Material found in the text string + description: name of material found in the text string message: type: string example: Successfully Processed diff --git a/yaml/people_counting_v1.0.yaml b/yaml/people_counting_v1.0.yaml new file mode 100644 index 000000000..bf40d0cc3 --- /dev/null +++ b/yaml/people_counting_v1.0.yaml @@ -0,0 +1,259 @@ +openapi: 3.0.1 +info: + title: People Counting + description: |+ + This Computer Vision microservice tracks and counts people appearing in the input video. + + This microservice returns the number of people detected in that video, the likelihood of overestimation/underestimation, the first appearance and the duration and confidence of each person detected. + + The size of your image file should **not exceed 10 MB**, and the image dimension should be **least more than 416x416 pixels**. + x-additionalinfo: |+ + Suggested Use Cases: + - Improve visitor experience and optimize operations in retail, leisure, and other sectors - build services to count visitor traffic in venues, measure detailed movements and interactions, and visualize that data to better understand what is happening in within a certain spaces. For example, one can optimize traffic, staff and marketing strategies to increase conversion rates and profits with actionable data. Businesses can use visitor count as a benchmark to figure out the conversion rate for a certain spot to see the real performance. Efficiently allocating the number of staff according to hourly visitor traffic will also create value in terms of revenue, profit and  efficiency. + version: '1.0.0' + x-subscribelink: people_counting +servers: + - url: 'https://dev-apis.sentient.io' +tags: +- name: "v1.0.0" + description: "Published Date - Dec 31, 2020" +paths: + /microservices/cv/peoplecounting/v1/getpredictions: + post: + tags: + - v1.0.0 + + responses: + '200': + description: success response + content: + application/json: + schema: + $ref: '#/components/schemas/success' + example: {"results": {"counter": 11, "likelihood of overestimation": 0.76,"likelihood of underestimation": 0.39,"people": [{"assigning confidence": 1,"bounding boxes": {"frame": {"294": {"bottom": 420,"left": 249,"right": 417,"top": 207},"300": {"bottom": 420,"left": 249,"right": 417,"top": 207}}},"detection confidence": 0.76,"duration appeared": 0.20689655172413793,"first appearance": 10.137931034482758,"person id": "011"}]},"message": "Successfully Processed","status": "Success"} + '401': + description: Unauthorized + content: + application/json: + schema: + $ref: '#/components/schemas/unauthorized' + '402': + description: Payment Required + content: + application/json: + schema: + $ref: '#/components/schemas/paymentrequired' + '403': + description: Forbidden + content: + application/json: + schema: + $ref: '#/components/schemas/forbidden' + '404': + description: Not Found + content: + application/json: + schema: + $ref: '#/components/schemas/notfound' + '419': + description: Input Field Missing + content: + application/json: + schema: + $ref: '#/components/schemas/inputfieldmissing' + '420': + description: Input Limit Exceeded + content: + application/json: + schema: + $ref: '#/components/schemas/inputlimitexceeded' + '422': + description: Invalid Input + content: + application/json: + schema: + $ref: '#/components/schemas/invalidinput' + '500': + description: Internal Server Error + content: + application/json: + schema: + $ref: '#/components/schemas/servererror' + '504': + description: Gateway Timeout + content: + application/json: + schema: + $ref: '#/components/schemas/gatewaytimeout' + security: + - APIAuthorizer: [] + + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/input' + required: true + + +components: + schemas: + success: + type: object + properties: + results: + type: object + description: The result of the API call. + example: { "" } + properties: + counter: + type: integer + example: 11 + description: Number of people detected in video + likelihood of overestimation: + type: number + format: float + example: 0.76 + description: How likely would there be ID spikes causing counter to increase People + likelihood of underestimation: + type: number + format: float + example: 0.39 + description: How likely the model might miss out detecting people in the video + people: + type: array + example: [{'person id': "001",'first appearance': 1.28, 'duration appeared': 7.66, 'detection confidence': 0.77, 'assigning confidence': 1,"bounding boxes": {"frame": {"294": {"bottom": 420,"left": 249,"right": 417,"top": 207},"300": {"bottom": 420,"left": 249,"right": 417,"top": 207}}}}] + description: Contains a list of individual Persons and their metadata. + items: + oneOf: + - type: object + example: {'person id': "001",'first appearance': 1.28, 'duration appeared': 7.66, 'detection confidence': 0.77, 'assigning confidence': 1,"bounding boxes": {"frame": {"294": {"bottom": 420,"left": 249,"right": 417,"top": 207},"300": {"bottom": 420,"left": 249,"right": 417,"top": 207}}}} + unauthorized: + type: object + properties: + message: + type: string + example: Missing Authentication Token + status: + type: string + example: Failure + restricted: + type: object + properties: + message: + type: string + example: The content is restricted + status: + type: string + example: Failure + forbidden: + type: object + properties: + message: + type: string + example: Access Denied Unauthorized User + status: + type: string + example: Failure + paymentrequired: + type: object + properties: + message: + type: string + example: Insufficient Credits Kindly Top Up + status: + type: string + example: Failure + invalidinput: + type: object + properties: + message: + type: string + example: Invalid Input + status: + type: string + example: Failure + notfound: + type: object + properties: + message: + type: string + example: Invalid Request + status: + type: string + example: Failure + servererror: + type: object + properties: + message: + type: string + example: Internal Server Error + status: + type: string + example: Failure + gatewaytimeout: + type: object + properties: + message: + type: string + example: Request Timeout + status: + type: string + example: Failure + inputfieldmissing: + type: object + properties: + message: + type: string + example: Input Field Missing + status: + type: string + example: Failure + inputlimitexceeded: + type: object + properties: + message: + type: string + example: Input Limit Exceeded + status: + type: string + example: Failure + versions: + type: object + properties: + v1.0.0: + type: array + items: + oneOf: + - type: string + example: Published Date - Dec 31, 2020 + description: Standardizing Output JSON + v0.1.0: + type: array + items: + oneOf: + - type: string + example: Published Date - Jul 30,2020 + description: Initial version release + input: + type: object + required: + - video_base64 + properties: + video_base64: + x-name: video_base64 + type: string + default: true + example: UklGRkbiBABXQVZFZm10IBAAAAABA... + description: |+ + Input video file in base64 format. + + Supported formats: acm, anm, apc, au, avi, bfi, bmp_pipe, bmv, codec2, dsf, dss, dvd, fifo, genh, gif, gxf, hls, iff, ifv, ipod, jpeg_pipe, jv, m4v, mjpeg, mlp, mlv, mov, mp2, mp3, mp4, pbm_pipe, pmp, png_pipe, psd_pipe, psp, rawvideo, sdp, sds, sdx, tmv, uncodedframecrc, vcd, vidc, vmd, voc, vpk, wav, webm, wsd, wsvqa, wtv, xmv, xpm_pipe. + + securitySchemes: + APIAuthorizer: + type: apiKey + name: x-api-key + in: header + x-amazon-apigateway-authtype: custom + description: Authentication is done using the x-api-key in the request header diff --git a/yaml/text-to-speech_chi.yaml b/yaml/text-to-speech_chi.yaml index 34f42b2af..cf0a2c52a 100644 --- a/yaml/text-to-speech_chi.yaml +++ b/yaml/text-to-speech_chi.yaml @@ -115,7 +115,7 @@ components: audioContent: type: string example: UklGRiQAAABXQVZFZm10IBAAAAABAAEAgD4AAAB9AAACABAAZGF0YQAAAAA= - description: Audio wav file convert to base64 encode string + description: Audio file converted to base64 encoded string. unauthorized: type: object properties: diff --git a/yaml/text-to-speech_eng.yaml b/yaml/text-to-speech_eng.yaml index 42d47b6ee..1f1eafc1b 100644 --- a/yaml/text-to-speech_eng.yaml +++ b/yaml/text-to-speech_eng.yaml @@ -234,7 +234,7 @@ components: audioContent: type: string example: UklGRiQAAABXQVZFZm10IBAAAAABAAEAgD4AAAB9AAACABAAZGF0YQAAAAA= - description: Audio wav file convert to base64 encode string + description: Audio file converted to base64 encoded string. unauthorized: type: object properties: diff --git a/yaml/video-to-audio_convertor.yaml b/yaml/video-to-audio_convertor.yaml index 297a5c729..f7e88c519 100644 --- a/yaml/video-to-audio_convertor.yaml +++ b/yaml/video-to-audio_convertor.yaml @@ -107,7 +107,7 @@ components: properties: AudioContent: type: string - description: Audio wav file convert to base64 encode string + description: Audio file converted to base64 encoded string. example: UklGRoboDgBXQVZFZm10IBAAAAABAAEAgD4AAAB9AAACABAATElTVBoAAABJTkZPSVNGVA4AAABMYXZmNTguMjAuMTAwAGRhdGFA6A4AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA.... message: type: string @@ -214,7 +214,7 @@ components: type: string example: "16000" default: false - description: Sample rate of the audio file in Hz + description: Sample rate of the audio file in Hz. That there is no set Hz range. Note that decimals and negative values are not supported. channel: type: string example: "1" diff --git a/yaml/voice_activity_detection_eng_v1.0.yaml b/yaml/voice_activity_detection_eng_v1.0.yaml index 63e4a4f72..08a68e644 100644 --- a/yaml/voice_activity_detection_eng_v1.0.yaml +++ b/yaml/voice_activity_detection_eng_v1.0.yaml @@ -230,7 +230,7 @@ components: default: true example: UklGRkbiBABXQVZFZm10IBAAAAABA... description: |+ - Required. Input audio file in base64 format + Required. Input audio file in base64 format. threshold: x-name: threshold type: number From e9c6d4480f9e218c400fa7d2c02cf6fd7bc7f0ae Mon Sep 17 00:00:00 2001 From: Priyadharshini Date: Mon, 11 Jan 2021 17:55:55 +0530 Subject: [PATCH 319/792] latest doc --- yaml/face_recognition_v1.0.yaml | 2 +- yaml/wikipedia_retrieval_v1.0.yaml | 342 +++++++++++++++++++++++++++++ 2 files changed, 343 insertions(+), 1 deletion(-) create mode 100644 yaml/wikipedia_retrieval_v1.0.yaml diff --git a/yaml/face_recognition_v1.0.yaml b/yaml/face_recognition_v1.0.yaml index 05981350a..2aa7ce266 100644 --- a/yaml/face_recognition_v1.0.yaml +++ b/yaml/face_recognition_v1.0.yaml @@ -63,7 +63,7 @@ info: x-subscribelink: face_recognition servers: - - url: 'https://dev-apis.sentient.io' + - url: 'https://apis.sentient.io' tags: - name: "v1.0.1" description: "Published Date - Jan 08, 2021" diff --git a/yaml/wikipedia_retrieval_v1.0.yaml b/yaml/wikipedia_retrieval_v1.0.yaml new file mode 100644 index 000000000..cb1fe3934 --- /dev/null +++ b/yaml/wikipedia_retrieval_v1.0.yaml @@ -0,0 +1,342 @@ +openapi: 3.0.1 +info: + title: Wikipedia Retrieval + description: |+ + It is an API that provides the user with a Wikipedia article based on the input keyword. Refer to this link for the full list of Wikipedias - https://meta.wikimedia.org/wiki/List_of_Wikipedias + x-additionalinfo: |+ + Suggested Use Cases: + - Access topics within Wikipedia with great specificity. Can be used for research/study-related solutions by using information from this microservice to compare articles, revisions and more. + + - Extract the most relevant content from Wikipedia’s categories to provide a text analysis service to ascertain what any text is in reference to. + version: '1.0.0' + x-subscribelink: wikipedia_retrieval +servers: + - url: 'https://apis.sentient.io' +tags: +- name: "v1.0.0" + description: "Published Date - Jan 10, 2021" +paths: + /microservices/utility/wikipedia/v1/getresults: + post: + tags: + - v1.0.0 + responses: + '200': + description: success response + content: + application/json: + schema: + $ref: '#/components/schemas/success' + example: + results: + content: Singapore officially the Republic of Singapore, is a sovereign city-state + and island country located in maritime Southeast Asia. Singapore lies about one + degree of latitude (137 kilometres or 85 miles) north of the equator. + images: + - https://upload.wikimedia.org/wikipedia/commons/f/f5/0008871_-_Krung_Thep_Bridge_001.jpg + - https://upload.wikimedia.org/wikipedia/commons/1/12/2014_Singapore_Products_Export_Treemap.png + - https://upload.wikimedia.org/wikipedia/commons/1/1b/2017_G20_Hamburg_summit_leaders_group_photo.jpg + - https://upload.wikimedia.org/wikipedia/commons/1/10/A_Night_Perspective_on_the_Singapore_Merlion_%288347645113%29.jpg + links: + - 65 + - ".sg" + - 126 Squadron, Republic of Singapore Air Force + - 13th Parliament of Singapore + - 16th Summit of the Non-Aligned Movement + - 1915 Singapore Mutiny + pageid: 27318 + summary: Singapore officially the Republic of Singapore, is a sovereign city-state + and island country located in maritime Southeast Asia. Singapore lies about one + degree of latitude (137 kilometres or 85 miles) north of the equator. + thumbnail: + height: 333 + source: https://upload.wikimedia.org/wikipedia/commons/thumb/4/48/Flag_of_Singapore.svg/500px-Flag_of_Singapore.svg.png + width: 500 + url: https://en.wikipedia.org/wiki/Singapore + message: Successfully Processed + status: Success + '401': + description: Unauthorized + content: + application/json: + schema: + $ref: '#/components/schemas/unauthorized' + '402': + description: Payment Required + content: + application/json: + schema: + $ref: '#/components/schemas/paymentrequired' + '403': + description: Forbidden + content: + application/json: + schema: + $ref: '#/components/schemas/forbidden' + '404': + description: Not Found + content: + application/json: + schema: + $ref: '#/components/schemas/notfound' + '419': + description: Input Field Missing + content: + application/json: + schema: + $ref: '#/components/schemas/inputfieldmissing' + '420': + description: Input Limit Exceeded + content: + application/json: + schema: + $ref: '#/components/schemas/inputlimitexceeded' + '422': + description: Invalid Input + content: + application/json: + schema: + $ref: '#/components/schemas/invalidinput' + '500': + description: Internal Server Error + content: + application/json: + schema: + $ref: '#/components/schemas/servererror' + '504': + description: Gateway Timeout + content: + application/json: + schema: + $ref: '#/components/schemas/gatewaytimeout' + security: + - APIAuthorizer: [] + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/input' + required: true +components: + schemas: + success: + type: object + properties: + results: + type: object + example: { "" } + description: Json Object of returned results + properties: + content: + type: string + example: "Singapore officially the Republic of Singapore, is a sovereign city-state and island country located in maritime Southeast Asia. + Singapore lies about one degree of latitude (137 kilometres or 85 miles) north of the equator." + description: Plain text content of the page, excluding images, tables, and other data. + images: + type: array + example: ["https://upload.wikimedia.org/wikipedia/commons/f/f5/0008871_-_Krung_Thep_Bridge_001.jpg","https://upload.wikimedia.org/wikipedia/commons/1/12/2014_Singapore_Products_Export_Treemap.png"] + description: List of URLs of images on the page. + items: + oneOf: + - type: string + format: list + example: https://upload.wikimedia.org/wikipedia/commons/f/f5/0008871_-_Krung_Thep_Bridge_001.jpg + - type: string + format: list + example: https://upload.wikimedia.org/wikipedia/commons/1/12/2014_Singapore_Products_Export_Treemap.png + - type: string + format: list + example: https://upload.wikimedia.org/wikipedia/commons/1/1b/2017_G20_Hamburg_summit_leaders_group_photo.jpg + - type: string + format: list + example: https://upload.wikimedia.org/wikipedia/commons/1/10/A_Night_Perspective_on_the_Singapore_Merlion_%288347645113%29.jpg + links: + type: array + example: [".sg","126 Squadron, Republic of Singapore Air Force","13th Parliament of Singapore","16th Summit of the Non-Aligned Movement"] + description: List of titles of Wikipedia page links on a page. + items: + oneOf: + - type: string + format: list + example: +65 + - type: string + format: list + example: .sg + - type: string + format: list + example: 126 Squadron, Republic of Singapore Air Force + - type: string + format: list + example: 13th Parliament of Singapore + - type: string + format: list + example: 16th Summit of the Non-Aligned Movement + - type: string + format: list + example: 1915 Singapore Mutiny + pageid: + type: integer + example: 27318 + description: The id of the page requested + summary: + type: string + example: Singapore officially the Republic of Singapore, is a sovereign city-state and island country located in maritime Southeast Asia. + Singapore lies about one degree of latitude (137 kilometres or 85 miles) north of the equator. + description: A short summary of the Wikipedia article that was requested + thumbnail: + type: object + example: {"height":333,"source":"https://upload.wikimedia.org/wikipedia/commons/thumb/4/48/Flag_of_Singapore.svg/500px-Flag_of_Singapore.svg.png", "width":500} + description: URL and dimensions of thumbnail image associated with page, if any. + properties: + height: + type: string + example: 333 + description: Height of the thumbnail image + source: + type: string + example: https://upload.wikimedia.org/wikipedia/commons/thumb/4/48/Flag_of_Singapore.svg/500px-Flag_of_Singapore.svg.png + description: Source URL of the thumbnail image + width: + type: string + example: 500 + description: Width of the thumbnail image + url: + type: string + example: https://en.wikipedia.org/wiki/Singapore + description: The website url of the requested wikipedia articles + message: + type: string + example: Successfully Processed + description: Detail description on the API status + status: + type: string + example: Success + description: The status of the API call success/failure + unauthorized: + type: object + properties: + message: + type: string + example: Missing Authentication Token + status: + type: string + example: Failure + forbidden: + type: object + properties: + message: + type: string + example: Access Denied Unauthorized User + status: + type: string + example: Failure + paymentrequired: + type: object + properties: + message: + type: string + example: Insufficient Credits Kindly Top Up + status: + type: string + example: Failure + invalidinput: + type: object + properties: + message: + type: string + example: Invalid Input + status: + type: string + example: Failure + notfound: + type: object + properties: + message: + type: string + example: Invalid Request URL + status: + type: string + example: Failure + servererror: + type: object + properties: + message: + type: string + example: Internal Server Error + status: + type: string + example: Failure + gatewaytimeout: + type: object + properties: + message: + type: string + example: Request Timeout + status: + type: string + example: Failure + inputfieldmissing: + type: object + properties: + message: + type: string + example: Input Field Missing + status: + type: string + example: Failure + inputlimitexceeded: + type: object + properties: + message: + type: string + example: Input Limit Exceeded + status: + type: string + example: Failure + versions: + type: object + properties: + v1.0.0: + type: array + items: + oneOf: + - type: string + example: Published Date - Jan 10, 2021 + description: Patch Update, Optimization and thumbnail is added as an additional field + v0.1.0: + type: array + items: + oneOf: + - type: string + example: Published Date - Apr 23, 2020 + description: Initial version release + input: + type: object + properties: + keyword: + type: string + example: Singapore + default: true + description: The search term, highest match to the title of the Wikipedia page. Not Mandatory when pageid is given. + pageid: + type: integer + default: false + example: 27318 + description: The Wikipedia id of the page requested. Mandatory only when title is not given. + language: + type: string + default: false + example: en + description: Indicates the language in which the Wikipedia page is written. Default is English, for other languages give the input as ISO 639-1 language code. Please refer this link for language code https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes + additional_fields: + type: string + default: false + example: all + description: The default returns the pageid, url, summary and thumbnail, when given “all” - returns all the fields i.e pageid, url, summary, content, links, images and thumbnail. + securitySchemes: + APIAuthorizer: + type: apiKey + name: x-api-key + in: header + x-amazon-apigateway-authtype: custom + description: Authentication is done using the x-api-key in the request header From c553473a2cd8bfec9f79ffd8719414b6ca748170 Mon Sep 17 00:00:00 2001 From: Priyadharshini Date: Mon, 11 Jan 2021 18:29:37 +0530 Subject: [PATCH 320/792] wiki and web scraper doc update --- yaml/face_recognition_v1.0.yaml | 4 ++-- yaml/wikipedia_retrieval_v1.0.yaml | 4 ++-- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/yaml/face_recognition_v1.0.yaml b/yaml/face_recognition_v1.0.yaml index 2aa7ce266..94bd1316e 100644 --- a/yaml/face_recognition_v1.0.yaml +++ b/yaml/face_recognition_v1.0.yaml @@ -66,7 +66,7 @@ servers: - url: 'https://apis.sentient.io' tags: - name: "v1.0.1" - description: "Published Date - Jan 08, 2021" + description: "Published Date - Jan 11, 2021" paths: /microservices/cv/facerecognition/v1/getpredictions: post: @@ -288,7 +288,7 @@ components: items: oneOf: - type: string - example: Published Date - Jan 08, 2021 + example: Published Date - Jan 11, 2021 description: Bug fix - Threshold value v1.0.0: type: array diff --git a/yaml/wikipedia_retrieval_v1.0.yaml b/yaml/wikipedia_retrieval_v1.0.yaml index cb1fe3934..d73416533 100644 --- a/yaml/wikipedia_retrieval_v1.0.yaml +++ b/yaml/wikipedia_retrieval_v1.0.yaml @@ -14,7 +14,7 @@ servers: - url: 'https://apis.sentient.io' tags: - name: "v1.0.0" - description: "Published Date - Jan 10, 2021" + description: "Published Date - Jan 11, 2021" paths: /microservices/utility/wikipedia/v1/getresults: post: @@ -301,7 +301,7 @@ components: items: oneOf: - type: string - example: Published Date - Jan 10, 2021 + example: Published Date - Jan 11, 2021 description: Patch Update, Optimization and thumbnail is added as an additional field v0.1.0: type: array From ac1d0bd986e9743e3708730ea44c68cb6ac2a400 Mon Sep 17 00:00:00 2001 From: Priyadharshini <57977344+priyadharshini-sent@users.noreply.github.com> Date: Mon, 11 Jan 2021 18:54:30 +0530 Subject: [PATCH 321/792] Update index.yaml --- yaml/index.yaml | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/yaml/index.yaml b/yaml/index.yaml index 468a307db..87791354c 100644 --- a/yaml/index.yaml +++ b/yaml/index.yaml @@ -90,6 +90,7 @@ Computer Vision: Object Detection: title: object_detection versions: + v1.0: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/object_detection_v1.0.yaml" v0.1: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/object_detection.yaml" Face Recognition: title: face_recognition @@ -99,14 +100,17 @@ Computer Vision: People Counting: title: people_counting versions: + v1.0: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/people_counting_v1.0.yaml" v0.1: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/people_counting.yaml" Landmark Detection (SG): title: landmark_detection_sg versions: + v1.0: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/landmark_detection_sg_v1.0.yaml" v0.1: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/landmark_detection_sg.yaml" Landmark Detection (JP): title: landmark_detection_jp versions: + v1.0: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/landmark_detection_jp_v1.0.yaml" v0.1: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/landmark_detection_jp.yaml" Demographics Classification: title: demographics_classification @@ -148,6 +152,7 @@ Utility: Wikipedia Retrieval: title: wikipedia_retrieval versions: + v1.0: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/wikipedia_retrieval_v1.0.yaml" v0.1: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/wikipedia_retrieval.yaml" JSON-CSV Convertor: title: json-csv_convertor From 3800838705d0a6347def041edea9ae8d7809ad33 Mon Sep 17 00:00:00 2001 From: Priyadharshini <57977344+priyadharshini-sent@users.noreply.github.com> Date: Tue, 12 Jan 2021 09:39:11 +0530 Subject: [PATCH 322/792] Create object_detection_v1.0.yaml --- yaml/object_detection_v1.0.yaml | 278 ++++++++++++++++++++++++++++++++ 1 file changed, 278 insertions(+) create mode 100644 yaml/object_detection_v1.0.yaml diff --git a/yaml/object_detection_v1.0.yaml b/yaml/object_detection_v1.0.yaml new file mode 100644 index 000000000..e5db137ef --- /dev/null +++ b/yaml/object_detection_v1.0.yaml @@ -0,0 +1,278 @@ +openapi: 3.0.1 +info: + title: Object Detection + description: |+ + This Computer Vision microservice detects objects in the input image. + + The microservice returns detected objects with their classes and their bounding boxes in the image coordinates. + + The classes are: person, bicycle, car, motorbike, aeroplane, bus, train, truck, boat, traffic light, fire hydrant, stop sign, parking meter, bench, bird, cat, dog, horse, sheep, cow, elephant, bear, zebra, giraffe, backpack, umbrella, handbag, tie, suitcase, frisbee, skis, snowboard, sports ball, kite, baseball bat, baseball glove, skateboard, surfboard, tennis racket, bottle, wine glass, cup, fork, knife, spoon, bowl, banana, apple, sandwich, orange, broccoli, carrot, hot dog, pizza, donut, cake, chair, sofa, pottedplant, bed, diningtable, toilet, tvmonitor, laptop, mouse, remote, keyboard, cell phone, microwave, oven, toaster, sink, refrigerator, book, clock, vase, scissors, teddy bear, hair drier, toothbrush. + + The size of your image file should **not exceed 5 MB**, and the image dimension should be **at least 416x416 pixels**. + x-additionalinfo: |+ + Suggested Use Cases: + - Industrial inspection - use Object Detection to automate the quality control process in manufacturing by enabling edge devices to identify defects. + - Product search - build a product search app to find products of interest within images and visually search product catalogs. + - Build an object detection app for the visually-impaired - help users identify daily objects that they may need aid in recognising + version: '1.0.0' + x-subscribelink: object_detection +servers: + - url: 'https://apis.sentient.io' +tags: +- name: "v1.0.0" + description: "Published Date - Dec 31, 2020" +paths: + /microservices/cv/objectdetection/v1/getpredictions: + post: + tags: + - v1.0.0 + responses: + '200': + description: success response + content: + application/json: + schema: + $ref: '#/components/schemas/success' + example: {"results":{"objects": [{"bounding box": {"bottom": 742,"left": 19,"right": 1019,"top": 73},"class": "person","confidence": 1,"object id": 0}]},"message": "Successfully Processed","status": "Success"} + + '401': + description: Unauthorized + content: + application/json: + schema: + $ref: '#/components/schemas/unauthorized' + '402': + description: Payment Required + content: + application/json: + schema: + $ref: '#/components/schemas/paymentrequired' + '403': + description: Forbidden + content: + application/json: + schema: + $ref: '#/components/schemas/forbidden' + '404': + description: Not Found + content: + application/json: + schema: + $ref: '#/components/schemas/notfound' + '419': + description: Input Field Missing + content: + application/json: + schema: + $ref: '#/components/schemas/inputfieldmissing' + '420': + description: Input Limit Exceeded + content: + application/json: + schema: + $ref: '#/components/schemas/inputlimitexceeded' + '422': + description: Invalid Input + content: + application/json: + schema: + $ref: '#/components/schemas/invalidinput' + '500': + description: Internal Server Error + content: + application/json: + schema: + $ref: '#/components/schemas/servererror' + '504': + description: Gateway Timeout + content: + application/json: + schema: + $ref: '#/components/schemas/gatewaytimeout' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/input' + required: true + security: + - APIAuthorizer: [] +components: + schemas: + success: + type: object + properties: + results: + type: object + description: The result of the API call. + example: { "" } + properties: + objects: + type: array + example: [{"bounding box": {"bottom": 742,"left": 19,"right": 1019,"top": 73},"class": "person","confidence": 1,"object id": 0}] + description: "Details of the detected object" + items: + oneOf: + - type: object + properties: + bounding box: + type: object + example: {"bottom": 742,"left": 19,"right": 1019,"top": 73} + description: Bounding box of the image + properties: + bottom: + type: number + example: 742 + description: Bottom coordinate of the box + left: + type: number + example: 19 + description: Left coordinate of the box + right: + type: number + example: 1019 + description: Right coordinate of the box + top: + type: number + example: 73 + description: Top coordinate of the box + class: + type: string + example: person + description: Detected object + confidence: + type: number + example: 1 + description: Confidence of the detected object. Higher confidence, more accurate the detected object. + object id: + type: number + example: 0 + description: Detected object id + message: + type: string + example: Successfully Processed + description: Detail description on the API status + status: + type: string + example: Success + description: The status of the API call success/failure + unauthorized: + type: object + properties: + message: + type: string + example: Missing Authentication Token + status: + type: string + example: Failure + forbidden: + type: object + properties: + message: + type: string + example: Access Denied Unauthorized User + status: + type: string + example: Failure + paymentrequired: + type: object + properties: + message: + type: string + example: Insufficient Credits Kindly Top Up + status: + type: string + example: Failure + notfound: + type: object + properties: + message: + type: string + example: Invalid Request URL + status: + type: string + example: Failure + servererror: + type: object + properties: + message: + type: string + example: Internal Server Error + status: + type: string + example: Failure + gatewaytimeout: + type: object + properties: + message: + type: string + example: Request Timeout + status: + type: string + example: Failure + invalidinput: + type: object + properties: + message: + type: string + example: Invalid Input + status: + type: string + example: Failure + inputfieldmissing: + type: object + properties: + message: + type: string + example: Input Field Missing + status: + type: string + example: Failure + inputlimitexceeded: + type: object + properties: + message: + type: string + example: Input Limit Exceeded + status: + type: string + example: Failure + + versions: + type: object + properties: + v1.0.0: + type: array + items: + oneOf: + - type: string + example: Published Date - Dec 31, 2020 + description: Standardizing Output JSON + v0.1.0: + type: array + items: + oneOf: + - type: string + example: Published Date - May 15,2020 + description: Initial version release + input: + type: object + required: + - image_base64 + properties: + image_base64: + x-name: image_base64 + type: string + default: true + example: /9j/4AAQSkZJRgABAQEASABIAAD/2wBDAAMCAgMCAgMDAwMEAwMEBQgFBQQEBQoHBwYIDAoMDAsKCwsNDhIQDQ4RDgsLEBYQERMUFRUVDA8XGBYUG... + description: |+ + Input image file in base64 format. + + Supported formats: bmp, dib, exr, hdr, jpeg, jpg, jpe, jp2, png, pic, pbm, pgm, ppm, pxm, pnm, ras, sr, tiff, tif, webp. + securitySchemes: + APIAuthorizer: + type: apiKey + name: x-api-key + in: header + x-amazon-apigateway-authtype: custom + description: Authentication is done using the x-api-key in the request header From 3675be83d91e14084416793ec26af92bb3f57afb Mon Sep 17 00:00:00 2001 From: Priyadharshini <57977344+priyadharshini-sent@users.noreply.github.com> Date: Mon, 18 Jan 2021 08:38:35 +0530 Subject: [PATCH 323/792] Update demographics_classification.yaml --- yaml/demographics_classification.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/yaml/demographics_classification.yaml b/yaml/demographics_classification.yaml index 9eb789d16..eb9212268 100644 --- a/yaml/demographics_classification.yaml +++ b/yaml/demographics_classification.yaml @@ -4,7 +4,7 @@ info: description: |+ This Computer Vision microservice detects for faces from an input image and predicts the demographics of each face (age, gender and race). The image is given as an input encoded using base64. The microservice will a face detector and subsequently models to predict age, gender and race. The results will then be returned back to the user as a JSON output together with bounding box coordinates for each face.Races include: Asian, Indian, White, Black, Middle Eastern and Latino Hispanic The size of your image file should **not exceed 5 MB**, and the image dimension should be **at least 416x416 pixels**. - x-additionalinfo: |+ + x-additionalinfo: |+ Suggested Use Cases: - This microservice can be used as a solution to help businesses better understand and connect with their customers, engage new prospects and increase revenue. For example, it can be used to improve visitor experience and optimize operations in retail, leisure, and other sectors by identifying the type of demogrpahic that frequents a certain place the most. It can also be used to create intelligent prospect lists that ensure one is always maximizing their marketing investment. version: v0.1.0 From 8ae9a26292ed4910b7cd5a7a447ef4829cc747c5 Mon Sep 17 00:00:00 2001 From: Priyadharshini <57977344+priyadharshini-sent@users.noreply.github.com> Date: Mon, 18 Jan 2021 08:40:02 +0530 Subject: [PATCH 324/792] Update demographics_classification.yaml --- yaml/demographics_classification.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/yaml/demographics_classification.yaml b/yaml/demographics_classification.yaml index eb9212268..3986e3a70 100644 --- a/yaml/demographics_classification.yaml +++ b/yaml/demographics_classification.yaml @@ -5,7 +5,7 @@ info: This Computer Vision microservice detects for faces from an input image and predicts the demographics of each face (age, gender and race). The image is given as an input encoded using base64. The microservice will a face detector and subsequently models to predict age, gender and race. The results will then be returned back to the user as a JSON output together with bounding box coordinates for each face.Races include: Asian, Indian, White, Black, Middle Eastern and Latino Hispanic The size of your image file should **not exceed 5 MB**, and the image dimension should be **at least 416x416 pixels**. x-additionalinfo: |+ - Suggested Use Cases: + Suggested Use Cases: - This microservice can be used as a solution to help businesses better understand and connect with their customers, engage new prospects and increase revenue. For example, it can be used to improve visitor experience and optimize operations in retail, leisure, and other sectors by identifying the type of demogrpahic that frequents a certain place the most. It can also be used to create intelligent prospect lists that ensure one is always maximizing their marketing investment. version: v0.1.0 x-subscribelink: demographics_classification From 142fdd5a1d4ec763ef9743e21bc21f078a5ab969 Mon Sep 17 00:00:00 2001 From: Priyadharshini <57977344+priyadharshini-sent@users.noreply.github.com> Date: Mon, 18 Jan 2021 09:07:28 +0530 Subject: [PATCH 325/792] Update demographics_classification.yaml --- yaml/demographics_classification.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/yaml/demographics_classification.yaml b/yaml/demographics_classification.yaml index 3986e3a70..ed41a3f1c 100644 --- a/yaml/demographics_classification.yaml +++ b/yaml/demographics_classification.yaml @@ -6,7 +6,7 @@ info: The size of your image file should **not exceed 5 MB**, and the image dimension should be **at least 416x416 pixels**. x-additionalinfo: |+ Suggested Use Cases: - - This microservice can be used as a solution to help businesses better understand and connect with their customers, engage new prospects and increase revenue. For example, it can be used to improve visitor experience and optimize operations in retail, leisure, and other sectors by identifying the type of demogrpahic that frequents a certain place the most. It can also be used to create intelligent prospect lists that ensure one is always maximizing their marketing investment. + - This microservice can be used as a solution to help businesses better understand and connect with their customers, engage new prospects and increase revenue. For example, it can be used to improve visitor experience and optimize operations in retail, leisure, and other sectors by identifying the type of demogrpahic that frequents a certain place the most. It can also be used to create intelligent prospect lists that ensure one is always maximizing their marketing investment. version: v0.1.0 x-subscribelink: demographics_classification servers: From 9c7a262d4f9d9837844136ffbbec7d7b5521e6c8 Mon Sep 17 00:00:00 2001 From: Priyadharshini <57977344+priyadharshini-sent@users.noreply.github.com> Date: Mon, 18 Jan 2021 16:51:16 +0530 Subject: [PATCH 326/792] Update automatic_speech_recognition_eng_sg_v1.0.yaml --- yaml/automatic_speech_recognition_eng_sg_v1.0.yaml | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/yaml/automatic_speech_recognition_eng_sg_v1.0.yaml b/yaml/automatic_speech_recognition_eng_sg_v1.0.yaml index 0dd4712df..3c00f9194 100644 --- a/yaml/automatic_speech_recognition_eng_sg_v1.0.yaml +++ b/yaml/automatic_speech_recognition_eng_sg_v1.0.yaml @@ -240,8 +240,9 @@ components: description: |+ Model selection. For best performance, select the model which best matches the use-case: - 1. prepared_speech - Better suited for transcribing prepared / formal speech (e.g. news or parliamentary speeches). 16 kHz, mono channel, .wav format. - 2. telephony - Better suited for conversational speech or telephony use cases. 8 kHz, mono channel, .wav format. + 1. news_parliament - 16 kHz, mono channel, .wav format. Trained on Singapore news and parliament corpus. + 2. nsc_parliament - 16 kHz, mono channel, .wav format. Trained on National Speech Corpus and parliament corpus. + 3. nscfull_8k - 8 kHz, mono channel, .wav format. Trained on National Speech Corpus. Trained on Full National Speech Corpus corpus. wav_base64: x-name: wav_base64 type: string From 1f9e7c9fa016f7ddec43a2f2ee23b7c607d20f74 Mon Sep 17 00:00:00 2001 From: Priyadharshini <57977344+priyadharshini-sent@users.noreply.github.com> Date: Mon, 18 Jan 2021 16:53:10 +0530 Subject: [PATCH 327/792] Update asr_with_voice_activity_detection_eng_sg_v1.0.yaml --- yaml/asr_with_voice_activity_detection_eng_sg_v1.0.yaml | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/yaml/asr_with_voice_activity_detection_eng_sg_v1.0.yaml b/yaml/asr_with_voice_activity_detection_eng_sg_v1.0.yaml index 313ea595d..d7fbffe38 100644 --- a/yaml/asr_with_voice_activity_detection_eng_sg_v1.0.yaml +++ b/yaml/asr_with_voice_activity_detection_eng_sg_v1.0.yaml @@ -236,8 +236,9 @@ components: description: |+ Model selection. For best performance, select the model which best matches the use-case: - 1. prepared_speech - Better suited for transcribing prepared / formal speech (e.g. news or parliamentary speeches). 16 kHz, mono channel, .wav format. - 2. telephony - Better suited for conversational speech or telephony use cases. 8 kHz, mono channel, .wav format. + 1. news_parliament - 16 kHz, mono channel, .wav format. Trained on Singapore news and parliament corpus. + 2. nsc_parliament - 16 kHz, mono channel, .wav format. Trained on National Speech Corpus and parliament corpus. + 3. nscfull_8k - 8 kHz, mono channel, .wav format. Trained on National Speech Corpus. Trained on Full National Speech Corpus corpus. wav_base64: x-name: wav_base64 type: string From be8132ca5f9a1b3fdff33ec5dd2740e60a5b8bed Mon Sep 17 00:00:00 2001 From: Priyadharshini <57977344+priyadharshini-sent@users.noreply.github.com> Date: Mon, 18 Jan 2021 16:55:11 +0530 Subject: [PATCH 328/792] Update asr_with_voice_activity_detection_eng_sg_v1.0.yaml --- yaml/asr_with_voice_activity_detection_eng_sg_v1.0.yaml | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/yaml/asr_with_voice_activity_detection_eng_sg_v1.0.yaml b/yaml/asr_with_voice_activity_detection_eng_sg_v1.0.yaml index d7fbffe38..c544b6515 100644 --- a/yaml/asr_with_voice_activity_detection_eng_sg_v1.0.yaml +++ b/yaml/asr_with_voice_activity_detection_eng_sg_v1.0.yaml @@ -3,9 +3,7 @@ info: title: ASR with Voice Activity Detection ENG (SG) description: |+ This Voice microservice combines Voice Activity Detection feature and Automatic Speech Recognition capability. It detects speech in an audio file (.wav format) and transcribes English speech content from the audio stream into text. The transcript text is timestamped for each utterance. An utterance is a continuous piece of speech beginning and ending with a clear pause. - This microservice performs well on Singaporean-accented English speech. For best performance, select the model which best matches the use-case, whether for prepared speech (16kHz) or telephony (8kHz). - - The size of your audio file should be **between 3 KB to 10 MB**. + This Voice microservice performs well on Singapore-accented English speech. For best performance, select the model which best matches the use-case: news_parliament, nsc_parliament, nscfull_8k. version: '1.1.0' x-additionalinfo: |+ Suggested Use Cases: From ed3619b6b5db801f947ce28b24c23c7b9b9ebc2e Mon Sep 17 00:00:00 2001 From: Priyadharshini <57977344+priyadharshini-sent@users.noreply.github.com> Date: Mon, 18 Jan 2021 16:56:17 +0530 Subject: [PATCH 329/792] Update automatic_speech_recognition_eng_sg_v1.0.yaml --- yaml/automatic_speech_recognition_eng_sg_v1.0.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/yaml/automatic_speech_recognition_eng_sg_v1.0.yaml b/yaml/automatic_speech_recognition_eng_sg_v1.0.yaml index 3c00f9194..48dcfcae0 100644 --- a/yaml/automatic_speech_recognition_eng_sg_v1.0.yaml +++ b/yaml/automatic_speech_recognition_eng_sg_v1.0.yaml @@ -4,7 +4,7 @@ info: description: |+ This Voice microservice transcribes the input audio stream into text. - This microservice performs well on Singaporean-accented English speech. For best performance, select the model which best matches the use-case, whether for prepared speech (16kHz) or telephony (8kHz). + This microservice performs well on Singaporean-accented English speech. For best performance, select the model which best matches the use-case: news_parliament, nsc_parliament and nscfull_8k. The size of your audio file should be **between 3 KB to 10 MB**. version: '1.1.0' From fd0bce2825bcb6296a1befacd3d8b8baa712812e Mon Sep 17 00:00:00 2001 From: Priyadharshini <57977344+priyadharshini-sent@users.noreply.github.com> Date: Wed, 20 Jan 2021 10:21:59 +0530 Subject: [PATCH 330/792] Update index.yaml --- yaml/index.yaml | 3 --- 1 file changed, 3 deletions(-) diff --git a/yaml/index.yaml b/yaml/index.yaml index 87791354c..38c7c51db 100644 --- a/yaml/index.yaml +++ b/yaml/index.yaml @@ -100,17 +100,14 @@ Computer Vision: People Counting: title: people_counting versions: - v1.0: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/people_counting_v1.0.yaml" v0.1: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/people_counting.yaml" Landmark Detection (SG): title: landmark_detection_sg versions: - v1.0: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/landmark_detection_sg_v1.0.yaml" v0.1: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/landmark_detection_sg.yaml" Landmark Detection (JP): title: landmark_detection_jp versions: - v1.0: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/landmark_detection_jp_v1.0.yaml" v0.1: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/landmark_detection_jp.yaml" Demographics Classification: title: demographics_classification From 61c8f741008182dcdd2b48e64cdaec8e9d9178db Mon Sep 17 00:00:00 2001 From: Priyadharshini <57977344+priyadharshini-sent@users.noreply.github.com> Date: Wed, 20 Jan 2021 10:23:03 +0530 Subject: [PATCH 331/792] Update index.yaml --- yaml/index.yaml | 1 - 1 file changed, 1 deletion(-) diff --git a/yaml/index.yaml b/yaml/index.yaml index 38c7c51db..a076a26aa 100644 --- a/yaml/index.yaml +++ b/yaml/index.yaml @@ -90,7 +90,6 @@ Computer Vision: Object Detection: title: object_detection versions: - v1.0: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/object_detection_v1.0.yaml" v0.1: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/object_detection.yaml" Face Recognition: title: face_recognition From 975bfc045d0b42e6dea715fe38ad37cffe5c24c6 Mon Sep 17 00:00:00 2001 From: rameshsentient <51635015+rameshsentient@users.noreply.github.com> Date: Fri, 22 Jan 2021 18:49:44 +0530 Subject: [PATCH 332/792] Update asr_with_voice_activity_detection_eng_sg_v1.0.yaml --- yaml/asr_with_voice_activity_detection_eng_sg_v1.0.yaml | 9 ++++----- 1 file changed, 4 insertions(+), 5 deletions(-) diff --git a/yaml/asr_with_voice_activity_detection_eng_sg_v1.0.yaml b/yaml/asr_with_voice_activity_detection_eng_sg_v1.0.yaml index c544b6515..422e6db6e 100644 --- a/yaml/asr_with_voice_activity_detection_eng_sg_v1.0.yaml +++ b/yaml/asr_with_voice_activity_detection_eng_sg_v1.0.yaml @@ -13,7 +13,7 @@ servers: - url: 'https://apis.sentient.io' tags: - name: "v1.1.0" - description: "Published Date - Dec 14, 2020" + description: "Published Date - Jan 22, 2021" paths: /microservices/voice/vadasr/v1/getpredictions: post: @@ -234,9 +234,8 @@ components: description: |+ Model selection. For best performance, select the model which best matches the use-case: - 1. news_parliament - 16 kHz, mono channel, .wav format. Trained on Singapore news and parliament corpus. - 2. nsc_parliament - 16 kHz, mono channel, .wav format. Trained on National Speech Corpus and parliament corpus. - 3. nscfull_8k - 8 kHz, mono channel, .wav format. Trained on National Speech Corpus. Trained on Full National Speech Corpus corpus. + 1. prepared_speech - Better suited for transcribing prepared / formal speech (e.g. news or parliamentary speeches). 16 kHz, mono channel, .wav format. + 2. telephony - Better suited for conversational speech or telephony use cases. 8 kHz, mono channel, .wav format. wav_base64: x-name: wav_base64 type: string @@ -271,7 +270,7 @@ components: items: oneOf: - type: string - example: Published Date - Dec 14, 2020 + example: Published Date - Jan 22, 2021 description: Model name update v1.0.0: type: array From 5104e68d2de446036f94f04222055bbbcdbce56a Mon Sep 17 00:00:00 2001 From: rameshsentient <51635015+rameshsentient@users.noreply.github.com> Date: Fri, 22 Jan 2021 18:53:25 +0530 Subject: [PATCH 333/792] Update asr_with_voice_activity_detection_eng_sg_v1.0.yaml --- yaml/asr_with_voice_activity_detection_eng_sg_v1.0.yaml | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/yaml/asr_with_voice_activity_detection_eng_sg_v1.0.yaml b/yaml/asr_with_voice_activity_detection_eng_sg_v1.0.yaml index 422e6db6e..22712f77d 100644 --- a/yaml/asr_with_voice_activity_detection_eng_sg_v1.0.yaml +++ b/yaml/asr_with_voice_activity_detection_eng_sg_v1.0.yaml @@ -3,7 +3,9 @@ info: title: ASR with Voice Activity Detection ENG (SG) description: |+ This Voice microservice combines Voice Activity Detection feature and Automatic Speech Recognition capability. It detects speech in an audio file (.wav format) and transcribes English speech content from the audio stream into text. The transcript text is timestamped for each utterance. An utterance is a continuous piece of speech beginning and ending with a clear pause. - This Voice microservice performs well on Singapore-accented English speech. For best performance, select the model which best matches the use-case: news_parliament, nsc_parliament, nscfull_8k. + This microservice performs well on Singaporean-accented English speech. For best performance, select the model which best matches the use-case, whether for prepared speech (16kHz) or telephony (8kHz). + + The size of your audio file should be **between 3 KB to 10 MB**. version: '1.1.0' x-additionalinfo: |+ Suggested Use Cases: From 68f38d6e27e3966aac1cacd53de23f42cf28b1a6 Mon Sep 17 00:00:00 2001 From: rameshsentient <51635015+rameshsentient@users.noreply.github.com> Date: Fri, 22 Jan 2021 18:56:07 +0530 Subject: [PATCH 334/792] Update asr_with_voice_activity_detection_eng_sg_v1.0.yaml --- yaml/asr_with_voice_activity_detection_eng_sg_v1.0.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/yaml/asr_with_voice_activity_detection_eng_sg_v1.0.yaml b/yaml/asr_with_voice_activity_detection_eng_sg_v1.0.yaml index 22712f77d..38cb5c736 100644 --- a/yaml/asr_with_voice_activity_detection_eng_sg_v1.0.yaml +++ b/yaml/asr_with_voice_activity_detection_eng_sg_v1.0.yaml @@ -232,7 +232,7 @@ components: x-name: model type: string default: true - example: news_parliament + example: prepared_speech description: |+ Model selection. For best performance, select the model which best matches the use-case: From ec592eccbfc4d73e453228f699299702b550b080 Mon Sep 17 00:00:00 2001 From: rameshsentient <51635015+rameshsentient@users.noreply.github.com> Date: Fri, 22 Jan 2021 19:05:03 +0530 Subject: [PATCH 335/792] Update automatic_speech_recognition_eng_sg_v1.0.yaml --- yaml/automatic_speech_recognition_eng_sg_v1.0.yaml | 13 ++++++------- 1 file changed, 6 insertions(+), 7 deletions(-) diff --git a/yaml/automatic_speech_recognition_eng_sg_v1.0.yaml b/yaml/automatic_speech_recognition_eng_sg_v1.0.yaml index 48dcfcae0..3f3560a76 100644 --- a/yaml/automatic_speech_recognition_eng_sg_v1.0.yaml +++ b/yaml/automatic_speech_recognition_eng_sg_v1.0.yaml @@ -4,7 +4,7 @@ info: description: |+ This Voice microservice transcribes the input audio stream into text. - This microservice performs well on Singaporean-accented English speech. For best performance, select the model which best matches the use-case: news_parliament, nsc_parliament and nscfull_8k. + This microservice performs well on Singaporean-accented English speech. For best performance, select the model which best matches the use-case, whether for prepared speech (16kHz) or telephony (8kHz). The size of your audio file should be **between 3 KB to 10 MB**. version: '1.1.0' @@ -16,7 +16,7 @@ servers: - url: 'https://apis.sentient.io' tags: - name: "v1.1.0" - description: "Published Date - Dec 14, 2020" + description: "Published Date - Jan 22, 2021" paths: /microservices/voice/asr/v1/getpredictions: post: @@ -236,13 +236,12 @@ components: x-name: model type: string default: true - example: nsc_parliament + example: prepared_speech description: |+ Model selection. For best performance, select the model which best matches the use-case: - 1. news_parliament - 16 kHz, mono channel, .wav format. Trained on Singapore news and parliament corpus. - 2. nsc_parliament - 16 kHz, mono channel, .wav format. Trained on National Speech Corpus and parliament corpus. - 3. nscfull_8k - 8 kHz, mono channel, .wav format. Trained on National Speech Corpus. Trained on Full National Speech Corpus corpus. + 1. prepared_speech - Better suited for transcribing prepared / formal speech (e.g. news or parliamentary speeches). 16 kHz, mono channel, .wav format. + 2. telephony - Better suited for conversational speech or telephony use cases. 8 kHz, mono channel, .wav format. wav_base64: x-name: wav_base64 type: string @@ -292,7 +291,7 @@ components: items: oneOf: - type: string - example: Published Date - Dec 14, 2020 + example: Published Date - Jan 22, 2021 description: Model name update v1.0.0: type: array From 5dbf5302a3f9c80977fc6d8c062075199603d465 Mon Sep 17 00:00:00 2001 From: rameshsentient <51635015+rameshsentient@users.noreply.github.com> Date: Thu, 28 Jan 2021 13:53:42 +0530 Subject: [PATCH 336/792] Update page_profiler_jp.yaml --- yaml/page_profiler_jp.yaml | 82 ++++++++++++++++++++++++++++++-------- 1 file changed, 65 insertions(+), 17 deletions(-) diff --git a/yaml/page_profiler_jp.yaml b/yaml/page_profiler_jp.yaml index d6180b42d..5bb762fb1 100644 --- a/yaml/page_profiler_jp.yaml +++ b/yaml/page_profiler_jp.yaml @@ -122,26 +122,74 @@ example: { "" } description: Json Object of returned results properties: - Company: - x-name: Company + age: type: array - example: [ 和歌山製鉄所 ] - description: name of company found in the text string - Date: - x-name: Date + items: + type: string + example: + - 56 + description: "age details found in the text string" + countx_other: + type: array + items: + type: string + example: + - 2稿 + - 8口 + description: "countx other details found in the text string" + doctrine_method_other: + type: array + items: + type: string + example: + - 険所コホ特室りょ + description: "doctrine method in the text string" + n_event: + type: array + items: + type: string + example: + - 受1 + description: "n_event in the text string" + numex_other: type: array - example: [ 7日,2023年9月,22年9月 ] - description: name of date found in the text string - Domestic_Region: - x-name: Domestic_Region + items: + type: string + example: + - 受1 + description: "numex_other details found in the text string" + ordinal_number: + type: array + items: + type: string + example: + -30弾 + description: "ordinal_number details in the text string" + person: type: array - example: [ 呉製鉄所 ] - description: name of domestic_region found in the text string - Material: - x-name: Material + items: + type: string + example: + - person + - 壮 + - 琢紫 + - ナユ + description: "person details found in the text string" + product_other: type: array - example: [ 鉄鋼最大手 ] - description: name of material found in the text string + items: + type: string + example: + - 都合ヘラアニ限 + - 議帳 + description: "product found in the text string" + show_organization: + type: array + items: + type: string + example: + - 左成相態 + description: "organization details found in the text string" message: type: string example: Successfully Processed @@ -149,7 +197,7 @@ status: type: string example: Success - description: The status of the API call success/failure + description: The status of the API call success/failure unauthorized: type: object From f6d2bd1632f7451d07465a9f5f821cd722b2a80c Mon Sep 17 00:00:00 2001 From: rameshsentient <51635015+rameshsentient@users.noreply.github.com> Date: Thu, 28 Jan 2021 14:06:45 +0530 Subject: [PATCH 337/792] Update page_profiler_jp.yaml --- yaml/page_profiler_jp.yaml | 40 +++++++++++++++++++++++--------------- 1 file changed, 24 insertions(+), 16 deletions(-) diff --git a/yaml/page_profiler_jp.yaml b/yaml/page_profiler_jp.yaml index 5bb762fb1..fb599849a 100644 --- a/yaml/page_profiler_jp.yaml +++ b/yaml/page_profiler_jp.yaml @@ -31,24 +31,32 @@ application/json: schema: $ref: '#/components/schemas/success' - example: + example: message: Successfully Processed results: - company: - - 和歌山製鉄所 - date: - - 7日,2023年9月 - - 22年9月 - domestic_region: - - 呉製鉄所 - material: - - 鉄鋼最大手 - n_product: - - 高炉2基 - - 2基","1基 - province: - - 広島県呉市 - - 和歌山市 + age: + - '56' + countx_other: + - 2稿 + - 8口 + doctrine_method_other: + - 険所コホ特室りょ + n_event: + - 受1 + numex_other: + - 百経 + ordinal_number: + - 30弾 + person: + - くぼ + - 壮 + - 琢紫 + - ナユ + product_other: + - 都合ヘラアニ限 + - 議帳 + show_organization: + - 左成相態 status: Success '401': description: Unauthorized From 16e3fdd4423c289bdbe85544b950545c80ff7352 Mon Sep 17 00:00:00 2001 From: rameshsentient <51635015+rameshsentient@users.noreply.github.com> Date: Thu, 28 Jan 2021 14:15:46 +0530 Subject: [PATCH 338/792] Update page_profiler_thai.yaml --- yaml/page_profiler_thai.yaml | 81 ++++++++++++++++++++++++++++++------ 1 file changed, 68 insertions(+), 13 deletions(-) diff --git a/yaml/page_profiler_thai.yaml b/yaml/page_profiler_thai.yaml index 72bd6b657..8c28bb2c5 100644 --- a/yaml/page_profiler_thai.yaml +++ b/yaml/page_profiler_thai.yaml @@ -136,25 +136,80 @@ example: { "" } description: Json Object of returned results properties: + law: + x-name: law + type: array + example: [พ.ร.บ.โรคระบาด พ.ศ.2499, รัฐธรรมนูญ] + description: "law details found in the text string" location: x-name: location type: array - example: [ สหรัฐอเมริ ] - description: name of location found in the text string - + example: + - ประเทศไทย + - มาเลเซีย + - ทะเลอันดามัน + - กรุงเทพมหานคร + - อินโดนีเซีย + - ราชอาณาจักรไทย + - อินเดียทางทะเลอันดามันทางตะวันตกเฉียงใต้ + - ลาวทางทิศตะวันออกติดกับลาว + - เอเชียตะวันออกเฉียงใต้ + - เวียดนาม + - ประเทศพม่า + - กัมพูชาทางทิศใต้ติดกับอ่าวไทย + description: "location found in the text string" + organization: + x-name: organization + type: array + example: + - รัฐสภา + description: "organization found in the text string" + date: + x-name: date + type: array + example: [2/21/2004, 16 ก.พ., จันทร์] + description: "date found in the text string" + money: + x-name: money + type: array + example: [2.7 ล้านบาท, 2,000 บาท] + description: "amount of currency found in the text string" + time: + x-name: time + type: array + example: [16.30 น., 5 วัน, 1-3 ปี] + description: "time found in the text string" + email: + x-name: email + type: array + example: [info@nrpsc.ac.th] + description: "email id found in the text string" + len: + x-name: len + type: array + example: [30 กิโลเมตร, 5 กม.] + description: "distance in km found in the text string" person: x-name: person type: array - example: [ ประธานาธิบดีทร ] - description: name of person found in the text string - message: - type: string - example: Successfully Processed - description: Detail description on the API status - status: - type: string - example: Success - description: The status of the API call success/failure + example: [น.พ.จรัล, นางประนอม ทองจันทร์] + description: "name of person found in the text string" + phone: + x-name: phone + type: array + example: [0 2670 8888] + description: "date found in the text string" + url: + x-name: url + type: array + example: [http://www.bangkokhealth.com/] + description: "url in the text string" + zip: + x-name: zip + type: array + example: [10400] + description: "zipcode found in the text string" + message: type: string example: Successfully Processed From 6eb33ab8c59a96c924346d1b56d77809304f865c Mon Sep 17 00:00:00 2001 From: rameshsentient <51635015+rameshsentient@users.noreply.github.com> Date: Mon, 8 Feb 2021 15:31:47 +0530 Subject: [PATCH 339/792] Delete landmark_detection_jp_v1.0.yaml --- yaml/landmark_detection_jp_v1.0.yaml | 260 --------------------------- 1 file changed, 260 deletions(-) delete mode 100644 yaml/landmark_detection_jp_v1.0.yaml diff --git a/yaml/landmark_detection_jp_v1.0.yaml b/yaml/landmark_detection_jp_v1.0.yaml deleted file mode 100644 index e0e2a920e..000000000 --- a/yaml/landmark_detection_jp_v1.0.yaml +++ /dev/null @@ -1,260 +0,0 @@ -openapi: 3.0.1 -info: - title: Landmark Detection (JP) - description: |+ - This Computer Vision microservice identifies Japan landmarks from multiple input images. - - The microservice returns the detected landmark and confidence score. - - The size of your image file should **not exceed 5 MB**. - x-additionalinfo: |+ - Suggested Use Cases: - - Can be used for geo-targeting apps with map feature or property development planning resource apps. - version: '1.0.0' - x-subscribelink: landmark_detection_jp -servers: - - url: 'https://dev-apis.sentient.io' -tags: -- name: "v1.0.0" - description: "Published Date - Dec 31, 2020" -paths: - /microservices/cv/landmarkjp/v1/getpredictions: - post: - tags: - - v1.0.0 - responses: - '200': - description: success response - content: - application/json: - schema: - $ref: '#/components/schemas/success' - example: - results: - confidence: 100% - landmark: Gion - message: Successfully Processed - status: Success - '401': - description: Unauthorized - content: - application/json: - schema: - $ref: '#/components/schemas/unauthorized' - '402': - description: Payment Required - content: - application/json: - schema: - $ref: '#/components/schemas/paymentrequired' - '403': - description: Forbidden - content: - application/json: - schema: - $ref: '#/components/schemas/forbidden' - '404': - description: Not Found - content: - application/json: - schema: - $ref: '#/components/schemas/notfound' - '419': - description: Input Field Missing - content: - application/json: - schema: - $ref: '#/components/schemas/inputfieldmissing' - '420': - description: Input Limit Exceeded - content: - application/json: - schema: - $ref: '#/components/schemas/inputlimitexceeded' - '422': - description: Invalid Input - content: - application/json: - schema: - $ref: '#/components/schemas/invalidinput' - '500': - description: Internal Server Error - content: - application/json: - schema: - $ref: '#/components/schemas/servererror' - '504': - description: Gateway Timeout - content: - application/json: - schema: - $ref: '#/components/schemas/gatewaytimeout' - security: - - APIAuthorizer: [] - - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/input' - required: true - - -components: - schemas: - success: - type: object - properties: - results: - type: object - description: The result of the API call. - example: { "" } - properties: - confidence: - x-name: confidence - type: string - example: 100% - description: Confidence score of identification. Higher is more confidence. - landmark: - x-name: landmark - type: string - example: Gion - description: Name of the landmark - message: - type: string - example: Successfully Processed - description: Detail description on the API status - status: - type: string - example: Success - description: The status of the API call success/failure - - - - unauthorized: - type: object - properties: - message: - type: string - example: Missing Authentication Token - status: - type: string - example: Failure - restricted: - type: object - properties: - message: - type: string - example: The content is restricted - status: - type: string - example: Failure - forbidden: - type: object - properties: - message: - type: string - example: Access Denied Unauthorized User - status: - type: string - example: Failure - paymentrequired: - type: object - properties: - message: - type: string - example: Insufficient Credits Kindly Top Up - status: - type: string - example: Failure - notfound: - type: object - properties: - message: - type: string - example: Invalid Request - status: - type: string - example: Failure - servererror: - type: object - properties: - message: - type: string - example: Internal Server Error - status: - type: string - example: Failure - gatewaytimeout: - type: object - properties: - message: - type: string - example: Request Timeout - status: - type: string - example: Failure - inputfieldmissing: - type: object - properties: - message: - type: string - example: Input Field Missing - status: - type: string - example: Failure - inputlimitexceeded: - type: object - properties: - message: - type: string - example: Input Limit Exceeded - status: - type: string - example: Failure - invalidinput: - type: object - properties: - message: - type: string - example: Invalid Input - status: - type: string - example: Failure - versions: - type: object - properties: - v1.0.0: - type: array - items: - oneOf: - - type: string - example: Published Date - Dec 31, 2020 - description: Standardizing Output JSON - v0.1.0: - type: array - items: - oneOf: - - type: string - example: Published Date - Jul 30,2020 - description: Initial version release - input: - type: object - properties: - image_base64: - x-name: image_base64 - type: string - default: true - example: UklGRkbiBABXQVZFZm10IBAAAAABA... - description: |+ - Input image file in base64 format. - - Supported formats: blp, bmp, bufr, cur, dcx, dds, dib, eps, ps, fit, fits, flc, fli, fpx, ftc, ftu, gbr, gif, grib, h5, hd5, icns, ico, im, iim, jpeg, jp2, mic, mpeg, msp, pcd, pcx, pxr, png, ppm, psd, sgi, ras, tga, tiff, wmf, xbm, xpm. - - securitySchemes: - APIAuthorizer: - type: apiKey - name: x-api-key - in: header - x-amazon-apigateway-authtype: custom - description: Authentication is done using the x-api-key in the request header From 11cd9089f299e3053ae955cdb5cb66de7f392308 Mon Sep 17 00:00:00 2001 From: rameshsentient <51635015+rameshsentient@users.noreply.github.com> Date: Mon, 8 Feb 2021 15:33:17 +0530 Subject: [PATCH 340/792] Delete landmark_detection_sg_v1.0.yaml --- yaml/landmark_detection_sg_v1.0.yaml | 264 --------------------------- 1 file changed, 264 deletions(-) delete mode 100644 yaml/landmark_detection_sg_v1.0.yaml diff --git a/yaml/landmark_detection_sg_v1.0.yaml b/yaml/landmark_detection_sg_v1.0.yaml deleted file mode 100644 index 13f03ef47..000000000 --- a/yaml/landmark_detection_sg_v1.0.yaml +++ /dev/null @@ -1,264 +0,0 @@ -openapi: 3.0.1 -info: - title: Landmark Detection (SG) - description: |+ - This Computer Vision microservice identifies Singapore landmarks from multiple input images. - - This microservice returns the detected landmark and confidence score. - - The size of your image file should **not exceed 5 MB**. - x-additionalinfo: |+ - Suggested Use Cases: - - Can be used for geo-targeting apps with map feature or property development planning resource apps. - version: '1.0.0' - x-subscribelink: landmark_detection_sg -servers: - - url: 'https://dev-apis.sentient.io' -tags: -- name: "v1.0.0" - description: "Published Date - Dec 31, 2020" -paths: - /microservices/cv/landmarksg/v1/getpredictions: - post: - tags: - - v1.0.0 - - responses: - '200': - description: success response - content: - application/json: - schema: - $ref: '#/components/schemas/success' - example: - results: - confidence: 100% - landmark: Artscience Museum - message: Successfully Processed - status: Success - - '401': - description: Unauthorized - content: - application/json: - schema: - $ref: '#/components/schemas/unauthorized' - '402': - description: Payment Required - content: - application/json: - schema: - $ref: '#/components/schemas/paymentrequired' - '403': - description: Forbidden - content: - application/json: - schema: - $ref: '#/components/schemas/forbidden' - '404': - description: Not Found - content: - application/json: - schema: - $ref: '#/components/schemas/notfound' - '419': - description: Input Field Missing - content: - application/json: - schema: - $ref: '#/components/schemas/inputfieldmissing' - '420': - description: Input Limit Exceeded - content: - application/json: - schema: - $ref: '#/components/schemas/inputlimitexceeded' - '422': - description: Invalid Input - content: - application/json: - schema: - $ref: '#/components/schemas/invalidinput' - '500': - description: Internal Server Error - content: - application/json: - schema: - $ref: '#/components/schemas/servererror' - '504': - description: Gateway Timeout - content: - application/json: - schema: - $ref: '#/components/schemas/gatewaytimeout' - security: - - APIAuthorizer: [] - - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/input' - required: true - - -components: - schemas: - success: - type: object - properties: - results: - type: object - description: The result of the API call. - example: { "" } - properties: - confidence: - x-name: confidence - type: string - example: 100% - description: Confidence score of identification. Higher is more confidence. - landmark: - x-name: landmark - type: string - example: Artscience Museum - description: Name of the landmark - message: - type: string - example: Successfully Processed - description: Detail description on the API status - status: - type: string - example: Success - description: The status of the API call success/failure - - - - unauthorized: - type: object - properties: - message: - type: string - example: Missing Authentication Token - status: - type: string - example: Failure - restricted: - type: object - properties: - message: - type: string - example: The content is restricted - status: - type: string - example: Failure - forbidden: - type: object - properties: - message: - type: string - example: Access Denied Unauthorized User - status: - type: string - example: Failure - paymentrequired: - type: object - properties: - message: - type: string - example: Insufficient Credits Kindly Top Up - status: - type: string - example: Failure - notfound: - type: object - properties: - message: - type: string - example: Invalid Request - status: - type: string - example: Failure - servererror: - type: object - properties: - message: - type: string - example: Internal Server Error - status: - type: string - example: Failure - gatewaytimeout: - type: object - properties: - message: - type: string - example: Request Timeout - status: - type: string - example: Failure - inputfieldmissing: - type: object - properties: - message: - type: string - example: Input Field Missing - status: - type: string - example: Failure - inputlimitexceeded: - type: object - properties: - message: - type: string - example: Input Limit Exceeded - status: - type: string - example: Failure - invalidinput: - type: object - properties: - message: - type: string - example: Invalid Input - status: - type: string - example: Failure - versions: - type: object - properties: - v1.0.0: - type: array - items: - oneOf: - - type: string - example: Published Date - Dec 31, 2020 - description: Standardizing Output JSON - v0.1.0: - type: array - items: - oneOf: - - type: string - example: Published Date - Jul 30,2020 - description: Initial version release - input: - type: object - required: - - image_base64 - properties: - image_base64: - x-name: image_base64 - type: string - default: true - example: UklGRkbiBABXQVZFZm10IBAAAAABA... - description: |+ - Input image file in base64 format. - - Supported formats: blp, bmp, bufr, cur, dcx, dds, dib, eps, ps, fit, fits, flc, fli, fpx, ftc, ftu, gbr, gif, grib, h5, hd5, icns, ico, im, iim, jpeg, jp2, mic, mpeg, msp, pcd, pcx, pxr, png, ppm, psd, sgi, ras, tga, tiff, wmf, xbm, xpm. - - securitySchemes: - APIAuthorizer: - type: apiKey - name: x-api-key - in: header - x-amazon-apigateway-authtype: custom - description: Authentication is done using the x-api-key in the request header From d3ab1aa9501d733fcde000e34d5db5e867c5a513 Mon Sep 17 00:00:00 2001 From: Priyadharshini <57977344+priyadharshini-sent@users.noreply.github.com> Date: Wed, 10 Feb 2021 10:18:59 +0530 Subject: [PATCH 341/792] error code update --- yaml/automatic_speech_recognition_eng_sg_v1.0.yaml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/yaml/automatic_speech_recognition_eng_sg_v1.0.yaml b/yaml/automatic_speech_recognition_eng_sg_v1.0.yaml index 3f3560a76..0ede6f6f7 100644 --- a/yaml/automatic_speech_recognition_eng_sg_v1.0.yaml +++ b/yaml/automatic_speech_recognition_eng_sg_v1.0.yaml @@ -68,13 +68,13 @@ paths: application/json: schema: $ref: '#/components/schemas/inputfieldmissing' - '420': + '413': description: Input Limit Exceeded content: application/json: schema: $ref: '#/components/schemas/inputlimitexceeded' - '422': + '415': description: Invalid Input content: application/json: From 61b012e9b31fa8f8f8c4c1606facdf642671cb5d Mon Sep 17 00:00:00 2001 From: Priyadharshini <57977344+priyadharshini-sent@users.noreply.github.com> Date: Wed, 10 Feb 2021 10:19:46 +0530 Subject: [PATCH 342/792] error code update --- yaml/automatic_speech_recognition_eng_sg.yaml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/yaml/automatic_speech_recognition_eng_sg.yaml b/yaml/automatic_speech_recognition_eng_sg.yaml index 46c83f9df..0fcc4431a 100644 --- a/yaml/automatic_speech_recognition_eng_sg.yaml +++ b/yaml/automatic_speech_recognition_eng_sg.yaml @@ -65,13 +65,13 @@ paths: application/json: schema: $ref: '#/components/schemas/inputfieldmissing' - '420': + '413': description: Input Limit Exceeded content: application/json: schema: $ref: '#/components/schemas/inputlimitexceeded' - '422': + '415': description: Invalid Input content: application/json: From 58d0ea85752fde2149bb85f56a7754862f77d34d Mon Sep 17 00:00:00 2001 From: Priyadharshini <57977344+priyadharshini-sent@users.noreply.github.com> Date: Wed, 10 Feb 2021 10:20:16 +0530 Subject: [PATCH 343/792] Update automatic_speech_recognition_chi_sg.yaml --- yaml/automatic_speech_recognition_chi_sg.yaml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/yaml/automatic_speech_recognition_chi_sg.yaml b/yaml/automatic_speech_recognition_chi_sg.yaml index d2b110fc4..a5c9ba89e 100644 --- a/yaml/automatic_speech_recognition_chi_sg.yaml +++ b/yaml/automatic_speech_recognition_chi_sg.yaml @@ -68,13 +68,13 @@ paths: application/json: schema: $ref: '#/components/schemas/inputfieldmissing' - '420': + '413': description: Input Limit Exceeded content: application/json: schema: $ref: '#/components/schemas/inputlimitexceeded' - '422': + '415': description: Invalid Input content: application/json: From cadb8885e89845e98d83b99831cf37577ed905bd Mon Sep 17 00:00:00 2001 From: Priyadharshini <57977344+priyadharshini-sent@users.noreply.github.com> Date: Wed, 10 Feb 2021 10:21:15 +0530 Subject: [PATCH 344/792] Update text-to-speech_eng.yaml --- yaml/text-to-speech_eng.yaml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/yaml/text-to-speech_eng.yaml b/yaml/text-to-speech_eng.yaml index 1f1eafc1b..b40128aff 100644 --- a/yaml/text-to-speech_eng.yaml +++ b/yaml/text-to-speech_eng.yaml @@ -69,13 +69,13 @@ paths: application/json: schema: $ref: '#/components/schemas/inputfieldmissing' - '420': + '413': description: Input Limit Exceeded content: application/json: schema: $ref: '#/components/schemas/inputlimitexceeded' - '422': + '415': description: Invalid Input content: application/json: From 4cd825742ae13fe1d592c29d9f9a65f58c4a9730 Mon Sep 17 00:00:00 2001 From: Priyadharshini <57977344+priyadharshini-sent@users.noreply.github.com> Date: Wed, 10 Feb 2021 10:21:48 +0530 Subject: [PATCH 345/792] Update text-to-speech_chi.yaml --- yaml/text-to-speech_chi.yaml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/yaml/text-to-speech_chi.yaml b/yaml/text-to-speech_chi.yaml index cf0a2c52a..9b7fccfe3 100644 --- a/yaml/text-to-speech_chi.yaml +++ b/yaml/text-to-speech_chi.yaml @@ -67,13 +67,13 @@ paths: application/json: schema: $ref: '#/components/schemas/inputfieldmissing' - '420': + '413': description: Input Limit Exceeded content: application/json: schema: $ref: '#/components/schemas/inputlimitexceeded' - '422': + '415': description: Invalid Input content: application/json: From 8123e36b4ced26e43ae8c7f3b15feceeeab81583 Mon Sep 17 00:00:00 2001 From: Priyadharshini <57977344+priyadharshini-sent@users.noreply.github.com> Date: Wed, 10 Feb 2021 10:22:12 +0530 Subject: [PATCH 346/792] Update asr_with_voice_activity_detection_eng_sg_v1.0.yaml --- yaml/asr_with_voice_activity_detection_eng_sg_v1.0.yaml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/yaml/asr_with_voice_activity_detection_eng_sg_v1.0.yaml b/yaml/asr_with_voice_activity_detection_eng_sg_v1.0.yaml index 38cb5c736..cce373106 100644 --- a/yaml/asr_with_voice_activity_detection_eng_sg_v1.0.yaml +++ b/yaml/asr_with_voice_activity_detection_eng_sg_v1.0.yaml @@ -67,13 +67,13 @@ paths: application/json: schema: $ref: '#/components/schemas/inputfieldmissing' - '420': + '413': description: Input Limit Exceeded content: application/json: schema: $ref: '#/components/schemas/inputlimitexceeded' - '422': + '415': description: Invalid Input content: application/json: From 265d8c58303a734862b631b066ec9cc2474788b0 Mon Sep 17 00:00:00 2001 From: Priyadharshini <57977344+priyadharshini-sent@users.noreply.github.com> Date: Wed, 10 Feb 2021 10:22:39 +0530 Subject: [PATCH 347/792] Update asr_with_voice_activity_detection_eng_sg.yaml --- yaml/asr_with_voice_activity_detection_eng_sg.yaml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/yaml/asr_with_voice_activity_detection_eng_sg.yaml b/yaml/asr_with_voice_activity_detection_eng_sg.yaml index 06932680c..d69738753 100644 --- a/yaml/asr_with_voice_activity_detection_eng_sg.yaml +++ b/yaml/asr_with_voice_activity_detection_eng_sg.yaml @@ -64,13 +64,13 @@ paths: application/json: schema: $ref: '#/components/schemas/inputfieldmissing' - '420': + '413': description: Input Limit Exceeded content: application/json: schema: $ref: '#/components/schemas/inputlimitexceeded' - '422': + '415': description: Invalid Input content: application/json: From 14f49158bd3b81ebc4ac6e91d185996d296e2054 Mon Sep 17 00:00:00 2001 From: Priyadharshini <57977344+priyadharshini-sent@users.noreply.github.com> Date: Wed, 10 Feb 2021 10:23:02 +0530 Subject: [PATCH 348/792] Update voice_activity_detection_eng_v1.0.yaml --- yaml/voice_activity_detection_eng_v1.0.yaml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/yaml/voice_activity_detection_eng_v1.0.yaml b/yaml/voice_activity_detection_eng_v1.0.yaml index 08a68e644..0ec7ac1cf 100644 --- a/yaml/voice_activity_detection_eng_v1.0.yaml +++ b/yaml/voice_activity_detection_eng_v1.0.yaml @@ -66,13 +66,13 @@ paths: application/json: schema: $ref: '#/components/schemas/inputfieldmissing' - '420': + '413': description: Input Limit Exceeded content: application/json: schema: $ref: '#/components/schemas/inputlimitexceeded' - '422': + '415': description: Invalid Input content: application/json: From cd2789763b6553d4aef2886b5f0a62b092ed7213 Mon Sep 17 00:00:00 2001 From: Priyadharshini <57977344+priyadharshini-sent@users.noreply.github.com> Date: Wed, 10 Feb 2021 10:23:55 +0530 Subject: [PATCH 349/792] Update inverse_text_normalisation_eng_v1.0.yaml --- yaml/inverse_text_normalisation_eng_v1.0.yaml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/yaml/inverse_text_normalisation_eng_v1.0.yaml b/yaml/inverse_text_normalisation_eng_v1.0.yaml index 28ded0d20..63e1e1e8b 100644 --- a/yaml/inverse_text_normalisation_eng_v1.0.yaml +++ b/yaml/inverse_text_normalisation_eng_v1.0.yaml @@ -74,13 +74,13 @@ paths: application/json: schema: $ref: '#/components/schemas/inputfieldmissing' - '420': + '413': description: Input Limit Exceeded content: application/json: schema: $ref: '#/components/schemas/inputlimitexceeded' - '422': + '415': description: Invalid Input content: application/json: From 26c02afaa6423f514b585b50346761a35f0e8e61 Mon Sep 17 00:00:00 2001 From: Priyadharshini <57977344+priyadharshini-sent@users.noreply.github.com> Date: Wed, 10 Feb 2021 10:24:20 +0530 Subject: [PATCH 350/792] Update inverse_text_normalisation_eng.yaml --- yaml/inverse_text_normalisation_eng.yaml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/yaml/inverse_text_normalisation_eng.yaml b/yaml/inverse_text_normalisation_eng.yaml index 9d8a53bfc..10520a858 100644 --- a/yaml/inverse_text_normalisation_eng.yaml +++ b/yaml/inverse_text_normalisation_eng.yaml @@ -71,13 +71,13 @@ paths: application/json: schema: $ref: '#/components/schemas/inputfieldmissing' - '420': + '413': description: Input Limit Exceeded content: application/json: schema: $ref: '#/components/schemas/inputlimitexceeded' - '422': + '415': description: Invalid Input content: application/json: From 7461fc499ec8b274f53d32992c83c7f76ea82c83 Mon Sep 17 00:00:00 2001 From: Priyadharshini <57977344+priyadharshini-sent@users.noreply.github.com> Date: Wed, 10 Feb 2021 10:24:47 +0530 Subject: [PATCH 351/792] Update named-entity_recognition_eng_v1.0.yaml --- yaml/named-entity_recognition_eng_v1.0.yaml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/yaml/named-entity_recognition_eng_v1.0.yaml b/yaml/named-entity_recognition_eng_v1.0.yaml index 9fb6c36cc..b5a977bcf 100644 --- a/yaml/named-entity_recognition_eng_v1.0.yaml +++ b/yaml/named-entity_recognition_eng_v1.0.yaml @@ -64,13 +64,13 @@ paths: application/json: schema: $ref: '#/components/schemas/inputfieldmissing' - '420': + '413': description: Input Limit Exceeded content: application/json: schema: $ref: '#/components/schemas/inputlimitexceeded' - '422': + '415': description: Invalid Input content: application/json: From 2789a91ffc379eda6d331705ca102d5f296e8377 Mon Sep 17 00:00:00 2001 From: Priyadharshini <57977344+priyadharshini-sent@users.noreply.github.com> Date: Wed, 10 Feb 2021 10:25:16 +0530 Subject: [PATCH 352/792] Update named-entity_recognition_eng.yaml --- yaml/named-entity_recognition_eng.yaml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/yaml/named-entity_recognition_eng.yaml b/yaml/named-entity_recognition_eng.yaml index d7afffb37..1a81a8283 100644 --- a/yaml/named-entity_recognition_eng.yaml +++ b/yaml/named-entity_recognition_eng.yaml @@ -85,13 +85,13 @@ paths: application/json: schema: $ref: '#/components/schemas/inputfieldmissing' - '420': + '413': description: Input Limit Exceeded content: application/json: schema: $ref: '#/components/schemas/inputlimitexceeded' - '422': + '415': description: Invalid Input content: application/json: From 3a52c878fffdb47e77c7973f8fc811f7d7a24a1f Mon Sep 17 00:00:00 2001 From: Priyadharshini <57977344+priyadharshini-sent@users.noreply.github.com> Date: Wed, 10 Feb 2021 10:25:45 +0530 Subject: [PATCH 353/792] Update spacy_named-entity_recognition_eng.yaml --- yaml/spacy_named-entity_recognition_eng.yaml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/yaml/spacy_named-entity_recognition_eng.yaml b/yaml/spacy_named-entity_recognition_eng.yaml index 50c75ff93..e911077c7 100644 --- a/yaml/spacy_named-entity_recognition_eng.yaml +++ b/yaml/spacy_named-entity_recognition_eng.yaml @@ -62,13 +62,13 @@ paths: application/json: schema: $ref: '#/components/schemas/inputfieldmissing' - '420': + '413': description: Input Limit Exceeded content: application/json: schema: $ref: '#/components/schemas/inputlimitexceeded' - '422': + '415': description: Invalid Input content: application/json: From 5ee4d013efc8bdf88dcf0b912d337d49a0d57dd0 Mon Sep 17 00:00:00 2001 From: Priyadharshini <57977344+priyadharshini-sent@users.noreply.github.com> Date: Wed, 10 Feb 2021 10:26:12 +0530 Subject: [PATCH 354/792] Update page_profiler_eng_v2.1.yaml --- yaml/page_profiler_eng_v2.1.yaml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/yaml/page_profiler_eng_v2.1.yaml b/yaml/page_profiler_eng_v2.1.yaml index 8efba71b7..5d3d6f532 100644 --- a/yaml/page_profiler_eng_v2.1.yaml +++ b/yaml/page_profiler_eng_v2.1.yaml @@ -61,13 +61,13 @@ application/json: schema: $ref: '#/components/schemas/inputfieldmissing' - '420': + '413': description: Not Found content: application/json: schema: $ref: '#/components/schemas/inputlimitexceeded' - '422': + '415': description: Invalid Input content: application/json: From e15ec21b15ac67baa353e1aa481c226168aa8cb6 Mon Sep 17 00:00:00 2001 From: Priyadharshini <57977344+priyadharshini-sent@users.noreply.github.com> Date: Wed, 10 Feb 2021 10:26:37 +0530 Subject: [PATCH 355/792] Update page_profiler_jp.yaml --- yaml/page_profiler_jp.yaml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/yaml/page_profiler_jp.yaml b/yaml/page_profiler_jp.yaml index fb599849a..853994000 100644 --- a/yaml/page_profiler_jp.yaml +++ b/yaml/page_profiler_jp.yaml @@ -88,13 +88,13 @@ application/json: schema: $ref: '#/components/schemas/inputfieldmissing' - '420': + '413': description: Not Found content: application/json: schema: $ref: '#/components/schemas/inputlimitexceeded' - '422': + '415': description: Invalid Input content: application/json: From a7042bf7fa8887f3d9dbe3c4b5a8ff2309ee7074 Mon Sep 17 00:00:00 2001 From: Priyadharshini <57977344+priyadharshini-sent@users.noreply.github.com> Date: Wed, 10 Feb 2021 10:27:01 +0530 Subject: [PATCH 356/792] Update page_profiler_thai.yaml --- yaml/page_profiler_thai.yaml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/yaml/page_profiler_thai.yaml b/yaml/page_profiler_thai.yaml index 8c28bb2c5..396977e39 100644 --- a/yaml/page_profiler_thai.yaml +++ b/yaml/page_profiler_thai.yaml @@ -94,13 +94,13 @@ application/json: schema: $ref: '#/components/schemas/inputfieldmissing' - '420': + '413': description: Not Found content: application/json: schema: $ref: '#/components/schemas/inputlimitexceeded' - '422': + '415': description: Invalid Input content: application/json: From 1e0bddff0579c3e1af7af49641304672616c7045 Mon Sep 17 00:00:00 2001 From: Priyadharshini <57977344+priyadharshini-sent@users.noreply.github.com> Date: Wed, 10 Feb 2021 10:27:25 +0530 Subject: [PATCH 357/792] Update taxonomy_matcher_eng_v1.0.yaml --- yaml/taxonomy_matcher_eng_v1.0.yaml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/yaml/taxonomy_matcher_eng_v1.0.yaml b/yaml/taxonomy_matcher_eng_v1.0.yaml index e689178c7..5ed626a30 100644 --- a/yaml/taxonomy_matcher_eng_v1.0.yaml +++ b/yaml/taxonomy_matcher_eng_v1.0.yaml @@ -74,13 +74,13 @@ paths: application/json: schema: $ref: '#/components/schemas/inputfieldmissing' - '420': + '413': description: Input Limit Exceeded content: application/json: schema: $ref: '#/components/schemas/inputlimitexceeded' - '422': + '415': description: Invalid Input content: application/json: From f02a804134f86b61e50b7beded2e17c9424514ed Mon Sep 17 00:00:00 2001 From: Priyadharshini <57977344+priyadharshini-sent@users.noreply.github.com> Date: Wed, 10 Feb 2021 10:27:52 +0530 Subject: [PATCH 358/792] Update taxonomy_matcher_eng.yaml --- yaml/taxonomy_matcher_eng.yaml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/yaml/taxonomy_matcher_eng.yaml b/yaml/taxonomy_matcher_eng.yaml index be8e2ad41..8d91029eb 100644 --- a/yaml/taxonomy_matcher_eng.yaml +++ b/yaml/taxonomy_matcher_eng.yaml @@ -72,13 +72,13 @@ paths: application/json: schema: $ref: '#/components/schemas/inputfieldmissing' - '420': + '413': description: Input Limit Exceeded content: application/json: schema: $ref: '#/components/schemas/inputlimitexceeded' - '422': + '415': description: Invalid Input content: application/json: From 150839b75ebc9a6107db3cffde21ff6aef1cc459 Mon Sep 17 00:00:00 2001 From: Priyadharshini <57977344+priyadharshini-sent@users.noreply.github.com> Date: Wed, 10 Feb 2021 10:28:16 +0530 Subject: [PATCH 359/792] Update word_sense_disambiguation_eng_v1.0.yaml --- yaml/word_sense_disambiguation_eng_v1.0.yaml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/yaml/word_sense_disambiguation_eng_v1.0.yaml b/yaml/word_sense_disambiguation_eng_v1.0.yaml index 9a803cb7a..d712762b6 100644 --- a/yaml/word_sense_disambiguation_eng_v1.0.yaml +++ b/yaml/word_sense_disambiguation_eng_v1.0.yaml @@ -82,13 +82,13 @@ paths: application/json: schema: $ref: '#/components/schemas/inputfieldmissing' - '420': + '413': description: Input Limit Exceeded content: application/json: schema: $ref: '#/components/schemas/inputlimitexceeded' - '422': + '415': description: Invalid Input content: application/json: From 1d5b4641f55b3dc70700587b6f2eb2d2972b0a54 Mon Sep 17 00:00:00 2001 From: Priyadharshini <57977344+priyadharshini-sent@users.noreply.github.com> Date: Wed, 10 Feb 2021 10:28:40 +0530 Subject: [PATCH 360/792] Update word_sense_disambiguation_eng.yaml --- yaml/word_sense_disambiguation_eng.yaml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/yaml/word_sense_disambiguation_eng.yaml b/yaml/word_sense_disambiguation_eng.yaml index 912364568..426f47c0a 100644 --- a/yaml/word_sense_disambiguation_eng.yaml +++ b/yaml/word_sense_disambiguation_eng.yaml @@ -78,13 +78,13 @@ paths: application/json: schema: $ref: '#/components/schemas/inputfieldmissing' - '420': + '413': description: Input Limit Exceeded content: application/json: schema: $ref: '#/components/schemas/inputlimitexceeded' - '422': + '415': description: Invalid Input content: application/json: From 9ded2e8123851eff4155d90e73018efc3c653628 Mon Sep 17 00:00:00 2001 From: Priyadharshini <57977344+priyadharshini-sent@users.noreply.github.com> Date: Wed, 10 Feb 2021 10:29:09 +0530 Subject: [PATCH 361/792] Update named-entity_recognition_jp_v1.0.yaml --- yaml/named-entity_recognition_jp_v1.0.yaml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/yaml/named-entity_recognition_jp_v1.0.yaml b/yaml/named-entity_recognition_jp_v1.0.yaml index 0eaecdc5c..289adcfa0 100644 --- a/yaml/named-entity_recognition_jp_v1.0.yaml +++ b/yaml/named-entity_recognition_jp_v1.0.yaml @@ -90,13 +90,13 @@ paths: application/json: schema: $ref: '#/components/schemas/inputfieldmissing' - '420': + '413': description: Input Limit Exceeded content: application/json: schema: $ref: '#/components/schemas/inputlimitexceeded' - '422': + '415': description: Invalid Input content: application/json: From e0b112e6a7f794a7a8a4fb1ef30c223286c77435 Mon Sep 17 00:00:00 2001 From: Priyadharshini <57977344+priyadharshini-sent@users.noreply.github.com> Date: Wed, 10 Feb 2021 10:29:39 +0530 Subject: [PATCH 362/792] Update named-entity_recognition_jp.yaml --- yaml/named-entity_recognition_jp.yaml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/yaml/named-entity_recognition_jp.yaml b/yaml/named-entity_recognition_jp.yaml index e121ab660..c97d551bc 100644 --- a/yaml/named-entity_recognition_jp.yaml +++ b/yaml/named-entity_recognition_jp.yaml @@ -79,13 +79,13 @@ paths: application/json: schema: $ref: '#/components/schemas/inputfieldmissing' - '420': + '413': description: Input Limit Exceeded content: application/json: schema: $ref: '#/components/schemas/inputlimitexceeded' - '422': + '415': description: Invalid Input content: application/json: From 7e8b80de3a79f54c111bb98401cbb6430ba94050 Mon Sep 17 00:00:00 2001 From: Priyadharshini <57977344+priyadharshini-sent@users.noreply.github.com> Date: Wed, 10 Feb 2021 10:30:07 +0530 Subject: [PATCH 363/792] Update named-entity_recognition_thai_v1.0.yaml --- yaml/named-entity_recognition_thai_v1.0.yaml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/yaml/named-entity_recognition_thai_v1.0.yaml b/yaml/named-entity_recognition_thai_v1.0.yaml index ed37b958a..0578e3883 100644 --- a/yaml/named-entity_recognition_thai_v1.0.yaml +++ b/yaml/named-entity_recognition_thai_v1.0.yaml @@ -86,13 +86,13 @@ paths: application/json: schema: $ref: '#/components/schemas/inputfieldmissing' - '420': + '413': description: Input Limit Exceeded content: application/json: schema: $ref: '#/components/schemas/inputlimitexceeded' - '422': + '415': description: Invalid Input content: application/json: From 17c5891ef3444f4b0a769a0caa172ac5487cf769 Mon Sep 17 00:00:00 2001 From: Priyadharshini <57977344+priyadharshini-sent@users.noreply.github.com> Date: Wed, 10 Feb 2021 10:30:35 +0530 Subject: [PATCH 364/792] Update named-entity_recognition_thai.yaml --- yaml/named-entity_recognition_thai.yaml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/yaml/named-entity_recognition_thai.yaml b/yaml/named-entity_recognition_thai.yaml index 3b0d40163..46968c45a 100644 --- a/yaml/named-entity_recognition_thai.yaml +++ b/yaml/named-entity_recognition_thai.yaml @@ -69,13 +69,13 @@ paths: application/json: schema: $ref: '#/components/schemas/inputfieldmissing' - '420': + '413': description: Input Limit Exceeded content: application/json: schema: $ref: '#/components/schemas/inputlimitexceeded' - '422': + '415': description: Invalid Input content: application/json: From 72d3e8051a2ad0dc0162481f7b207a3302035300 Mon Sep 17 00:00:00 2001 From: Priyadharshini <57977344+priyadharshini-sent@users.noreply.github.com> Date: Wed, 10 Feb 2021 10:30:59 +0530 Subject: [PATCH 365/792] Update script_alignment_v1.0.yaml --- yaml/script_alignment_v1.0.yaml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/yaml/script_alignment_v1.0.yaml b/yaml/script_alignment_v1.0.yaml index c13dce0cc..c5df6824b 100644 --- a/yaml/script_alignment_v1.0.yaml +++ b/yaml/script_alignment_v1.0.yaml @@ -65,13 +65,13 @@ paths: application/json: schema: $ref: '#/components/schemas/inputfieldmissing' - '420': + '413': description: Input Limit Exceeded content: application/json: schema: $ref: '#/components/schemas/inputlimitexceeded' - '422': + '415': description: Invalid Input content: application/json: From 5f824799adc3e619de5a536859e6b0d442594824 Mon Sep 17 00:00:00 2001 From: Priyadharshini <57977344+priyadharshini-sent@users.noreply.github.com> Date: Wed, 10 Feb 2021 10:31:23 +0530 Subject: [PATCH 366/792] Update script_alignment.yaml --- yaml/script_alignment.yaml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/yaml/script_alignment.yaml b/yaml/script_alignment.yaml index 15557c07e..a01255526 100644 --- a/yaml/script_alignment.yaml +++ b/yaml/script_alignment.yaml @@ -60,13 +60,13 @@ paths: application/json: schema: $ref: '#/components/schemas/inputfieldmissing' - '420': + '413': description: Input Limit Exceeded content: application/json: schema: $ref: '#/components/schemas/inputlimitexceeded' - '422': + '415': description: Invalid Input content: application/json: From f2566f618debccedbb0e92a7e03225d539ec474a Mon Sep 17 00:00:00 2001 From: Priyadharshini <57977344+priyadharshini-sent@users.noreply.github.com> Date: Wed, 10 Feb 2021 10:32:18 +0530 Subject: [PATCH 367/792] Update object_detection.yaml --- yaml/object_detection.yaml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/yaml/object_detection.yaml b/yaml/object_detection.yaml index 38dd04129..d2025b37d 100644 --- a/yaml/object_detection.yaml +++ b/yaml/object_detection.yaml @@ -67,13 +67,13 @@ paths: application/json: schema: $ref: '#/components/schemas/inputfieldmissing' - '420': + '413': description: Input Limit Exceeded content: application/json: schema: $ref: '#/components/schemas/inputlimitexceeded' - '422': + '415': description: Invalid Input content: application/json: From 870a39402141f2d7e02f6a187718e0d42feab3fa Mon Sep 17 00:00:00 2001 From: Priyadharshini <57977344+priyadharshini-sent@users.noreply.github.com> Date: Wed, 10 Feb 2021 10:32:51 +0530 Subject: [PATCH 368/792] Update face_recognition_v1.0.yaml --- yaml/face_recognition_v1.0.yaml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/yaml/face_recognition_v1.0.yaml b/yaml/face_recognition_v1.0.yaml index 94bd1316e..f26455b36 100644 --- a/yaml/face_recognition_v1.0.yaml +++ b/yaml/face_recognition_v1.0.yaml @@ -114,13 +114,13 @@ paths: application/json: schema: $ref: '#/components/schemas/inputfieldmissing' - '420': + '413': description: Input Limit Exceeded content: application/json: schema: $ref: '#/components/schemas/inputlimitexceeded' - '422': + '415': description: Invalid Input content: application/json: From a9501f8b7bfcd05cc457bd54359965cb8752fbd8 Mon Sep 17 00:00:00 2001 From: Priyadharshini <57977344+priyadharshini-sent@users.noreply.github.com> Date: Wed, 10 Feb 2021 10:33:14 +0530 Subject: [PATCH 369/792] Update face_recognition_politicians_sg.yaml --- yaml/face_recognition_politicians_sg.yaml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/yaml/face_recognition_politicians_sg.yaml b/yaml/face_recognition_politicians_sg.yaml index e2d4f0946..926daba86 100644 --- a/yaml/face_recognition_politicians_sg.yaml +++ b/yaml/face_recognition_politicians_sg.yaml @@ -61,13 +61,13 @@ paths: application/json: schema: $ref: '#/components/schemas/inputfieldmissing' - '420': + '413': description: Input Limit Exceeded content: application/json: schema: $ref: '#/components/schemas/inputlimitexceeded' - '422': + '415': description: Invalid Input content: application/json: From b6812d684319cd6b6fff356e4debf10a3365aa18 Mon Sep 17 00:00:00 2001 From: Priyadharshini <57977344+priyadharshini-sent@users.noreply.github.com> Date: Wed, 10 Feb 2021 10:33:41 +0530 Subject: [PATCH 370/792] Update people_counting.yaml --- yaml/people_counting.yaml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/yaml/people_counting.yaml b/yaml/people_counting.yaml index c34343987..56f42c7b0 100644 --- a/yaml/people_counting.yaml +++ b/yaml/people_counting.yaml @@ -62,13 +62,13 @@ paths: application/json: schema: $ref: '#/components/schemas/inputfieldmissing' - '420': + '413': description: Input Limit Exceeded content: application/json: schema: $ref: '#/components/schemas/inputlimitexceeded' - '422': + '415': description: Invalid Input content: application/json: From c90a20f1b63773fccdbdbebf053f87f2d92ca109 Mon Sep 17 00:00:00 2001 From: Priyadharshini <57977344+priyadharshini-sent@users.noreply.github.com> Date: Wed, 10 Feb 2021 10:34:02 +0530 Subject: [PATCH 371/792] Update landmark_detection_sg.yaml --- yaml/landmark_detection_sg.yaml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/yaml/landmark_detection_sg.yaml b/yaml/landmark_detection_sg.yaml index c98c8eee1..445b27108 100644 --- a/yaml/landmark_detection_sg.yaml +++ b/yaml/landmark_detection_sg.yaml @@ -64,13 +64,13 @@ paths: application/json: schema: $ref: '#/components/schemas/inputfieldmissing' - '420': + '413': description: Input Limit Exceeded content: application/json: schema: $ref: '#/components/schemas/inputlimitexceeded' - '422': + '415': description: Invalid Input content: application/json: From a55e119ce83f2e21d688f6c40c8dbfe99033449a Mon Sep 17 00:00:00 2001 From: Priyadharshini <57977344+priyadharshini-sent@users.noreply.github.com> Date: Wed, 10 Feb 2021 10:34:26 +0530 Subject: [PATCH 372/792] Update landmark_detection_jp.yaml --- yaml/landmark_detection_jp.yaml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/yaml/landmark_detection_jp.yaml b/yaml/landmark_detection_jp.yaml index a99d082d8..aa0e23555 100644 --- a/yaml/landmark_detection_jp.yaml +++ b/yaml/landmark_detection_jp.yaml @@ -62,13 +62,13 @@ paths: application/json: schema: $ref: '#/components/schemas/inputfieldmissing' - '420': + '413': description: Input Limit Exceeded content: application/json: schema: $ref: '#/components/schemas/inputlimitexceeded' - '422': + '415': description: Invalid Input content: application/json: From 7a2d618d74f4f7e970703b98ba356dd1f6099a05 Mon Sep 17 00:00:00 2001 From: Priyadharshini <57977344+priyadharshini-sent@users.noreply.github.com> Date: Wed, 10 Feb 2021 10:34:51 +0530 Subject: [PATCH 373/792] Update demographics_classification.yaml --- yaml/demographics_classification.yaml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/yaml/demographics_classification.yaml b/yaml/demographics_classification.yaml index ed41a3f1c..6fa1083f6 100644 --- a/yaml/demographics_classification.yaml +++ b/yaml/demographics_classification.yaml @@ -70,13 +70,13 @@ paths: application/json: schema: $ref: '#/components/schemas/inputfieldmissing' - '420': + '413': description: Input Limit Exceeded content: application/json: schema: $ref: '#/components/schemas/inputlimitexceeded' - '422': + '415': description: Invalid Input content: application/json: From fa6927b2ed283056e6a936dce827b9495453a66d Mon Sep 17 00:00:00 2001 From: Priyadharshini <57977344+priyadharshini-sent@users.noreply.github.com> Date: Wed, 10 Feb 2021 10:35:13 +0530 Subject: [PATCH 374/792] Update youtube_video_downloader.yaml --- yaml/youtube_video_downloader.yaml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/yaml/youtube_video_downloader.yaml b/yaml/youtube_video_downloader.yaml index 3f6328aaa..2975beb08 100644 --- a/yaml/youtube_video_downloader.yaml +++ b/yaml/youtube_video_downloader.yaml @@ -60,13 +60,13 @@ paths: application/json: schema: $ref: '#/components/schemas/inputfieldmissing' - '420': + '413': description: Input Limit Exceeded content: application/json: schema: $ref: '#/components/schemas/inputlimitexceeded' - '422': + '415': description: Invalid Input content: application/json: From c9cedee30d4cde76fa6d0d2f289b87960e9060d6 Mon Sep 17 00:00:00 2001 From: Priyadharshini <57977344+priyadharshini-sent@users.noreply.github.com> Date: Wed, 10 Feb 2021 10:35:40 +0530 Subject: [PATCH 375/792] Update video-to-audio_convertor.yaml --- yaml/video-to-audio_convertor.yaml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/yaml/video-to-audio_convertor.yaml b/yaml/video-to-audio_convertor.yaml index f7e88c519..febe39416 100644 --- a/yaml/video-to-audio_convertor.yaml +++ b/yaml/video-to-audio_convertor.yaml @@ -62,13 +62,13 @@ paths: application/json: schema: $ref: '#/components/schemas/inputfieldmissing' - '420': + '413': description: Input Limit Exceeded content: application/json: schema: $ref: '#/components/schemas/inputlimitexceeded' - '422': + '415': description: Invalid Input content: application/json: From 5aa04db159b24d90a23049182a2d6ef1c402381c Mon Sep 17 00:00:00 2001 From: Priyadharshini <57977344+priyadharshini-sent@users.noreply.github.com> Date: Wed, 10 Feb 2021 10:36:06 +0530 Subject: [PATCH 376/792] Update web_scraper.yaml --- yaml/web_scraper.yaml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/yaml/web_scraper.yaml b/yaml/web_scraper.yaml index 2f94a754d..565429bdb 100644 --- a/yaml/web_scraper.yaml +++ b/yaml/web_scraper.yaml @@ -125,13 +125,13 @@ paths: application/json: schema: $ref: '#/components/schemas/inputfieldmissing' - '420': + '413': description: Input Limit Exceeded content: application/json: schema: $ref: '#/components/schemas/inputlimitexceeded' - '422': + '415': description: Invalid Input content: application/json: From eb161895e7ac899222ff2b0daa0f3381f44f61e7 Mon Sep 17 00:00:00 2001 From: Priyadharshini <57977344+priyadharshini-sent@users.noreply.github.com> Date: Wed, 10 Feb 2021 10:36:29 +0530 Subject: [PATCH 377/792] Update document_convertor_eng.yaml --- yaml/document_convertor_eng.yaml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/yaml/document_convertor_eng.yaml b/yaml/document_convertor_eng.yaml index 78efaf409..05cf17edd 100644 --- a/yaml/document_convertor_eng.yaml +++ b/yaml/document_convertor_eng.yaml @@ -67,13 +67,13 @@ paths: application/json: schema: $ref: '#/components/schemas/inputfieldmissing' - '420': + '413': description: Input Limit Exceeded content: application/json: schema: $ref: '#/components/schemas/inputlimitexceeded' - '422': + '415': description: Invalid Input content: application/json: From 2e24e339f1900d0e90ae5e6ffda43e753d436410 Mon Sep 17 00:00:00 2001 From: Priyadharshini <57977344+priyadharshini-sent@users.noreply.github.com> Date: Wed, 10 Feb 2021 10:36:52 +0530 Subject: [PATCH 378/792] Update pdf_extractor.yaml --- yaml/pdf_extractor.yaml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/yaml/pdf_extractor.yaml b/yaml/pdf_extractor.yaml index 39515145c..69e7aaf66 100644 --- a/yaml/pdf_extractor.yaml +++ b/yaml/pdf_extractor.yaml @@ -74,13 +74,13 @@ paths: application/json: schema: $ref: '#/components/schemas/inputfieldmissing' - '420': + '413': description: Input Limit Exceeded content: application/json: schema: $ref: '#/components/schemas/inputlimitexceeded' - '422': + '415': description: Invalid Input content: application/json: From 23f4c2c8b24b9206452ab6722b3e0bb4d46afecd Mon Sep 17 00:00:00 2001 From: Priyadharshini <57977344+priyadharshini-sent@users.noreply.github.com> Date: Wed, 10 Feb 2021 10:37:19 +0530 Subject: [PATCH 379/792] Update pki_key_generator.yaml --- yaml/pki_key_generator.yaml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/yaml/pki_key_generator.yaml b/yaml/pki_key_generator.yaml index 6fd6f6a75..4bb84d56a 100644 --- a/yaml/pki_key_generator.yaml +++ b/yaml/pki_key_generator.yaml @@ -59,13 +59,13 @@ paths: application/json: schema: $ref: '#/components/schemas/inputfieldmissing' - '420': + '413: description: Input Limit Exceeded content: application/json: schema: $ref: '#/components/schemas/inputlimitexceeded' - '422': + '415': description: Invalid Input content: application/json: From 7ea81802eb249103b49e2055f2f1ea67b14efb21 Mon Sep 17 00:00:00 2001 From: Priyadharshini <57977344+priyadharshini-sent@users.noreply.github.com> Date: Wed, 10 Feb 2021 10:38:05 +0530 Subject: [PATCH 380/792] Update encryption_using_pki_key.yaml --- yaml/encryption_using_pki_key.yaml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/yaml/encryption_using_pki_key.yaml b/yaml/encryption_using_pki_key.yaml index d4e435ec7..89f64add2 100644 --- a/yaml/encryption_using_pki_key.yaml +++ b/yaml/encryption_using_pki_key.yaml @@ -63,13 +63,13 @@ paths: application/json: schema: $ref: '#/components/schemas/inputfieldmissing' - '420': + '413': description: Input Limit Exceeded content: application/json: schema: $ref: '#/components/schemas/inputlimitexceeded' - '422': + '415': description: Invalid Input content: application/json: From 2b523e400482b901c50c90373e9184d2d5ab7da3 Mon Sep 17 00:00:00 2001 From: Priyadharshini <57977344+priyadharshini-sent@users.noreply.github.com> Date: Wed, 10 Feb 2021 10:38:35 +0530 Subject: [PATCH 381/792] Update decryption_using_pki_key.yaml --- yaml/decryption_using_pki_key.yaml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/yaml/decryption_using_pki_key.yaml b/yaml/decryption_using_pki_key.yaml index a74ba60d9..737ef9ce6 100644 --- a/yaml/decryption_using_pki_key.yaml +++ b/yaml/decryption_using_pki_key.yaml @@ -63,13 +63,13 @@ paths: application/json: schema: $ref: '#/components/schemas/inputfieldmissing' - '420': + '413': description: Input Limit Exceeded content: application/json: schema: $ref: '#/components/schemas/inputlimitexceeded' - '422': + '415': description: Invalid Input content: application/json: From 68a2660cb3ad7a89e224030d064e92d803f7ab40 Mon Sep 17 00:00:00 2001 From: Priyadharshini <57977344+priyadharshini-sent@users.noreply.github.com> Date: Wed, 10 Feb 2021 10:38:58 +0530 Subject: [PATCH 382/792] Update wikipedia_retrieval_v1.0.yaml --- yaml/wikipedia_retrieval_v1.0.yaml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/yaml/wikipedia_retrieval_v1.0.yaml b/yaml/wikipedia_retrieval_v1.0.yaml index d73416533..b423cc9b8 100644 --- a/yaml/wikipedia_retrieval_v1.0.yaml +++ b/yaml/wikipedia_retrieval_v1.0.yaml @@ -85,13 +85,13 @@ paths: application/json: schema: $ref: '#/components/schemas/inputfieldmissing' - '420': + '413': description: Input Limit Exceeded content: application/json: schema: $ref: '#/components/schemas/inputlimitexceeded' - '422': + '415': description: Invalid Input content: application/json: From 73ad70438d39f0167e48cdb8d9f661e7f4f731e0 Mon Sep 17 00:00:00 2001 From: Priyadharshini <57977344+priyadharshini-sent@users.noreply.github.com> Date: Wed, 10 Feb 2021 10:39:23 +0530 Subject: [PATCH 383/792] Update wikipedia_retrieval.yaml --- yaml/wikipedia_retrieval.yaml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/yaml/wikipedia_retrieval.yaml b/yaml/wikipedia_retrieval.yaml index 85821cfde..4e8891646 100644 --- a/yaml/wikipedia_retrieval.yaml +++ b/yaml/wikipedia_retrieval.yaml @@ -81,13 +81,13 @@ paths: application/json: schema: $ref: '#/components/schemas/inputfieldmissing' - '420': + '413': description: Input Limit Exceeded content: application/json: schema: $ref: '#/components/schemas/inputlimitexceeded' - '422': + '415': description: Invalid Input content: application/json: From 78d7b143bf57c6810ed769ecf3f88174185367b4 Mon Sep 17 00:00:00 2001 From: Priyadharshini <57977344+priyadharshini-sent@users.noreply.github.com> Date: Wed, 10 Feb 2021 10:39:45 +0530 Subject: [PATCH 384/792] Update json-csv_convertor.yaml --- yaml/json-csv_convertor.yaml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/yaml/json-csv_convertor.yaml b/yaml/json-csv_convertor.yaml index fa7493441..bd89410b6 100644 --- a/yaml/json-csv_convertor.yaml +++ b/yaml/json-csv_convertor.yaml @@ -60,13 +60,13 @@ paths: application/json: schema: $ref: '#/components/schemas/inputfieldmissing' - '420': + '413': description: Input Limit Exceeded content: application/json: schema: $ref: '#/components/schemas/inputlimitexceeded' - '422': + '415': description: Invalid Input content: application/json: From 3e4b7fd8a44e35afe90aad219aef2c7a6fa94259 Mon Sep 17 00:00:00 2001 From: Priyadharshini <57977344+priyadharshini-sent@users.noreply.github.com> Date: Wed, 10 Feb 2021 10:40:08 +0530 Subject: [PATCH 385/792] Update csv-json_convertor.yaml --- yaml/csv-json_convertor.yaml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/yaml/csv-json_convertor.yaml b/yaml/csv-json_convertor.yaml index 787783873..fd4177318 100644 --- a/yaml/csv-json_convertor.yaml +++ b/yaml/csv-json_convertor.yaml @@ -63,13 +63,13 @@ paths: application/json: schema: $ref: '#/components/schemas/inputfieldmissing' - '420': + '413': description: Input Limit Exceeded content: application/json: schema: $ref: '#/components/schemas/inputlimitexceeded' - '422': + '415': description: Invalid Input content: application/json: From ee3d9117ac56193012f84df2bc923af3f14a6834 Mon Sep 17 00:00:00 2001 From: Priyadharshini <57977344+priyadharshini-sent@users.noreply.github.com> Date: Wed, 10 Feb 2021 10:40:29 +0530 Subject: [PATCH 386/792] Update audio_format_convertor.yaml --- yaml/audio_format_convertor.yaml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/yaml/audio_format_convertor.yaml b/yaml/audio_format_convertor.yaml index 49e7ef64c..5fb6e071e 100644 --- a/yaml/audio_format_convertor.yaml +++ b/yaml/audio_format_convertor.yaml @@ -62,13 +62,13 @@ paths: application/json: schema: $ref: '#/components/schemas/inputfieldmissing' - '420': + '413': description: Input Limit Exceeded content: application/json: schema: $ref: '#/components/schemas/inputlimitexceeded' - '422': + '415': description: Invalid Input content: application/json: From 91959fe3dc58ba61b8d5cf43a530c0da4b1141c4 Mon Sep 17 00:00:00 2001 From: Priyadharshini <57977344+priyadharshini-sent@users.noreply.github.com> Date: Wed, 10 Feb 2021 10:40:53 +0530 Subject: [PATCH 387/792] Update video-to-image_convertor.yaml --- yaml/video-to-image_convertor.yaml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/yaml/video-to-image_convertor.yaml b/yaml/video-to-image_convertor.yaml index cbb23d1df..bb2b996ee 100644 --- a/yaml/video-to-image_convertor.yaml +++ b/yaml/video-to-image_convertor.yaml @@ -62,13 +62,13 @@ paths: application/json: schema: $ref: '#/components/schemas/inputfieldmissing' - '420': + '413': description: Input Limit Exceeded content: application/json: schema: $ref: '#/components/schemas/inputlimitexceeded' - '422': + '415': description: Invalid Input content: application/json: From f2f4a5c3a29dbefeef998ab83e5808311c105567 Mon Sep 17 00:00:00 2001 From: Priyadharshini <57977344+priyadharshini-sent@users.noreply.github.com> Date: Wed, 10 Feb 2021 10:41:22 +0530 Subject: [PATCH 388/792] Update newspaper_article_scraper.yaml --- yaml/newspaper_article_scraper.yaml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/yaml/newspaper_article_scraper.yaml b/yaml/newspaper_article_scraper.yaml index 974d8d690..dcefbee00 100644 --- a/yaml/newspaper_article_scraper.yaml +++ b/yaml/newspaper_article_scraper.yaml @@ -99,13 +99,13 @@ paths: application/json: schema: $ref: '#/components/schemas/inputfieldmissing' - '420': + '413': description: Input Limit Exceeded content: application/json: schema: $ref: '#/components/schemas/inputlimitexceeded' - '422': + '415': description: Invalid Input content: application/json: From 760d01a5bc1fdf527f1eb978a79c50987d6fcc56 Mon Sep 17 00:00:00 2001 From: Priyadharshini <57977344+priyadharshini-sent@users.noreply.github.com> Date: Wed, 10 Feb 2021 10:41:45 +0530 Subject: [PATCH 389/792] Update urls_retrieval.yaml --- yaml/urls_retrieval.yaml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/yaml/urls_retrieval.yaml b/yaml/urls_retrieval.yaml index bb6d21935..fe63ae65d 100644 --- a/yaml/urls_retrieval.yaml +++ b/yaml/urls_retrieval.yaml @@ -69,13 +69,13 @@ paths: application/json: schema: $ref: '#/components/schemas/inputfieldmissing' - '420': + '413': description: Input Limit Exceeded content: application/json: schema: $ref: '#/components/schemas/inputlimitexceeded' - '422': + '415': description: Invalid Input content: application/json: From 034bad237f330a15ac832cae811417248a337dfe Mon Sep 17 00:00:00 2001 From: Priyadharshini <57977344+priyadharshini-sent@users.noreply.github.com> Date: Wed, 10 Feb 2021 10:42:12 +0530 Subject: [PATCH 390/792] Update base64-encoder.yaml --- yaml/base64-encoder.yaml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/yaml/base64-encoder.yaml b/yaml/base64-encoder.yaml index 00266a723..7bf6b5c92 100644 --- a/yaml/base64-encoder.yaml +++ b/yaml/base64-encoder.yaml @@ -60,13 +60,13 @@ paths: application/json: schema: $ref: '#/components/schemas/inputfieldmissing' - '420': + '413': description: Input Limit Exceeded content: application/json: schema: $ref: '#/components/schemas/inputlimitexceeded' - '422': + '415': description: Invalid Input content: application/json: From 19912b8f726e0e8e76afc4b655727a200166382e Mon Sep 17 00:00:00 2001 From: Priyadharshini <57977344+priyadharshini-sent@users.noreply.github.com> Date: Wed, 10 Feb 2021 10:42:35 +0530 Subject: [PATCH 391/792] Update base64-decoder.yaml --- yaml/base64-decoder.yaml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/yaml/base64-decoder.yaml b/yaml/base64-decoder.yaml index 720f208c7..88700c389 100644 --- a/yaml/base64-decoder.yaml +++ b/yaml/base64-decoder.yaml @@ -59,13 +59,13 @@ paths: application/json: schema: $ref: '#/components/schemas/inputfieldmissing' - '420': + '413': description: Input Limit Exceeded content: application/json: schema: $ref: '#/components/schemas/inputlimitexceeded' - '422': + '415': description: Invalid Input content: application/json: From 1cba1e441db5d5561ac431d263f462df24917634 Mon Sep 17 00:00:00 2001 From: Priyadharshini <57977344+priyadharshini-sent@users.noreply.github.com> Date: Wed, 10 Feb 2021 10:43:00 +0530 Subject: [PATCH 392/792] Update commercial_directories_hdb_sg.yaml --- yaml/commercial_directories_hdb_sg.yaml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/yaml/commercial_directories_hdb_sg.yaml b/yaml/commercial_directories_hdb_sg.yaml index e4b59c2e8..8de02e396 100644 --- a/yaml/commercial_directories_hdb_sg.yaml +++ b/yaml/commercial_directories_hdb_sg.yaml @@ -228,13 +228,13 @@ paths: application/json: schema: $ref: '#/components/schemas/inputfieldmissing' - '420': + '413': description: Input Limit Exceeded content: application/json: schema: $ref: '#/components/schemas/inputlimitexceeded' - '422': + '415': description: Invalid Input content: application/json: From 920664b9e9fb618a0ba98f4dc42edebd1e2b36b7 Mon Sep 17 00:00:00 2001 From: Priyadharshini <57977344+priyadharshini-sent@users.noreply.github.com> Date: Wed, 10 Feb 2021 10:43:41 +0530 Subject: [PATCH 393/792] Update building_addresses_hdb_sg.yaml --- yaml/building_addresses_hdb_sg.yaml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/yaml/building_addresses_hdb_sg.yaml b/yaml/building_addresses_hdb_sg.yaml index 5a313b292..78aeb1ee9 100644 --- a/yaml/building_addresses_hdb_sg.yaml +++ b/yaml/building_addresses_hdb_sg.yaml @@ -198,13 +198,13 @@ paths: application/json: schema: $ref: '#/components/schemas/inputfieldmissing' - '420': + '413': description: Input Limit Exceeded content: application/json: schema: $ref: '#/components/schemas/inputlimitexceeded' - '422': + '415': description: Invalid Input content: application/json: From df03e35829adbdc2a84b343b81ee46aed8f3a5da Mon Sep 17 00:00:00 2001 From: Priyadharshini <57977344+priyadharshini-sent@users.noreply.github.com> Date: Wed, 10 Feb 2021 10:44:04 +0530 Subject: [PATCH 394/792] Update residential_sales_and_rental_hdb_sg.yaml --- yaml/residential_sales_and_rental_hdb_sg.yaml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/yaml/residential_sales_and_rental_hdb_sg.yaml b/yaml/residential_sales_and_rental_hdb_sg.yaml index f0b27a902..3e298bc09 100644 --- a/yaml/residential_sales_and_rental_hdb_sg.yaml +++ b/yaml/residential_sales_and_rental_hdb_sg.yaml @@ -211,13 +211,13 @@ paths: application/json: schema: $ref: '#/components/schemas/inputfieldmissing' - '420': + '413': description: Input Limit Exceeded content: application/json: schema: $ref: '#/components/schemas/inputlimitexceeded' - '422': + '415': description: Invalid Input content: application/json: From 115a8b3fcb2d22ddc569414f2bdf2b04574a4f41 Mon Sep 17 00:00:00 2001 From: Priyadharshini <57977344+priyadharshini-sent@users.noreply.github.com> Date: Wed, 10 Feb 2021 10:44:29 +0530 Subject: [PATCH 395/792] Update carpark_hdb_sg.yaml --- yaml/carpark_hdb_sg.yaml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/yaml/carpark_hdb_sg.yaml b/yaml/carpark_hdb_sg.yaml index a4f6f666b..e3f0a2708 100644 --- a/yaml/carpark_hdb_sg.yaml +++ b/yaml/carpark_hdb_sg.yaml @@ -247,13 +247,13 @@ paths: application/json: schema: $ref: '#/components/schemas/inputfieldmissing' - '420': + '413': description: Input Limit Exceeded content: application/json: schema: $ref: '#/components/schemas/inputlimitexceeded' - '422': + '415': description: Invalid Input content: application/json: From 47b58c01a3433b7aaa8f1e7c08e6221bb5b835cd Mon Sep 17 00:00:00 2001 From: Priyadharshini <57977344+priyadharshini-sent@users.noreply.github.com> Date: Wed, 10 Feb 2021 10:45:32 +0530 Subject: [PATCH 396/792] Update demographics_hdb_sg.yaml --- yaml/demographics_hdb_sg.yaml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/yaml/demographics_hdb_sg.yaml b/yaml/demographics_hdb_sg.yaml index c076f3086..bc9353022 100644 --- a/yaml/demographics_hdb_sg.yaml +++ b/yaml/demographics_hdb_sg.yaml @@ -194,13 +194,13 @@ paths: application/json: schema: $ref: '#/components/schemas/inputfieldmissing' - '420': + '413': description: Input Limit Exceeded content: application/json: schema: $ref: '#/components/schemas/inputlimitexceeded' - '422': + '415': description: Invalid Input content: application/json: From 00abccedf5cffc776ec9cece71413ccddf459d14 Mon Sep 17 00:00:00 2001 From: Priyadharshini <57977344+priyadharshini-sent@users.noreply.github.com> Date: Wed, 10 Feb 2021 10:46:00 +0530 Subject: [PATCH 397/792] Update flat_ownership_hdb_sg.yaml --- yaml/flat_ownership_hdb_sg.yaml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/yaml/flat_ownership_hdb_sg.yaml b/yaml/flat_ownership_hdb_sg.yaml index c870ddf02..0961fd126 100644 --- a/yaml/flat_ownership_hdb_sg.yaml +++ b/yaml/flat_ownership_hdb_sg.yaml @@ -199,13 +199,13 @@ paths: application/json: schema: $ref: '#/components/schemas/inputfieldmissing' - '420': + '413': description: Input Limit Exceeded content: application/json: schema: $ref: '#/components/schemas/inputlimitexceeded' - '422': + '415': description: Invalid Input content: application/json: From 07f97136b8334e41ea11b4416bf6ae52f27fc848 Mon Sep 17 00:00:00 2001 From: Priyadharshini <57977344+priyadharshini-sent@users.noreply.github.com> Date: Wed, 10 Feb 2021 10:46:42 +0530 Subject: [PATCH 398/792] Update season_parking_availability_hdb_sg.yaml --- yaml/season_parking_availability_hdb_sg.yaml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/yaml/season_parking_availability_hdb_sg.yaml b/yaml/season_parking_availability_hdb_sg.yaml index 729130552..ffe3d2bd6 100644 --- a/yaml/season_parking_availability_hdb_sg.yaml +++ b/yaml/season_parking_availability_hdb_sg.yaml @@ -193,13 +193,13 @@ paths: application/json: schema: $ref: '#/components/schemas/inputfieldmissing' - '420': + '413': description: Input Limit Exceeded content: application/json: schema: $ref: '#/components/schemas/inputlimitexceeded' - '422': + '415': description: Invalid Input content: application/json: From ca28874f8b8ab99fb4440d6899138e4cd8004fcd Mon Sep 17 00:00:00 2001 From: Priyadharshini <57977344+priyadharshini-sent@users.noreply.github.com> Date: Wed, 10 Feb 2021 10:47:08 +0530 Subject: [PATCH 399/792] Update directory_of_singapore_startups.yaml --- yaml/directory_of_singapore_startups.yaml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/yaml/directory_of_singapore_startups.yaml b/yaml/directory_of_singapore_startups.yaml index b4f9b672a..87562de87 100644 --- a/yaml/directory_of_singapore_startups.yaml +++ b/yaml/directory_of_singapore_startups.yaml @@ -217,13 +217,13 @@ paths: application/json: schema: $ref: '#/components/schemas/inputfieldmissing' - '420': + '413': description: Input Limit Exceeded content: application/json: schema: $ref: '#/components/schemas/inputlimitexceeded' - '422': + '415': description: Invalid Input content: application/json: From 46675e40107ebb02f444f75aae03e917d24a5a22 Mon Sep 17 00:00:00 2001 From: Priyadharshini <57977344+priyadharshini-sent@users.noreply.github.com> Date: Wed, 10 Feb 2021 10:47:29 +0530 Subject: [PATCH 400/792] Update fitness_stations_and_playgrounds_hdb_sg.yaml --- yaml/fitness_stations_and_playgrounds_hdb_sg.yaml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/yaml/fitness_stations_and_playgrounds_hdb_sg.yaml b/yaml/fitness_stations_and_playgrounds_hdb_sg.yaml index 6878cf99b..5dd69f4c5 100644 --- a/yaml/fitness_stations_and_playgrounds_hdb_sg.yaml +++ b/yaml/fitness_stations_and_playgrounds_hdb_sg.yaml @@ -89,13 +89,13 @@ paths: application/json: schema: $ref: '#/components/schemas/inputfieldmissing' - '420': + '413': description: Input Limit Exceeded content: application/json: schema: $ref: '#/components/schemas/inputlimitexceeded' - '422': + '415': description: Invalid Input content: application/json: From 139c2e297618ed5dbdc9dfbc6e4fdbffeaaa03f6 Mon Sep 17 00:00:00 2001 From: Priyadharshini <57977344+priyadharshini-sent@users.noreply.github.com> Date: Wed, 10 Feb 2021 10:47:51 +0530 Subject: [PATCH 401/792] Update amenities_lamp_posts_hdb_sg.yaml --- yaml/amenities_lamp_posts_hdb_sg.yaml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/yaml/amenities_lamp_posts_hdb_sg.yaml b/yaml/amenities_lamp_posts_hdb_sg.yaml index 8ffbd5c51..c5fb4f0ad 100644 --- a/yaml/amenities_lamp_posts_hdb_sg.yaml +++ b/yaml/amenities_lamp_posts_hdb_sg.yaml @@ -90,13 +90,13 @@ paths: application/json: schema: $ref: '#/components/schemas/inputfieldmissing' - '420': + '413': description: Input Limit Exceeded content: application/json: schema: $ref: '#/components/schemas/inputlimitexceeded' - '422': + '415': description: Invalid Input content: application/json: From 2f569daa40325316e00a2a5fe5d2cd7b59a7ab13 Mon Sep 17 00:00:00 2001 From: Priyadharshini <57977344+priyadharshini-sent@users.noreply.github.com> Date: Wed, 10 Feb 2021 10:48:18 +0530 Subject: [PATCH 402/792] Update amenities_hardcourts_hdb_sg.yaml --- yaml/amenities_hardcourts_hdb_sg.yaml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/yaml/amenities_hardcourts_hdb_sg.yaml b/yaml/amenities_hardcourts_hdb_sg.yaml index 676a89e20..d259b8da7 100644 --- a/yaml/amenities_hardcourts_hdb_sg.yaml +++ b/yaml/amenities_hardcourts_hdb_sg.yaml @@ -88,13 +88,13 @@ paths: application/json: schema: $ref: '#/components/schemas/inputfieldmissing' - '420': + '413': description: Input Limit Exceeded content: application/json: schema: $ref: '#/components/schemas/inputlimitexceeded' - '422': + '415': description: Invalid Input content: application/json: From 3c2cca6306470028563aeddc80a1b58ba1640a50 Mon Sep 17 00:00:00 2001 From: Priyadharshini <57977344+priyadharshini-sent@users.noreply.github.com> Date: Wed, 10 Feb 2021 10:48:40 +0530 Subject: [PATCH 403/792] Update amenities_shelters_hdb_sg.yaml --- yaml/amenities_shelters_hdb_sg.yaml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/yaml/amenities_shelters_hdb_sg.yaml b/yaml/amenities_shelters_hdb_sg.yaml index 6e8a9ff98..db33f0c34 100644 --- a/yaml/amenities_shelters_hdb_sg.yaml +++ b/yaml/amenities_shelters_hdb_sg.yaml @@ -93,13 +93,13 @@ paths: application/json: schema: $ref: '#/components/schemas/inputfieldmissing' - '420': + '413': description: Input Limit Exceeded content: application/json: schema: $ref: '#/components/schemas/inputlimitexceeded' - '422': + '415': description: Invalid Input content: application/json: From a8f111d00e30e8236206fc00540394336e5a2a8a Mon Sep 17 00:00:00 2001 From: Priyadharshini <57977344+priyadharshini-sent@users.noreply.github.com> Date: Wed, 10 Feb 2021 10:49:08 +0530 Subject: [PATCH 404/792] Update d&b_business_check_plus_sg.yaml --- yaml/d&b_business_check_plus_sg.yaml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/yaml/d&b_business_check_plus_sg.yaml b/yaml/d&b_business_check_plus_sg.yaml index 4413b322e..a96609776 100644 --- a/yaml/d&b_business_check_plus_sg.yaml +++ b/yaml/d&b_business_check_plus_sg.yaml @@ -255,13 +255,13 @@ paths: application/json: schema: $ref: '#/components/schemas/inputfieldmissing' - '420': + '413': description: Input Limit Exceeded content: application/json: schema: $ref: '#/components/schemas/inputlimitexceeded' - '422': + '415': description: Invalid Input content: application/json: From ff263cb1681224260523e7f01ea1e2ed54b2ce83 Mon Sep 17 00:00:00 2001 From: Priyadharshini <57977344+priyadharshini-sent@users.noreply.github.com> Date: Wed, 10 Feb 2021 10:49:31 +0530 Subject: [PATCH 405/792] Update d&b_basic_individual_search_sg.yaml --- yaml/d&b_basic_individual_search_sg.yaml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/yaml/d&b_basic_individual_search_sg.yaml b/yaml/d&b_basic_individual_search_sg.yaml index 881a05141..768d48d54 100644 --- a/yaml/d&b_basic_individual_search_sg.yaml +++ b/yaml/d&b_basic_individual_search_sg.yaml @@ -131,13 +131,13 @@ paths: application/json: schema: $ref: '#/components/schemas/inputfieldmissing' - '420': + '413': description: Input Limit Exceeded content: application/json: schema: $ref: '#/components/schemas/inputlimitexceeded' - '422': + '415': description: Invalid Input content: application/json: From da1d6e4f32878d8ba1227d64f6ac860f7e298622 Mon Sep 17 00:00:00 2001 From: Priyadharshini <57977344+priyadharshini-sent@users.noreply.github.com> Date: Wed, 10 Feb 2021 10:49:52 +0530 Subject: [PATCH 406/792] Update d&b_business_check_sg.yaml --- yaml/d&b_business_check_sg.yaml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/yaml/d&b_business_check_sg.yaml b/yaml/d&b_business_check_sg.yaml index b8f5683ba..3bcfe57af 100644 --- a/yaml/d&b_business_check_sg.yaml +++ b/yaml/d&b_business_check_sg.yaml @@ -75,13 +75,13 @@ paths: application/json: schema: $ref: '#/components/schemas/inputfieldmissing' - '420': + '413': description: Input Limit Exceeded content: application/json: schema: $ref: '#/components/schemas/inputlimitexceeded' - '422': + '415': description: Invalid Input content: application/json: From 6de22bd3e2720e0dbf886d2d420bd817f22f12f4 Mon Sep 17 00:00:00 2001 From: Priyadharshini <57977344+priyadharshini-sent@users.noreply.github.com> Date: Wed, 10 Feb 2021 10:50:15 +0530 Subject: [PATCH 407/792] Update d&b_brief_financial_information_sg.yaml --- yaml/d&b_brief_financial_information_sg.yaml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/yaml/d&b_brief_financial_information_sg.yaml b/yaml/d&b_brief_financial_information_sg.yaml index 4f27ffaec..22143c37a 100644 --- a/yaml/d&b_brief_financial_information_sg.yaml +++ b/yaml/d&b_brief_financial_information_sg.yaml @@ -90,13 +90,13 @@ paths: application/json: schema: $ref: '#/components/schemas/inputfieldmissing' - '420': + '413': description: Input Limit Exceeded content: application/json: schema: $ref: '#/components/schemas/inputlimitexceeded' - '422': + '415': description: Invalid Input content: application/json: From eabb9b3cd367bfbab3fdf34593ce30377daf7488 Mon Sep 17 00:00:00 2001 From: Priyadharshini Date: Thu, 11 Feb 2021 18:24:50 +0530 Subject: [PATCH 408/792] latest docs --- .../demographics_classification.yaml | 0 .../face_recognition_politicians_sg.yaml | 0 .../face_recognition_v1.0.yaml | 0 .../landmark_detection_jp.yaml | 0 .../landmark_detection_jp_v1.0.yaml | 120 +- .../landmark_detection_sg.yaml | 0 .../landmark_detection_sg_v1.0.yaml | 135 +- .../object_detection.yaml | 0 .../object_detection_v1.0.yaml | 0 .../people_counting.yaml | 0 .../people_counting_v1.0.yaml | 0 .../amenities_hardcourts_hdb_sg.yaml | 0 .../amenities_lamp_posts_hdb_sg.yaml | 0 {yaml => data}/amenities_shelters_hdb_sg.yaml | 0 {yaml => data}/building_addresses_hdb_sg.yaml | 0 {yaml => data}/carpark_hdb_sg.yaml | 0 .../commercial_directories_hdb_sg.yaml | 0 .../d&b_basic_individual_search_sg.yaml | 0 .../d&b_brief_financial_information_sg.yaml | 0 .../d&b_business_check_plus_sg.yaml | 0 {yaml => data}/d&b_business_check_sg.yaml | 0 data/demographics_classification.yaml | 293 +++ {yaml => data}/demographics_hdb_sg.yaml | 0 .../directory_of_singapore_startups.yaml | 0 ...tness_stations_and_playgrounds_hdb_sg.yaml | 0 {yaml => data}/flat_ownership_hdb_sg.yaml | 0 {yaml => data}/page_profiler_eng.yaml | 0 .../residential_sales_and_rental_hdb_sg.yaml | 0 .../season_parking_availability_hdb_sg.yaml | 0 {yaml => data_alliance}/download_dataset.yaml | 0 index.yaml | 284 +++ .../inverse_text_normalisation_eng.yaml | 0 .../inverse_text_normalisation_eng_v1.0.yaml | 0 .../named-entity_recognition_eng.yaml | 0 .../named-entity_recognition_eng_v1.0.yaml | 0 .../named-entity_recognition_jp.yaml | 0 .../named-entity_recognition_jp_v1.0.yaml | 0 .../named-entity_recognition_thai.yaml | 0 .../named-entity_recognition_thai_v1.0.yaml | 0 nlp/page_profiler_eng.yaml | 255 +++ {yaml => nlp}/page_profiler_eng_v2.0.yaml | 0 {yaml => nlp}/page_profiler_eng_v2.1.yaml | 0 {yaml => nlp}/page_profiler_jp.yaml | 0 {yaml => nlp}/page_profiler_thai.yaml | 0 {yaml => nlp}/script_alignment.yaml | 0 {yaml => nlp}/script_alignment_v1.0.yaml | 0 .../spacy_named-entity_recognition_eng.yaml | 0 {yaml => nlp}/taxonomy_matcher_eng.yaml | 0 {yaml => nlp}/taxonomy_matcher_eng_v1.0.yaml | 0 .../word_sense_disambiguation_eng.yaml | 0 .../word_sense_disambiguation_eng_v1.0.yaml | 0 {yaml => utility}/audio_format_convertor.yaml | 0 {yaml => utility}/base64-decoder.yaml | 0 {yaml => utility}/base64-encoder.yaml | 0 {yaml => utility}/base64-file-decode.yaml | 0 {yaml => utility}/base64-file-encode.yaml | 0 {yaml => utility}/csv-json_convertor.yaml | 0 .../decryption_using_pki_key.yaml | 0 {yaml => utility}/document_convertor_eng.yaml | 0 utility/download_dataset.yaml | 10 + .../encryption_using_pki_key.yaml | 0 .../inverse_text_normalisation_eng.yaml | 98 +- .../inverse_text_normalisation_eng_v1.0.yaml | 248 +++ {yaml => utility}/json-csv_convertor.yaml | 0 .../newspaper_article_scraper.yaml | 0 {yaml => utility}/pdf_extractor.yaml | 0 {yaml => utility}/pki_key_generator.yaml | 0 {yaml => utility}/urls_retrieval.yaml | 0 .../video-to-audio_convertor.yaml | 0 .../video-to-image_convertor.yaml | 0 {yaml => utility}/web_scraper.yaml | 0 {yaml => utility}/wikipedia_retrieval.yaml | 0 .../wikipedia_retrieval_v1.0.yaml | 0 .../youtube_video_downloader.yaml | 0 ..._with_voice_activity_detection_eng_sg.yaml | 0 ..._voice_activity_detection_eng_sg_v1.0.yaml | 0 .../automatic_speech_recognition_chi_sg.yaml | 0 .../automatic_speech_recognition_eng.yaml | 0 .../automatic_speech_recognition_eng_sg.yaml | 0 ...omatic_speech_recognition_eng_sg_v1.0.yaml | 0 .../automatic_voice_recognition_eng.yaml | 0 ...e_automatic_speech_recognition_eng_sg.yaml | 0 ...d_automatic_speech_recognition_eng_sg.yaml | 0 {yaml => voice}/text-to-speech_chi.yaml | 0 {yaml => voice}/text-to-speech_eng.yaml | 0 .../voice_activity_detection_eng.yaml | 0 .../voice_activity_detection_eng_v1.0.yaml | 0 yaml/index.yaml | 255 --- yaml/staple_receipt.yaml | 1573 ----------------- 89 files changed, 1350 insertions(+), 1921 deletions(-) rename {yaml => computer_vision}/demographics_classification.yaml (100%) rename {yaml => computer_vision}/face_recognition_politicians_sg.yaml (100%) rename {yaml => computer_vision}/face_recognition_v1.0.yaml (100%) rename {yaml => computer_vision}/landmark_detection_jp.yaml (100%) rename yaml/sentiment-analysis-aws.yaml => computer_vision/landmark_detection_jp_v1.0.yaml (57%) rename {yaml => computer_vision}/landmark_detection_sg.yaml (100%) rename yaml/staple_invoice.yaml => computer_vision/landmark_detection_sg_v1.0.yaml (54%) rename {yaml => computer_vision}/object_detection.yaml (100%) rename {yaml => computer_vision}/object_detection_v1.0.yaml (100%) rename {yaml => computer_vision}/people_counting.yaml (100%) rename {yaml => computer_vision}/people_counting_v1.0.yaml (100%) rename {yaml => data}/amenities_hardcourts_hdb_sg.yaml (100%) rename {yaml => data}/amenities_lamp_posts_hdb_sg.yaml (100%) rename {yaml => data}/amenities_shelters_hdb_sg.yaml (100%) rename {yaml => data}/building_addresses_hdb_sg.yaml (100%) rename {yaml => data}/carpark_hdb_sg.yaml (100%) rename {yaml => data}/commercial_directories_hdb_sg.yaml (100%) rename {yaml => data}/d&b_basic_individual_search_sg.yaml (100%) rename {yaml => data}/d&b_brief_financial_information_sg.yaml (100%) rename {yaml => data}/d&b_business_check_plus_sg.yaml (100%) rename {yaml => data}/d&b_business_check_sg.yaml (100%) create mode 100644 data/demographics_classification.yaml rename {yaml => data}/demographics_hdb_sg.yaml (100%) rename {yaml => data}/directory_of_singapore_startups.yaml (100%) rename {yaml => data}/fitness_stations_and_playgrounds_hdb_sg.yaml (100%) rename {yaml => data}/flat_ownership_hdb_sg.yaml (100%) rename {yaml => data}/page_profiler_eng.yaml (100%) rename {yaml => data}/residential_sales_and_rental_hdb_sg.yaml (100%) rename {yaml => data}/season_parking_availability_hdb_sg.yaml (100%) rename {yaml => data_alliance}/download_dataset.yaml (100%) create mode 100644 index.yaml rename {yaml => nlp}/inverse_text_normalisation_eng.yaml (100%) rename {yaml => nlp}/inverse_text_normalisation_eng_v1.0.yaml (100%) rename {yaml => nlp}/named-entity_recognition_eng.yaml (100%) rename {yaml => nlp}/named-entity_recognition_eng_v1.0.yaml (100%) rename {yaml => nlp}/named-entity_recognition_jp.yaml (100%) rename {yaml => nlp}/named-entity_recognition_jp_v1.0.yaml (100%) rename {yaml => nlp}/named-entity_recognition_thai.yaml (100%) rename {yaml => nlp}/named-entity_recognition_thai_v1.0.yaml (100%) create mode 100644 nlp/page_profiler_eng.yaml rename {yaml => nlp}/page_profiler_eng_v2.0.yaml (100%) rename {yaml => nlp}/page_profiler_eng_v2.1.yaml (100%) rename {yaml => nlp}/page_profiler_jp.yaml (100%) rename {yaml => nlp}/page_profiler_thai.yaml (100%) rename {yaml => nlp}/script_alignment.yaml (100%) rename {yaml => nlp}/script_alignment_v1.0.yaml (100%) rename {yaml => nlp}/spacy_named-entity_recognition_eng.yaml (100%) rename {yaml => nlp}/taxonomy_matcher_eng.yaml (100%) rename {yaml => nlp}/taxonomy_matcher_eng_v1.0.yaml (100%) rename {yaml => nlp}/word_sense_disambiguation_eng.yaml (100%) rename {yaml => nlp}/word_sense_disambiguation_eng_v1.0.yaml (100%) rename {yaml => utility}/audio_format_convertor.yaml (100%) rename {yaml => utility}/base64-decoder.yaml (100%) rename {yaml => utility}/base64-encoder.yaml (100%) rename {yaml => utility}/base64-file-decode.yaml (100%) rename {yaml => utility}/base64-file-encode.yaml (100%) rename {yaml => utility}/csv-json_convertor.yaml (100%) rename {yaml => utility}/decryption_using_pki_key.yaml (100%) rename {yaml => utility}/document_convertor_eng.yaml (100%) create mode 100644 utility/download_dataset.yaml rename {yaml => utility}/encryption_using_pki_key.yaml (100%) rename yaml/sentiment-analysis-google.yaml => utility/inverse_text_normalisation_eng.yaml (50%) create mode 100644 utility/inverse_text_normalisation_eng_v1.0.yaml rename {yaml => utility}/json-csv_convertor.yaml (100%) rename {yaml => utility}/newspaper_article_scraper.yaml (100%) rename {yaml => utility}/pdf_extractor.yaml (100%) rename {yaml => utility}/pki_key_generator.yaml (100%) rename {yaml => utility}/urls_retrieval.yaml (100%) rename {yaml => utility}/video-to-audio_convertor.yaml (100%) rename {yaml => utility}/video-to-image_convertor.yaml (100%) rename {yaml => utility}/web_scraper.yaml (100%) rename {yaml => utility}/wikipedia_retrieval.yaml (100%) rename {yaml => utility}/wikipedia_retrieval_v1.0.yaml (100%) rename {yaml => utility}/youtube_video_downloader.yaml (100%) rename {yaml => voice}/asr_with_voice_activity_detection_eng_sg.yaml (100%) rename {yaml => voice}/asr_with_voice_activity_detection_eng_sg_v1.0.yaml (100%) rename {yaml => voice}/automatic_speech_recognition_chi_sg.yaml (100%) rename {yaml => voice}/automatic_speech_recognition_eng.yaml (100%) rename {yaml => voice}/automatic_speech_recognition_eng_sg.yaml (100%) rename {yaml => voice}/automatic_speech_recognition_eng_sg_v1.0.yaml (100%) rename {yaml => voice}/automatic_voice_recognition_eng.yaml (100%) rename {yaml => voice}/online_automatic_speech_recognition_eng_sg.yaml (100%) rename {yaml => voice}/online_command_automatic_speech_recognition_eng_sg.yaml (100%) rename {yaml => voice}/text-to-speech_chi.yaml (100%) rename {yaml => voice}/text-to-speech_eng.yaml (100%) rename {yaml => voice}/voice_activity_detection_eng.yaml (100%) rename {yaml => voice}/voice_activity_detection_eng_v1.0.yaml (100%) delete mode 100644 yaml/index.yaml delete mode 100644 yaml/staple_receipt.yaml diff --git a/yaml/demographics_classification.yaml b/computer_vision/demographics_classification.yaml similarity index 100% rename from yaml/demographics_classification.yaml rename to computer_vision/demographics_classification.yaml diff --git a/yaml/face_recognition_politicians_sg.yaml b/computer_vision/face_recognition_politicians_sg.yaml similarity index 100% rename from yaml/face_recognition_politicians_sg.yaml rename to computer_vision/face_recognition_politicians_sg.yaml diff --git a/yaml/face_recognition_v1.0.yaml b/computer_vision/face_recognition_v1.0.yaml similarity index 100% rename from yaml/face_recognition_v1.0.yaml rename to computer_vision/face_recognition_v1.0.yaml diff --git a/yaml/landmark_detection_jp.yaml b/computer_vision/landmark_detection_jp.yaml similarity index 100% rename from yaml/landmark_detection_jp.yaml rename to computer_vision/landmark_detection_jp.yaml diff --git a/yaml/sentiment-analysis-aws.yaml b/computer_vision/landmark_detection_jp_v1.0.yaml similarity index 57% rename from yaml/sentiment-analysis-aws.yaml rename to computer_vision/landmark_detection_jp_v1.0.yaml index 61cef6373..e0e2a920e 100644 --- a/yaml/sentiment-analysis-aws.yaml +++ b/computer_vision/landmark_detection_jp_v1.0.yaml @@ -1,16 +1,27 @@ openapi: 3.0.1 info: - title: Sentiment Analysis AWS - description: >- - The sentiment analysis will help to determine the expressed emotional state of person by using natural language processing to analyse a range of parameters, including tone of voice, choice of words.

This is a passthrough to AWS’s sentiment analyser. - version: '0.1.0' + title: Landmark Detection (JP) + description: |+ + This Computer Vision microservice identifies Japan landmarks from multiple input images. + + The microservice returns the detected landmark and confidence score. + + The size of your image file should **not exceed 5 MB**. + x-additionalinfo: |+ + Suggested Use Cases: + - Can be used for geo-targeting apps with map feature or property development planning resource apps. + version: '1.0.0' + x-subscribelink: landmark_detection_jp servers: - - url: 'https://api.sentient.io' + - url: 'https://dev-apis.sentient.io' +tags: +- name: "v1.0.0" + description: "Published Date - Dec 31, 2020" paths: - /sentimentanalysis/prod/awssa: + /microservices/cv/landmarkjp/v1/getpredictions: post: tags: - - v0.1.0 + - v1.0.0 responses: '200': description: success response @@ -18,6 +29,12 @@ paths: application/json: schema: $ref: '#/components/schemas/success' + example: + results: + confidence: 100% + landmark: Gion + message: Successfully Processed + status: Success '401': description: Unauthorized content: @@ -53,7 +70,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/inputlimitexceeded' + $ref: '#/components/schemas/inputlimitexceeded' '422': description: Invalid Input content: @@ -61,7 +78,7 @@ paths: schema: $ref: '#/components/schemas/invalidinput' '500': - description: Internal Server error + description: Internal Server Error content: application/json: schema: @@ -74,24 +91,46 @@ paths: $ref: '#/components/schemas/gatewaytimeout' security: - APIAuthorizer: [] + requestBody: content: application/json: schema: $ref: '#/components/schemas/input' required: true + + components: schemas: success: type: object properties: - Sentiment: + results: + type: object + description: The result of the API call. + example: { "" } + properties: + confidence: + x-name: confidence + type: string + example: 100% + description: Confidence score of identification. Higher is more confidence. + landmark: + x-name: landmark + type: string + example: Gion + description: Name of the landmark + message: type: string - example: NEUTRAL - SentimentScore: - items: - type: string - example: 'Positive: 0.05698205158114433, Negative: 0.030973462387919426, Neutral: 0.912034809589386, Mixed: 0.00000966900734056253' + example: Successfully Processed + description: Detail description on the API status + status: + type: string + example: Success + description: The status of the API call success/failure + + + unauthorized: type: object properties: @@ -101,21 +140,21 @@ components: status: type: string example: Failure - forbidden: + restricted: type: object properties: message: type: string - example: Access Denied Unauthorized User + example: The content is restricted status: type: string example: Failure - invalidinput: + forbidden: type: object properties: message: type: string - example: Invalid Input + example: Access Denied Unauthorized User status: type: string example: Failure @@ -133,7 +172,7 @@ components: properties: message: type: string - example: Invalid Request URL + example: Invalid Request status: type: string example: Failure @@ -142,7 +181,7 @@ components: properties: message: type: string - example: Internal Server error + example: Internal Server Error status: type: string example: Failure @@ -172,15 +211,50 @@ components: example: Input Limit Exceeded status: type: string - example: Failure + example: Failure + invalidinput: + type: object + properties: + message: + type: string + example: Invalid Input + status: + type: string + example: Failure + versions: + type: object + properties: + v1.0.0: + type: array + items: + oneOf: + - type: string + example: Published Date - Dec 31, 2020 + description: Standardizing Output JSON + v0.1.0: + type: array + items: + oneOf: + - type: string + example: Published Date - Jul 30,2020 + description: Initial version release input: type: object properties: - key: + image_base64: + x-name: image_base64 type: string + default: true + example: UklGRkbiBABXQVZFZm10IBAAAAABA... + description: |+ + Input image file in base64 format. + + Supported formats: blp, bmp, bufr, cur, dcx, dds, dib, eps, ps, fit, fits, flc, fli, fpx, ftc, ftu, gbr, gif, grib, h5, hd5, icns, ico, im, iim, jpeg, jp2, mic, mpeg, msp, pcd, pcx, pxr, png, ppm, psd, sgi, ras, tga, tiff, wmf, xbm, xpm. + securitySchemes: APIAuthorizer: type: apiKey name: x-api-key in: header x-amazon-apigateway-authtype: custom + description: Authentication is done using the x-api-key in the request header diff --git a/yaml/landmark_detection_sg.yaml b/computer_vision/landmark_detection_sg.yaml similarity index 100% rename from yaml/landmark_detection_sg.yaml rename to computer_vision/landmark_detection_sg.yaml diff --git a/yaml/staple_invoice.yaml b/computer_vision/landmark_detection_sg_v1.0.yaml similarity index 54% rename from yaml/staple_invoice.yaml rename to computer_vision/landmark_detection_sg_v1.0.yaml index d91b728d6..13f03ef47 100644 --- a/yaml/staple_invoice.yaml +++ b/computer_vision/landmark_detection_sg_v1.0.yaml @@ -1,21 +1,28 @@ openapi: 3.0.1 info: - title: Staple Invoice + title: Landmark Detection (SG) description: |+ - Scan the Invoice document from file and explore the data by catagorywise. - Supported formats are : pdf, jpg, png, docx, doc + This Computer Vision microservice identifies Singapore landmarks from multiple input images. + + This microservice returns the detected landmark and confidence score. + + The size of your image file should **not exceed 5 MB**. + x-additionalinfo: |+ + Suggested Use Cases: + - Can be used for geo-targeting apps with map feature or property development planning resource apps. version: '1.0.0' - x-subscribelink: staple_receipt + x-subscribelink: landmark_detection_sg servers: - url: 'https://dev-apis.sentient.io' tags: - name: "v1.0.0" - description: "Published Date - Oct 30, 2020" + description: "Published Date - Dec 31, 2020" paths: - /microservices/nlp/scaninvoice/v1/getresults: + /microservices/cv/landmarksg/v1/getpredictions: post: tags: - v1.0.0 + responses: '200': description: success response @@ -23,7 +30,13 @@ paths: application/json: schema: $ref: '#/components/schemas/success' - example: {"message": "Successfully Processed","results":{"scanDocuments":{"data":{"BigBoxes":[{"box":[102,131,227,166,164.5,148.5],"page":0}],"Currency":{"UICategory":"VAT&Amounts","UIName":"Currency","UIType":"Text","matches":[{"keyword":[1160,1594,1171,1616,1165.5,1605,"$","$"],"match":"$","matchmulti":"$","page":0,"value":[1160,1594,1171,1616,1165.5,1605,"$","$"]}]},"Customer":null,"DetectedText":"GSSAINVOICEThankyouc/oGregDerderianTreasurer32TinkerRoadNashuaNH03064Phone603-595-4357faxnoneDATE:INVOICE#FOR:May22009100AnnualDuesBillTo:GSSAMember2009PhoneDESCRIPTIONAMOUNTAnnualDuesperteam2009summerswimseason$100.00TOTAL$100.00MakeallcheckspayabletoGSSAIfyouhaveanyquestionsconcerningthisinvoicecontactNaGregDerderianTreasurerTHANKYOUFORYOURMEMBERSHIP!","DocSize":[[2000,1545]],"Email":{"UICategory":"Vendor&Customer","UIName":"Email","UIType":"Text","matches":[{"keyword":null,"match":null,"matchmulti":null,"page":null,"value":null}]},"GSTNumber":{"UICategory":"Vendor&Customer","UIName":"GSTNumber","UIType":"Text","matches":[{"keyword":null,"match":null,"matchmulti":null,"page":null,"value":null}]},"LineItems":[[{"Amount":[22009],"Description":["32TinkerRoad","DATE:"]}]],"LineItems_standardHeader":[[{"Description":"32TinkerRoadDATE:","LineAmount":22009,"Quantity":1,"UnitAmount":22009}]],"OtherDate":{"UICategory":"BasicInformation","UIName":"OtherDate","UIType":"Date","matches":[{"keyword":null,"match":"2009-05-02","matchmulti":"May22009","page":0,"value":[1232,260]}]},"SenderAddress":{"UICategory":"Vendor&Customer","UIName":"VendorAddress","UIType":"Text","matches":[{"keyword":[102,131,227,166,164.5,148.5,"GSSA\n","GSSA\n"],"match":"c/oGregDerderianTreasurer\n32TinkerRoad\nNashua\nNH03064\nPhone603-595-4357\nfaxnone\n","matchmulti":"c/oGregDerderianTreasurer32TinkerRoadNashuaNH03064Phone603-595-4357Faxnone","page":0,"value":[97,231,457,349,277,290,"c/oGregDerderianTreasurer\n32TinkerRoad\nNashua\nNH03064\nPhone603-595-4357\nfaxnone\n","c/oGregDerderianTreasurer\n32TinkerRoad\nNashua\nNH03064\nPhone603-595-4357\nFaxnone\n"]}]},"ServiceCharge":{"UICategory":"VAT&Amounts","UIName":"ServiceCharge","UIType":"Amount","matches":[{"keyword":null,"match":null,"matchmulti":null,"page":null,"value":null}]},"docId":7905,"status":"COMPLETED"}},"status":"Success"}} + example: + results: + confidence: 100% + landmark: Artscience Museum + message: Successfully Processed + status: Success + '401': description: Unauthorized content: @@ -59,7 +72,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/inputlimitexceeded' + $ref: '#/components/schemas/inputlimitexceeded' '422': description: Invalid Input content: @@ -80,34 +93,46 @@ paths: $ref: '#/components/schemas/gatewaytimeout' security: - APIAuthorizer: [] + requestBody: content: - multipart/form-data: + application/json: schema: $ref: '#/components/schemas/input' - required: true + required: true + + components: schemas: success: - type: object - properties: - results: - type: object - example: { "" } - description: The result of the API call - properties: - scanDocuments: - type: object - example: { "" } - description: The details of documents - message: - type: string - example: Successfully Processed - description: Detail description on the API status - status: - type: string - example: Success - description: The status of the API call success/failure + type: object + properties: + results: + type: object + description: The result of the API call. + example: { "" } + properties: + confidence: + x-name: confidence + type: string + example: 100% + description: Confidence score of identification. Higher is more confidence. + landmark: + x-name: landmark + type: string + example: Artscience Museum + description: Name of the landmark + message: + type: string + example: Successfully Processed + description: Detail description on the API status + status: + type: string + example: Success + description: The status of the API call success/failure + + + unauthorized: type: object properties: @@ -117,21 +142,21 @@ components: status: type: string example: Failure - forbidden: + restricted: type: object properties: message: type: string - example: Access Denied Unauthorized User + example: The content is restricted status: type: string example: Failure - invalidinput: + forbidden: type: object properties: message: type: string - example: Invalid Input + example: Access Denied Unauthorized User status: type: string example: Failure @@ -149,7 +174,7 @@ components: properties: message: type: string - example: Invalid Request URL + example: Invalid Request status: type: string example: Failure @@ -189,31 +214,47 @@ components: status: type: string example: Failure + invalidinput: + type: object + properties: + message: + type: string + example: Invalid Input + status: + type: string + example: Failure versions: type: object properties: v1.0.0: - type: array - items: - oneOf: + type: array + items: + oneOf: - type: string - example: Published Date - Oct 30, 2020 + example: Published Date - Dec 31, 2020 + description: Standardizing Output JSON + v0.1.0: + type: array + items: + oneOf: + - type: string + example: Published Date - Jul 30,2020 description: Initial version release input: type: object required: - - file - - endpointUrl + - image_base64 properties: - file: + image_base64: + x-name: image_base64 type: string - format: binary default: true - example: upload file - description: The receipt document - handwritten: - type: string - description: Sholud be true of false. Default is false + example: UklGRkbiBABXQVZFZm10IBAAAAABA... + description: |+ + Input image file in base64 format. + + Supported formats: blp, bmp, bufr, cur, dcx, dds, dib, eps, ps, fit, fits, flc, fli, fpx, ftc, ftu, gbr, gif, grib, h5, hd5, icns, ico, im, iim, jpeg, jp2, mic, mpeg, msp, pcd, pcx, pxr, png, ppm, psd, sgi, ras, tga, tiff, wmf, xbm, xpm. + securitySchemes: APIAuthorizer: type: apiKey diff --git a/yaml/object_detection.yaml b/computer_vision/object_detection.yaml similarity index 100% rename from yaml/object_detection.yaml rename to computer_vision/object_detection.yaml diff --git a/yaml/object_detection_v1.0.yaml b/computer_vision/object_detection_v1.0.yaml similarity index 100% rename from yaml/object_detection_v1.0.yaml rename to computer_vision/object_detection_v1.0.yaml diff --git a/yaml/people_counting.yaml b/computer_vision/people_counting.yaml similarity index 100% rename from yaml/people_counting.yaml rename to computer_vision/people_counting.yaml diff --git a/yaml/people_counting_v1.0.yaml b/computer_vision/people_counting_v1.0.yaml similarity index 100% rename from yaml/people_counting_v1.0.yaml rename to computer_vision/people_counting_v1.0.yaml diff --git a/yaml/amenities_hardcourts_hdb_sg.yaml b/data/amenities_hardcourts_hdb_sg.yaml similarity index 100% rename from yaml/amenities_hardcourts_hdb_sg.yaml rename to data/amenities_hardcourts_hdb_sg.yaml diff --git a/yaml/amenities_lamp_posts_hdb_sg.yaml b/data/amenities_lamp_posts_hdb_sg.yaml similarity index 100% rename from yaml/amenities_lamp_posts_hdb_sg.yaml rename to data/amenities_lamp_posts_hdb_sg.yaml diff --git a/yaml/amenities_shelters_hdb_sg.yaml b/data/amenities_shelters_hdb_sg.yaml similarity index 100% rename from yaml/amenities_shelters_hdb_sg.yaml rename to data/amenities_shelters_hdb_sg.yaml diff --git a/yaml/building_addresses_hdb_sg.yaml b/data/building_addresses_hdb_sg.yaml similarity index 100% rename from yaml/building_addresses_hdb_sg.yaml rename to data/building_addresses_hdb_sg.yaml diff --git a/yaml/carpark_hdb_sg.yaml b/data/carpark_hdb_sg.yaml similarity index 100% rename from yaml/carpark_hdb_sg.yaml rename to data/carpark_hdb_sg.yaml diff --git a/yaml/commercial_directories_hdb_sg.yaml b/data/commercial_directories_hdb_sg.yaml similarity index 100% rename from yaml/commercial_directories_hdb_sg.yaml rename to data/commercial_directories_hdb_sg.yaml diff --git a/yaml/d&b_basic_individual_search_sg.yaml b/data/d&b_basic_individual_search_sg.yaml similarity index 100% rename from yaml/d&b_basic_individual_search_sg.yaml rename to data/d&b_basic_individual_search_sg.yaml diff --git a/yaml/d&b_brief_financial_information_sg.yaml b/data/d&b_brief_financial_information_sg.yaml similarity index 100% rename from yaml/d&b_brief_financial_information_sg.yaml rename to data/d&b_brief_financial_information_sg.yaml diff --git a/yaml/d&b_business_check_plus_sg.yaml b/data/d&b_business_check_plus_sg.yaml similarity index 100% rename from yaml/d&b_business_check_plus_sg.yaml rename to data/d&b_business_check_plus_sg.yaml diff --git a/yaml/d&b_business_check_sg.yaml b/data/d&b_business_check_sg.yaml similarity index 100% rename from yaml/d&b_business_check_sg.yaml rename to data/d&b_business_check_sg.yaml diff --git a/data/demographics_classification.yaml b/data/demographics_classification.yaml new file mode 100644 index 000000000..6fa1083f6 --- /dev/null +++ b/data/demographics_classification.yaml @@ -0,0 +1,293 @@ +openapi: 3.0.1 +info: + title: Demographics Classification + description: |+ + This Computer Vision microservice detects for faces from an input image and predicts the demographics of each face (age, gender and race). The image is given as an input encoded using base64. The microservice will a face detector and subsequently models to predict age, gender and race. The results will then be returned back to the user as a JSON output together with bounding box coordinates for each face.Races include: Asian, Indian, White, Black, Middle Eastern and Latino Hispanic + The size of your image file should **not exceed 5 MB**, and the image dimension should be **at least 416x416 pixels**. + x-additionalinfo: |+ + Suggested Use Cases: + - This microservice can be used as a solution to help businesses better understand and connect with their customers, engage new prospects and increase revenue. For example, it can be used to improve visitor experience and optimize operations in retail, leisure, and other sectors by identifying the type of demogrpahic that frequents a certain place the most. It can also be used to create intelligent prospect lists that ensure one is always maximizing their marketing investment. + version: v0.1.0 + x-subscribelink: demographics_classification +servers: + - url: 'https://apis.sentient.io' +tags: +- name: "v0.1.0" + description: "Published Date - Dec 09, 2020" +paths: + /microservices/cv/democlass/v0/getpredictions: + post: + tags: + - v0.1.0 + responses: + '200': + description: success response + content: + application/json: + schema: + $ref: '#/components/schemas/success' + example: + results: + persons: + - age: 33.21062944528088 + bbox: + bottom: 459 + left: 82 + right: 393 + top: 0 + gender: Man + race: white + + message: Successfully Processed + status: Success + '401': + description: Unauthorized + content: + application/json: + schema: + $ref: '#/components/schemas/unauthorized' + '402': + description: Payment Required + content: + application/json: + schema: + $ref: '#/components/schemas/paymentrequired' + '403': + description: Forbidden + content: + application/json: + schema: + $ref: '#/components/schemas/forbidden' + '404': + description: Not Found + content: + application/json: + schema: + $ref: '#/components/schemas/notfound' + '419': + description: Input Field Missing + content: + application/json: + schema: + $ref: '#/components/schemas/inputfieldmissing' + '413': + description: Input Limit Exceeded + content: + application/json: + schema: + $ref: '#/components/schemas/inputlimitexceeded' + '415': + description: Invalid Input + content: + application/json: + schema: + $ref: '#/components/schemas/invalidinput' + '500': + description: Internal Server error + content: + application/json: + schema: + $ref: '#/components/schemas/servererror' + '504': + description: Gateway Timeout + content: + application/json: + schema: + $ref: '#/components/schemas/gatewaytimeout' + security: + - APIAuthorizer: [] + + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/input' + required: true + + +components: + schemas: + success: + type: object + properties: + results: + type: object + description: The result of the API call. + example: { "" } + properties: + persons: + description: Demographic details of the detected person + example: + age: 33.21062944528088 + bbox: + bottom: 459 + left: 82 + right: 393 + top: 0 + gender: Man + race: white + items: + properties: + description: Demographic details of the detected person + example: ' ' + properties: + age: + description: Age of the detected person in the input image + example: 33.21062944528088 + type: float + bbox: + description: Bounding box of the detected person in the input image + example: ' ' + properties: + bottom: + description: Bottom coordinate of the box + example: 459 + type: integer + left: + description: Left coordinate of the box + example: 82 + type: integer + right: + description: Right coordinate of the box + example: 393 + type: integer + top: + description: Top coordinate of the box + example: 0 + type: integer + type: object + gender: + description: Gender of the detected person in the input image + example: Man + type: string + race: + description: Race of the detected person in the input image + example: white + type: string + type: object + type: object + type: array + + message: + type: string + example: Successfully Processed + description: Detail description on the API status + status: + type: string + example: Success + description: The status of the API call success/failure + + unauthorized: + type: object + properties: + message: + type: string + example: Missing Authentication Token + status: + type: string + example: Failure + forbidden: + type: object + properties: + message: + type: string + example: Access Denied Unauthorized User + status: + type: string + example: Failure + paymentrequired: + type: object + properties: + message: + type: string + example: Insufficient Credits Kindly Top Up + status: + type: string + example: Failure + notfound: + type: object + properties: + message: + type: string + example: Invalid Request + status: + type: string + example: Failure + servererror: + type: object + properties: + message: + type: string + example: Internal Server error + status: + type: string + example: Failure + gatewaytimeout: + type: object + properties: + message: + type: string + example: Request Timeout + status: + type: string + example: Failure + inputfieldmissing: + type: object + properties: + message: + type: string + example: Input Field Missing + status: + type: string + example: Failure + inputlimitexceeded: + type: object + properties: + message: + type: string + example: Input Limit Exceeded + status: + type: string + example: Failure + invalidinput: + type: object + properties: + message: + type: string + example: Invalid Input + status: + type: string + example: Failure + versions: + type: object + properties: + v0.1.0: + type: array + items: + oneOf: + - type: string + example: Published Date - Dec 09, 2020 + description: Initial version release + input: + type: object + required: + + - image_base64 + + properties: + image_base64: + x-name: image_base64 + type: string + default: True + example: /9j/4AAQSkZJRgABAQEASABIAAD/2wBDAAMCAgMCAgMDAwMEAwMEBQgFBQQEBQoHBwYIDAoMDAsKCwsNDhIQDQ4RDgsLEBYQERMUFRUVDA8XGBYUG... + description: |+ + Input image file in base64 format. + + + securitySchemes: + APIAuthorizer: + type: apiKey + name: x-api-key + in: header + x-amazon-apigateway-authtype: custom + description: Authentication is done using the x-api-key in the request header diff --git a/yaml/demographics_hdb_sg.yaml b/data/demographics_hdb_sg.yaml similarity index 100% rename from yaml/demographics_hdb_sg.yaml rename to data/demographics_hdb_sg.yaml diff --git a/yaml/directory_of_singapore_startups.yaml b/data/directory_of_singapore_startups.yaml similarity index 100% rename from yaml/directory_of_singapore_startups.yaml rename to data/directory_of_singapore_startups.yaml diff --git a/yaml/fitness_stations_and_playgrounds_hdb_sg.yaml b/data/fitness_stations_and_playgrounds_hdb_sg.yaml similarity index 100% rename from yaml/fitness_stations_and_playgrounds_hdb_sg.yaml rename to data/fitness_stations_and_playgrounds_hdb_sg.yaml diff --git a/yaml/flat_ownership_hdb_sg.yaml b/data/flat_ownership_hdb_sg.yaml similarity index 100% rename from yaml/flat_ownership_hdb_sg.yaml rename to data/flat_ownership_hdb_sg.yaml diff --git a/yaml/page_profiler_eng.yaml b/data/page_profiler_eng.yaml similarity index 100% rename from yaml/page_profiler_eng.yaml rename to data/page_profiler_eng.yaml diff --git a/yaml/residential_sales_and_rental_hdb_sg.yaml b/data/residential_sales_and_rental_hdb_sg.yaml similarity index 100% rename from yaml/residential_sales_and_rental_hdb_sg.yaml rename to data/residential_sales_and_rental_hdb_sg.yaml diff --git a/yaml/season_parking_availability_hdb_sg.yaml b/data/season_parking_availability_hdb_sg.yaml similarity index 100% rename from yaml/season_parking_availability_hdb_sg.yaml rename to data/season_parking_availability_hdb_sg.yaml diff --git a/yaml/download_dataset.yaml b/data_alliance/download_dataset.yaml similarity index 100% rename from yaml/download_dataset.yaml rename to data_alliance/download_dataset.yaml diff --git a/index.yaml b/index.yaml new file mode 100644 index 000000000..55d96b25e --- /dev/null +++ b/index.yaml @@ -0,0 +1,284 @@ +# This yaml file been updated for Sentient.io API Documentation v4.0.0 Beta +# Latest update : 2021-Feb-4 +# For adding new microservices, please follow the format below: + +#------------------------------------------------- +# +# /// - microservice category have to be lower case, +# ///the category name will be exactely same as the folder name +# Category (voice / computer vision / nlp / etc.): +# /// - microservice SHOULD be same as the file name, except, don't need the version number +# microservice_name: +# /// - This will be the title appeared in the side navigation +# /// - Use the same title from info.title inside the microservice yaml file +# title: "Some Title" +# /// - Versions will contain version number and file name for each version +# versions: +# v1.0: "yaml_file_name_goes_here_v1.0.yaml" +# 0.1.0: "yaml_file_name_goes_here_0.1.0.yaml" +# +#------------------------------------------------- + +# For Sentient.io API documentation maintenance: +# There is a yamlPath variable contains the path of where the yaml file is stored +# The final yaml link will be a combination of {{yamlPath + / + category + / + verions['v1.0']}} + +voice: + automatic_speech_recognition_eng_sg: + title: Automatic Speech Recognition ENG (SG) + versions: + 1.1.0: 'automatic_speech_recognition_eng_sg_v1.0.yaml' + 0.1.0: 'automatic_speech_recognition_eng_sg.yaml' + automatic_speech_recognition_chi_sg: + title: Automatic Speech Recognition CHI (SG) + versions: + 0.1.0: 'automatic_speech_recognition_chi_sg.yaml' + online_automatic_speech_recognition_eng_sg: + title: Online Automatic Speech Recognition ENG (SG) + versions: + 0.1.0: 'online_automatic_speech_recognition_eng_sg.yaml' + online_command_automatic_speech_recognition_eng_sg: + title: Online Command Automatic Speech Recognition ENG (SG) + versions: + 0.1.0: 'online_command_automatic_speech_recognition_eng_sg.yaml' + text-to-speech_eng: + title: Text-To-Speech ENG + versions: + 0.1.0: 'text-to-speech_eng.yaml' + text-to-speech_chi: + title: Text-To-Speech CHI + versions: + 0.1.0: 'text-to-speech_chi.yaml' + asr_with_voice_activity_detection_eng_sg: + title: ASR with Voice Activity Detection ENG (SG) + versions: + 1.1.0: 'asr_with_voice_activity_detection_eng_sg_v1.0.yaml' + 0.1.0: 'asr_with_voice_activity_detection_eng_sg.yaml' + voice_activity_detection_eng: + title: Voice Activity Detection ENG + versions: + 1.1.0: 'voice_activity_detection_eng_v1.0.yaml' + 0.1.0: 'voice_activity_detection_eng.yaml' +nlp: + inverse_text_normalisation_eng: + title: Inverse Text Normalisation ENG + versions: + 1.1.0: 'inverse_text_normalisation_eng_v1.0.yaml' + 0.1.0: 'inverse_text_normalisation_eng.yaml' + named-entity_recognition_eng: + title: Named-Entity Recognition ENG + versions: + 1.1.0: 'named-entity_recognition_eng_v1.0.yaml' + 0.1.0: 'named-entity_recognition_eng.yaml' + spacy_ner: + title: spaCy NER + versions: + 0.1.0: 'spacy_named-entity_recognition_eng.yaml' + page_profiler_eng: + title: Page Profiler ENG + versions: + 2.1.1: 'page_profiler_eng_v2.1.yaml' + page_profiler_jp: + title: Page Profiler JP + versions: + 1.1.0: 'page_profiler_jp.yaml' + page_profiler_thai: + title: Page Profiler THAI + versions: + 1.1.0: 'page_profiler_thai.yaml' + taxonomy_matcher_eng: + title: Taxonomy Matcher ENG + versions: + 1.0.0: 'taxonomy_matcher_eng_v1.0.yaml' + 0.1.0: 'taxonomy_matcher_eng.yaml' + word_sense_disambiguation_eng: + title: Word Sense Disambiguation ENG + versions: + 1.0.0: 'word_sense_disambiguation_eng_v1.0.yaml' + 0.1.0: 'word_sense_disambiguation_eng.yaml' + named-entity_recognition_jp: + title: Named-Entity Recognition JP + versions: + 1.0.0: 'named-entity_recognition_jp_v1.0.yaml' + 0.1.0: 'named-entity_recognition_jp.yaml' + named-entity_recognition_thai: + title: Named Entity Recognition THAI + versions: + 1.0.0: 'named-entity_recognition_thai_v1.0.yaml' + 0.1.0: 'named-entity_recognition_thai.yaml' + script_alignment: + title: Script Alignment + versions: + 1.0.0: 'script_alignment_v1.0.yaml' + 0.1.0: 'script_alignment.yaml' +computer vision: + object_detection: + title: Object Detection + versions: + 1.0.0: 'object_detection_v1.0.yaml' + 0.1.0: 'object_detection.yaml' + face_recognition: + title: Face Recognition + versions: + 1.0.1: 'face_recognition_v1.0.yaml' + 0.1.0: 'face_recognition_politicians_sg.yaml' + people_counting: + title: People Counting + versions: + 1.0.0: 'people_counting_v1.0.yaml' + 0.1.0: 'people_counting.yaml' + landmark_detection_sg: + title: Landmark Detection (SG) + versions: + 1.0.0: 'landmark_detection_sg_v1.0.yaml' + 0.1.0: 'landmark_detection_sg.yaml' + landmark_detection_jp: + title: Landmark Detection (JP) + versions: + 1.0.0: 'landmark_detection_jp_v1.0.yaml' + 0.1.0: 'landmark_detection_jp.yaml' + demographics_classification: + title: Demographics Classification + versions: + 0.1.0: 'demographics_classification.yaml' +utility: + youtube_video_downloader: + title: Youtube Video Downloader + versions: + 0.1.0: 'youtube_video_downloader.yaml' + video-to-audio_convertor: + title: Video-To-Audio Convertor + versions: + 0.1.0: 'video-to-audio_convertor.yaml' + web_scraper: + title: Web Scraper + versions: + 1.1.1: 'web_scraper.yaml' + document_convertor_eng: + title: Document Convertor ENG + versions: + 1.0.0: 'document_convertor_eng.yaml' + pdf_extractor: + title: PDF Extractor + versions: + 1.0.0: 'pdf_extractor.yaml' + pki_key_generator: + title: PKI Key Generator + versions: + 0.1.0: 'pki_key_generator.yaml' + encryption_using_pki_key: + title: Encryption using PKI Key + versions: + 0.1.0: 'encryption_using_pki_key.yaml' + decryption_using_pki_key: + title: Decryption using PKI Key + versions: + 0.1.0: 'decryption_using_pki_key.yaml' + wikipedia_retrieval: + title: Wikipedia Retrieval + versions: + 1.0.0: 'wikipedia_retrieval_v1.0.yaml' + 0.1.0: 'wikipedia_retrieval.yaml' + json-csv_convertor: + title: JSON-CSV Convertor + versions: + 1.0.0: 'json-csv_convertor.yaml' + csv-json_convertor: + title: CSV-JSON Convertor + versions: + 1.0.0: 'csv-json_convertor.yaml' + audio_format_convertor: + title: Audio Format Convertor + versions: + 0.1.0: 'audio_format_convertor.yaml' + video-to-image_convertor: + title: Video-to-Image Convertor + versions: + 0.1.0: 'video-to-image_convertor.yaml' + newspaper_article_scraper: + title: Newspaper Article Scraper + versions: + 0.1.0: 'newspaper_article_scraper.yaml' + urls_retrieval: + title: URLs Retrieval + versions: + 0.2.1: 'urls_retrieval.yaml' + base64_encoder: + title: Base64 Encoder + versions: + 0.1.0: 'base64-encoder.yaml' + base64_decoder: + title: Base64 Decoder + versions: + 0.1.0: 'base64-decoder.yaml' +data: + commercial_directories_hdb_sg: + title: HDB Commercial Directories (SG) + versions: + 0.1.0: 'commercial_directories_hdb_sg.yaml' + building_addresses_hdb_sg: + title: HDB Block Coordinates (SG) + versions: + 0.1.0: 'building_addresses_hdb_sg.yaml' + residential_sales_and_rental_hdb_sg: + title: HDB Residential Occupancy Status (SG) + versions: + 0.1.0: 'residential_sales_and_rental_hdb_sg.yaml' + carpark_hdb_sg: + title: HDB Carpark Locations (SG) + versions: + 0.2.0: 'carpark_hdb_sg.yaml' + demographics_hdb_sg: + title: HDB Demographics (SG) + versions: + 0.1.0: 'demographics_hdb_sg.yaml' + flat_ownership_hdb_sg: + title: HDB Flat Ownership Duration (SG) + versions: + 0.1.0: 'flat_ownership_hdb_sg.yaml' + season_parking_availability_hdb_sg: + title: HDB Season Parking Availability (SG) + versions: + 0.1.0: 'season_parking_availability_hdb_sg.yaml' + directory_of_singapore_startups: + title: Directory of Singapore Startups + versions: + 0.1.0: 'directory_of_singapore_startups.yaml' + fitness_stations_and_playgrounds_hdb_sg: + title: HDB Fitness Stations and Playgrounds (SG) + versions: + 0.1.0: 'fitness_stations_and_playgrounds_hdb_sg.yaml' + amenities_lamp_posts_hdb_sg: + title: HDB Lamp Posts Locations (SG) + versions: + 0.1.0: 'amenities_lamp_posts_hdb_sg.yaml' + amenities_hardcourts_hdb_sg: + title: HDB Hardcourts Locations (SG) + versions: + 0.1.0: 'amenities_hardcourts_hdb_sg.yaml' + amenities_shelters_hdb_sg: + title: HDB Shelters Locations (SG) + versions: + 0.1.0: 'amenities_shelters_hdb_sg.yaml' + d&b_business_check_plus_sg: + title: D&B Business Check Plus (SG) + versions: + 0.1.0: 'd&b_business_check_plus_sg.yaml' + d&b_basic_individual_search_sg: + title: D&B Basic Individual Search (SG) + versions: + 0.1.0: 'd&b_basic_individual_search_sg.yaml' + d&b_business_check_sg: + title: D&B Business Check (SG) + versions: + 0.1.0: 'd&b_business_check_sg.yaml' + d&b_brief_financial_information_sg: + title: D&B Brief Financial Information (SG) + versions: + 0.1.0: 'd&b_brief_financial_information_sg.yaml' +data alliance: + download_dataset_api: + title: Download Dataset API + urlkey: download_dataset_api + versions: + 0.1.0: 'download_dataset.yaml' diff --git a/yaml/inverse_text_normalisation_eng.yaml b/nlp/inverse_text_normalisation_eng.yaml similarity index 100% rename from yaml/inverse_text_normalisation_eng.yaml rename to nlp/inverse_text_normalisation_eng.yaml diff --git a/yaml/inverse_text_normalisation_eng_v1.0.yaml b/nlp/inverse_text_normalisation_eng_v1.0.yaml similarity index 100% rename from yaml/inverse_text_normalisation_eng_v1.0.yaml rename to nlp/inverse_text_normalisation_eng_v1.0.yaml diff --git a/yaml/named-entity_recognition_eng.yaml b/nlp/named-entity_recognition_eng.yaml similarity index 100% rename from yaml/named-entity_recognition_eng.yaml rename to nlp/named-entity_recognition_eng.yaml diff --git a/yaml/named-entity_recognition_eng_v1.0.yaml b/nlp/named-entity_recognition_eng_v1.0.yaml similarity index 100% rename from yaml/named-entity_recognition_eng_v1.0.yaml rename to nlp/named-entity_recognition_eng_v1.0.yaml diff --git a/yaml/named-entity_recognition_jp.yaml b/nlp/named-entity_recognition_jp.yaml similarity index 100% rename from yaml/named-entity_recognition_jp.yaml rename to nlp/named-entity_recognition_jp.yaml diff --git a/yaml/named-entity_recognition_jp_v1.0.yaml b/nlp/named-entity_recognition_jp_v1.0.yaml similarity index 100% rename from yaml/named-entity_recognition_jp_v1.0.yaml rename to nlp/named-entity_recognition_jp_v1.0.yaml diff --git a/yaml/named-entity_recognition_thai.yaml b/nlp/named-entity_recognition_thai.yaml similarity index 100% rename from yaml/named-entity_recognition_thai.yaml rename to nlp/named-entity_recognition_thai.yaml diff --git a/yaml/named-entity_recognition_thai_v1.0.yaml b/nlp/named-entity_recognition_thai_v1.0.yaml similarity index 100% rename from yaml/named-entity_recognition_thai_v1.0.yaml rename to nlp/named-entity_recognition_thai_v1.0.yaml diff --git a/nlp/page_profiler_eng.yaml b/nlp/page_profiler_eng.yaml new file mode 100644 index 000000000..780eb4217 --- /dev/null +++ b/nlp/page_profiler_eng.yaml @@ -0,0 +1,255 @@ + openapi: 3.0.1 + info: + title: Page Profiler ENG + description: |+ + This NLP microservice retrieves web content in English from the input URL. + + From the web content, the microservice then applies natural language processing to extracts named-entities and returns the output. + + The named-entity classes extracted are persons, locations, organisations and miscellaneous.

This microservice automatically extracts structured information from unstructured text data such as chatlogs, emails, news articles, etc. + + Do ensure that your URL text is in the **ASCII format**. + x-additionalinfo: |+ + Suggested Use Cases: + - Gain insights from online customers - extract structured information from unstructured text data such as chatlogs, emails, news articles, etc. to find and label fields within a document and then apply sentiment analysis to understand customer opinions to find actionable product and UX insights. + + - Entity analysis - identify entities within documents, including receipts, invoices, and contracts; and label them by types such as date, person, contact information, organization, location, events, products, and media. + version: '1.0.0' + x-subscribelink: page_profiler_eng + x-depreciated: "Oct 15, 2020" + servers: + - url: 'https://apis.sentient.io' + tags: + - name: "v1.0.0" + description: "Published Date - May 15, 2020" + paths: + /microservices/nlp/pageprofiler/v1.0/getpredictions: + post: + tags: + - v1.0.0 + responses: + '200': + description: success response + content: + application/json: + schema: + $ref: '#/components/schemas/success' + example: {"LOC": ["Beijing","Atlanta","Indonesia"], "MISC": [Twiight,Singaporean],"ORG": [CNA,Singapore Parliament],"PER": [Skip Navigation,Bookmarks]} + '401': + description: Unauthorized + content: + application/json: + schema: + $ref: '#/components/schemas/unauthorized' + '402': + description: Payment Required + content: + application/json: + schema: + $ref: '#/components/schemas/paymentrequired' + '403': + description: Forbidden + content: + application/json: + schema: + $ref: '#/components/schemas/forbidden' + '404': + description: Not Found + content: + application/json: + schema: + $ref: '#/components/schemas/notfound' + '419': + description: Not Found + content: + application/json: + schema: + $ref: '#/components/schemas/inputfieldmissing' + '420': + description: Not Found + content: + application/json: + schema: + $ref: '#/components/schemas/inputlimitexceeded' + '422': + description: Invalid Input + content: + application/json: + schema: + $ref: '#/components/schemas/invalidinput' + '500': + description: Internal Server Error + content: + application/json: + schema: + $ref: '#/components/schemas/servererror' + '504': + description: Gateway Timeout + content: + application/json: + schema: + $ref: '#/components/schemas/gatewaytimeout' + security: + - APIAuthorizer: [] + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/input' + required: true + components: + schemas: + success: + type: object + properties: + LOC: + type: array + example: ["Beijing","Atlanta","Indonesia"] + description: "name of location found in the text string" + MISC: + type: array + example: [Twiight,Singaporean] + description: "name of miscellaneous names found in the text string" + ORG: + type: array + example: [CNA,Singapore Parliament] + description: "name of organizations found in the text string" + PER: + type: array + example: [Skip Navigation,Bookmarks] + description: "name of persons found in the text string" + + unauthorized: + type: object + properties: + message: + type: string + example: Missing Authentication Token + status: + type: string + example: Failure + forbidden: + type: object + properties: + message: + type: string + example: Access Denied Unauthorized User + status: + type: string + example: Failure + paymentrequired: + type: object + properties: + message: + type: string + example: Insufficient Credits Kindly Top Up + status: + type: string + example: Failure + notfound: + type: object + properties: + message: + type: string + example: Invalid Request URL + status: + type: string + example: Failure + servererror: + type: object + properties: + message: + type: string + example: Internal Server Error + status: + type: string + example: Failure + invalidinput: + type: object + properties: + message: + type: string + example: Invalid Input + status: + type: string + example: Failure + gatewaytimeout: + type: object + properties: + message: + type: string + example: Request Timeout + status: + type: string + example: Failure + inputfieldmissing: + type: object + properties: + message: + type: string + example: Input Field Missing + status: + type: string + example: Failure + inputlimitexceeded: + type: object + properties: + message: + type: string + example: Input Limit Exceeded + status: + type: string + example: Failure + versions: + type: object + properties: + v2.1.0: + type: array + items: + oneOf: + - type: string + example: Published Date - Oct 30, 2020 + description: Partial URL support + v2.0.0: + type: array + items: + oneOf: + - type: string + example: Published Date - Sep 30, 2020 + description: Standardizing Output JSON + v1.0.0: + type: array + items: + oneOf: + - type: string + example: Published Date - May 15, 2018 + description: Swaping the NLP with Named-Entity Recognition ENG + v0.1.0: + type: array + items: + oneOf: + - type: string + example: Published Date - Apr 16, 2018 + description: Initial version release + input: + type: object + required: + - url + properties: + url: + x-name: url + type: string + default: true + example: https://www.sentient.io/en/ + description: |+ + The URL of the page to be profiled. + + Note that the URL has to be spelt in full, including "https://www." + + securitySchemes: + APIAuthorizer: + type: apiKey + name: x-api-key + in: header + x-amazon-apigateway-authtype: custom + description: Authentication is done using the x-api-key in the request header diff --git a/yaml/page_profiler_eng_v2.0.yaml b/nlp/page_profiler_eng_v2.0.yaml similarity index 100% rename from yaml/page_profiler_eng_v2.0.yaml rename to nlp/page_profiler_eng_v2.0.yaml diff --git a/yaml/page_profiler_eng_v2.1.yaml b/nlp/page_profiler_eng_v2.1.yaml similarity index 100% rename from yaml/page_profiler_eng_v2.1.yaml rename to nlp/page_profiler_eng_v2.1.yaml diff --git a/yaml/page_profiler_jp.yaml b/nlp/page_profiler_jp.yaml similarity index 100% rename from yaml/page_profiler_jp.yaml rename to nlp/page_profiler_jp.yaml diff --git a/yaml/page_profiler_thai.yaml b/nlp/page_profiler_thai.yaml similarity index 100% rename from yaml/page_profiler_thai.yaml rename to nlp/page_profiler_thai.yaml diff --git a/yaml/script_alignment.yaml b/nlp/script_alignment.yaml similarity index 100% rename from yaml/script_alignment.yaml rename to nlp/script_alignment.yaml diff --git a/yaml/script_alignment_v1.0.yaml b/nlp/script_alignment_v1.0.yaml similarity index 100% rename from yaml/script_alignment_v1.0.yaml rename to nlp/script_alignment_v1.0.yaml diff --git a/yaml/spacy_named-entity_recognition_eng.yaml b/nlp/spacy_named-entity_recognition_eng.yaml similarity index 100% rename from yaml/spacy_named-entity_recognition_eng.yaml rename to nlp/spacy_named-entity_recognition_eng.yaml diff --git a/yaml/taxonomy_matcher_eng.yaml b/nlp/taxonomy_matcher_eng.yaml similarity index 100% rename from yaml/taxonomy_matcher_eng.yaml rename to nlp/taxonomy_matcher_eng.yaml diff --git a/yaml/taxonomy_matcher_eng_v1.0.yaml b/nlp/taxonomy_matcher_eng_v1.0.yaml similarity index 100% rename from yaml/taxonomy_matcher_eng_v1.0.yaml rename to nlp/taxonomy_matcher_eng_v1.0.yaml diff --git a/yaml/word_sense_disambiguation_eng.yaml b/nlp/word_sense_disambiguation_eng.yaml similarity index 100% rename from yaml/word_sense_disambiguation_eng.yaml rename to nlp/word_sense_disambiguation_eng.yaml diff --git a/yaml/word_sense_disambiguation_eng_v1.0.yaml b/nlp/word_sense_disambiguation_eng_v1.0.yaml similarity index 100% rename from yaml/word_sense_disambiguation_eng_v1.0.yaml rename to nlp/word_sense_disambiguation_eng_v1.0.yaml diff --git a/yaml/audio_format_convertor.yaml b/utility/audio_format_convertor.yaml similarity index 100% rename from yaml/audio_format_convertor.yaml rename to utility/audio_format_convertor.yaml diff --git a/yaml/base64-decoder.yaml b/utility/base64-decoder.yaml similarity index 100% rename from yaml/base64-decoder.yaml rename to utility/base64-decoder.yaml diff --git a/yaml/base64-encoder.yaml b/utility/base64-encoder.yaml similarity index 100% rename from yaml/base64-encoder.yaml rename to utility/base64-encoder.yaml diff --git a/yaml/base64-file-decode.yaml b/utility/base64-file-decode.yaml similarity index 100% rename from yaml/base64-file-decode.yaml rename to utility/base64-file-decode.yaml diff --git a/yaml/base64-file-encode.yaml b/utility/base64-file-encode.yaml similarity index 100% rename from yaml/base64-file-encode.yaml rename to utility/base64-file-encode.yaml diff --git a/yaml/csv-json_convertor.yaml b/utility/csv-json_convertor.yaml similarity index 100% rename from yaml/csv-json_convertor.yaml rename to utility/csv-json_convertor.yaml diff --git a/yaml/decryption_using_pki_key.yaml b/utility/decryption_using_pki_key.yaml similarity index 100% rename from yaml/decryption_using_pki_key.yaml rename to utility/decryption_using_pki_key.yaml diff --git a/yaml/document_convertor_eng.yaml b/utility/document_convertor_eng.yaml similarity index 100% rename from yaml/document_convertor_eng.yaml rename to utility/document_convertor_eng.yaml diff --git a/utility/download_dataset.yaml b/utility/download_dataset.yaml new file mode 100644 index 000000000..34c1dc112 --- /dev/null +++ b/utility/download_dataset.yaml @@ -0,0 +1,10 @@ +info: + title: Data Alliance - Download Dataset API + version: '0.1.0' +# tags must include in to the documentation, to read the description text for published date +tags: +- name: "v0.1.0" + description: " " +html: |+ + diff --git a/yaml/encryption_using_pki_key.yaml b/utility/encryption_using_pki_key.yaml similarity index 100% rename from yaml/encryption_using_pki_key.yaml rename to utility/encryption_using_pki_key.yaml diff --git a/yaml/sentiment-analysis-google.yaml b/utility/inverse_text_normalisation_eng.yaml similarity index 50% rename from yaml/sentiment-analysis-google.yaml rename to utility/inverse_text_normalisation_eng.yaml index d55a210b5..10520a858 100644 --- a/yaml/sentiment-analysis-google.yaml +++ b/utility/inverse_text_normalisation_eng.yaml @@ -1,13 +1,24 @@ openapi: 3.0.1 info: - title: Sentiment Analysis Google - description: >- - The sentiment analysis will help to determine the expressed emotional state of person by using natural language processing to analyse a range of parameters, including tone of voice, choice of words.

This is a passthrough to Google’s sentiment analyser. + title: Inverse Text Normalisation ENG + description: |+ + This NLP microservice recovers missing punctuations such as full stop, comma, exclamation mark, and question mark from the input text. + + This NLP microservice also converts pre-defined abbreviations from lower case to upper case. + + This NLP microservice also converts first letters of sentences to upper case. + x-additionalinfo: |+ + Suggested Use Cases: + - Can be integrated into services or apps that offer digital writing assistance to make writing clear and effective. version: '0.1.0' + x-subscribelink: inverse_text_normalisation_eng servers: - - url: 'https://api.sentient.io' + - url: 'https://apis.sentient.io' +tags: +- name: "v0.1.0" + description: "Published Date - Mar 24, 2020" paths: - /sentimentanalysis/prod/googlesa: + /microservices/nlp/inversenorm/v0.1/getpredictions: post: tags: - v0.1.0 @@ -18,6 +29,18 @@ paths: application/json: schema: $ref: '#/components/schemas/success' + example: + '0': |+ + Apple said, the project-financing fund was the 1 of its kind, real estate developers, + often secure bonds for affordable housing development, but must service the debt + during construction, until the houses are built and start to generate revenue, apple + and state officials hope to provide bridge financing during construction at rates + below those from commercial lenders. + '1': |+ + The $2000000000 in funding will be deployable across NTU while the remaining + 5500000000 will go toward efforts specific to apple's home region in northern california, + where fast-growing tech companies have drawn protests from residents who blame them + for rising, housing costs. '401': description: Unauthorized content: @@ -48,14 +71,20 @@ paths: application/json: schema: $ref: '#/components/schemas/inputfieldmissing' - '420': + '413': description: Input Limit Exceeded content: application/json: schema: - $ref: '#/components/schemas/inputlimitexceeded' + $ref: '#/components/schemas/inputlimitexceeded' + '415': + description: Invalid Input + content: + application/json: + schema: + $ref: '#/components/schemas/invalidinput' '500': - description: Internal Server error + description: Internal Server Error content: application/json: schema: @@ -79,18 +108,10 @@ components: success: type: object properties: - documentSentiment: - items: - type: string - example: 'magnitude: 0.1,score: 0.1' - language: + : type: string - example: en - sentences: - items: - type: string - example: 'text: {content: hi there, - beginOffset: 0},sentiment:{magnitude: 0.1,score: 0.1}' + example: { 0: Apple said, the project-financing fund was the 1 of its kind, real estate developers, often secure bonds for affordable housing development, but must service the debt during construction, until the houses are built and start to generate revenue, apple and state officials hope to provide bridge financing during construction at rates below those from commercial lenders.} + description: Order sequence number unauthorized: type: object properties: @@ -132,7 +153,7 @@ components: properties: message: type: string - example: Internal Server error + example: Internal Server Error status: type: string example: Failure @@ -162,15 +183,46 @@ components: example: Input Limit Exceeded status: type: string - example: Failure - input: + example: Failure + invalidinput: type: object properties: - key: + message: type: string + example: Invalid Input + status: + type: string + example: Failure + versions: + type: object + properties: + v0.1.0: + type: array + items: + oneOf: + - type: string + example: Published Date - Mar 24, 2020 + description: Initial version release + input: + type: array + required: + - text + items: + type: object + properties: + text: + x-name: text + type: string + default: true + example: Apple said the project-financing fund was the first of its kind Real estate developers often secure bonds for affordable housing development but must service the debt during construction until the houses are built and start to generate revenue Apple and state officials hope to provide bridge financing during construction at rates below those from commercial lenders + description: |+ + Input text. + + Supported formats: ASCII only securitySchemes: APIAuthorizer: type: apiKey name: x-api-key in: header x-amazon-apigateway-authtype: custom + description: Authentication is done using the x-api-key in the request header diff --git a/utility/inverse_text_normalisation_eng_v1.0.yaml b/utility/inverse_text_normalisation_eng_v1.0.yaml new file mode 100644 index 000000000..63e1e1e8b --- /dev/null +++ b/utility/inverse_text_normalisation_eng_v1.0.yaml @@ -0,0 +1,248 @@ +openapi: 3.0.1 +info: + title: Inverse Text Normalisation ENG + description: |+ + This NLP microservice recovers the missing punctuations such as full stop, comma, exclamation mark, and question mark from the input text. + + It converts pre-defined abbreviations from lower case to upper case and also first letters of sentences to upper case. + + Do ensure that your text is within **5000 characters**. + version: '1.0.0' + x-additionalinfo: |+ + Suggested Use Cases: + - Can be integrated into services or apps that offer digital writing assistance to make writing clear and effective. + x-subscribelink: inverse_text_normalisation_eng +servers: + - url: 'https://apis.sentient.io' +tags: +- name: "v1.0.0" + description: "Published Date - Oct 30, 2020" +paths: + /microservices/nlp/inversenorm/v1/getpredictions: + post: + tags: + - v1.0.0 + responses: + '200': + description: success response + content: + application/json: + schema: + $ref: '#/components/schemas/success' + example: + results: + '0': |+ + Apple said, the project-financing fund was the 1 of its kind, real estate developers, + often secure bonds for affordable housing development, but must service the debt + during construction, until the houses are built and start to generate revenue, apple + and state officials hope to provide bridge financing during construction at rates + below those from commercial lenders. + '1': |+ + The $2000000000 in funding will be deployable across NTU while the remaining + 5500000000 will go toward efforts specific to apple's home region in northern california, + where fast-growing tech companies have drawn protests from residents who blame them + for rising, housing costs. + message: Successfully Processed + status: Success + '401': + description: Unauthorized + content: + application/json: + schema: + $ref: '#/components/schemas/unauthorized' + '402': + description: Payment Required + content: + application/json: + schema: + $ref: '#/components/schemas/paymentrequired' + '403': + description: Forbidden + content: + application/json: + schema: + $ref: '#/components/schemas/forbidden' + '404': + description: Not Found + content: + application/json: + schema: + $ref: '#/components/schemas/notfound' + '419': + description: Input Field Missing + content: + application/json: + schema: + $ref: '#/components/schemas/inputfieldmissing' + '413': + description: Input Limit Exceeded + content: + application/json: + schema: + $ref: '#/components/schemas/inputlimitexceeded' + '415': + description: Invalid Input + content: + application/json: + schema: + $ref: '#/components/schemas/invalidinput' + '500': + description: Internal Server Error + content: + application/json: + schema: + $ref: '#/components/schemas/servererror' + '504': + description: Gateway Timeout + content: + application/json: + schema: + $ref: '#/components/schemas/gatewaytimeout' + security: + - APIAuthorizer: [] + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/input' + required: true +components: + schemas: + success: + type: object + properties: + results: + type: object + description: The result of the API call. + example: { "" } + properties: + : + x-name: + type: string + example: { 0: Apple said, the project-financing fund was the 1 of its kind, real estate developers, often secure bonds for affordable housing development, but must service the debt during construction, until the houses are built and start to generate revenue, apple and state officials hope to provide bridge financing during construction at rates below those from commercial lenders.} + description: Order sequence number + message: + type: string + example: Successfully Processed + description: Detail description on the API status + status: + type: string + example: Success + description: The status of the API call success/failure + unauthorized: + type: object + properties: + message: + type: string + example: Missing Authentication Token + status: + type: string + example: Failure + forbidden: + type: object + properties: + message: + type: string + example: Access Denied Unauthorized User + status: + type: string + example: Failure + paymentrequired: + type: object + properties: + message: + type: string + example: Insufficient Credits Kindly Top Up + status: + type: string + example: Failure + notfound: + type: object + properties: + message: + type: string + example: Invalid Request URL + status: + type: string + example: Failure + servererror: + type: object + properties: + message: + type: string + example: Internal Server Error + status: + type: string + example: Failure + gatewaytimeout: + type: object + properties: + message: + type: string + example: Request Timeout + status: + type: string + example: Failure + inputfieldmissing: + type: object + properties: + message: + type: string + example: Input Field Missing + status: + type: string + example: Failure + inputlimitexceeded: + type: object + properties: + message: + type: string + example: Input Limit Exceeded + status: + type: string + example: Failure + invalidinput: + type: object + properties: + message: + type: string + example: Invalid Input + status: + type: string + example: Failure + versions: + type: object + properties: + v1.0.0: + type: array + items: + oneOf: + - type: string + example: Published Date - Oct 30,2020 + description: Standardizing Output JSON + v0.1.0: + type: array + items: + oneOf: + - type: string + example: Published Date - Mar 24, 2020 + description: Initial version release + input: + type: object + required: + - text + properties: + text: + x-name: text + type: string + default: true + example: Apple said the project-financing fund was the first of its kind Real estate developers often secure bonds for affordable housing development but must service the debt during construction until the houses are built and start to generate revenue Apple and state officials hope to provide bridge financing during construction at rates below those from commercial lenders + description: |+ + Input text + securitySchemes: + APIAuthorizer: + type: apiKey + name: x-api-key + in: header + x-amazon-apigateway-authtype: custom + description: Authentication is done using the x-api-key in the request header diff --git a/yaml/json-csv_convertor.yaml b/utility/json-csv_convertor.yaml similarity index 100% rename from yaml/json-csv_convertor.yaml rename to utility/json-csv_convertor.yaml diff --git a/yaml/newspaper_article_scraper.yaml b/utility/newspaper_article_scraper.yaml similarity index 100% rename from yaml/newspaper_article_scraper.yaml rename to utility/newspaper_article_scraper.yaml diff --git a/yaml/pdf_extractor.yaml b/utility/pdf_extractor.yaml similarity index 100% rename from yaml/pdf_extractor.yaml rename to utility/pdf_extractor.yaml diff --git a/yaml/pki_key_generator.yaml b/utility/pki_key_generator.yaml similarity index 100% rename from yaml/pki_key_generator.yaml rename to utility/pki_key_generator.yaml diff --git a/yaml/urls_retrieval.yaml b/utility/urls_retrieval.yaml similarity index 100% rename from yaml/urls_retrieval.yaml rename to utility/urls_retrieval.yaml diff --git a/yaml/video-to-audio_convertor.yaml b/utility/video-to-audio_convertor.yaml similarity index 100% rename from yaml/video-to-audio_convertor.yaml rename to utility/video-to-audio_convertor.yaml diff --git a/yaml/video-to-image_convertor.yaml b/utility/video-to-image_convertor.yaml similarity index 100% rename from yaml/video-to-image_convertor.yaml rename to utility/video-to-image_convertor.yaml diff --git a/yaml/web_scraper.yaml b/utility/web_scraper.yaml similarity index 100% rename from yaml/web_scraper.yaml rename to utility/web_scraper.yaml diff --git a/yaml/wikipedia_retrieval.yaml b/utility/wikipedia_retrieval.yaml similarity index 100% rename from yaml/wikipedia_retrieval.yaml rename to utility/wikipedia_retrieval.yaml diff --git a/yaml/wikipedia_retrieval_v1.0.yaml b/utility/wikipedia_retrieval_v1.0.yaml similarity index 100% rename from yaml/wikipedia_retrieval_v1.0.yaml rename to utility/wikipedia_retrieval_v1.0.yaml diff --git a/yaml/youtube_video_downloader.yaml b/utility/youtube_video_downloader.yaml similarity index 100% rename from yaml/youtube_video_downloader.yaml rename to utility/youtube_video_downloader.yaml diff --git a/yaml/asr_with_voice_activity_detection_eng_sg.yaml b/voice/asr_with_voice_activity_detection_eng_sg.yaml similarity index 100% rename from yaml/asr_with_voice_activity_detection_eng_sg.yaml rename to voice/asr_with_voice_activity_detection_eng_sg.yaml diff --git a/yaml/asr_with_voice_activity_detection_eng_sg_v1.0.yaml b/voice/asr_with_voice_activity_detection_eng_sg_v1.0.yaml similarity index 100% rename from yaml/asr_with_voice_activity_detection_eng_sg_v1.0.yaml rename to voice/asr_with_voice_activity_detection_eng_sg_v1.0.yaml diff --git a/yaml/automatic_speech_recognition_chi_sg.yaml b/voice/automatic_speech_recognition_chi_sg.yaml similarity index 100% rename from yaml/automatic_speech_recognition_chi_sg.yaml rename to voice/automatic_speech_recognition_chi_sg.yaml diff --git a/yaml/automatic_speech_recognition_eng.yaml b/voice/automatic_speech_recognition_eng.yaml similarity index 100% rename from yaml/automatic_speech_recognition_eng.yaml rename to voice/automatic_speech_recognition_eng.yaml diff --git a/yaml/automatic_speech_recognition_eng_sg.yaml b/voice/automatic_speech_recognition_eng_sg.yaml similarity index 100% rename from yaml/automatic_speech_recognition_eng_sg.yaml rename to voice/automatic_speech_recognition_eng_sg.yaml diff --git a/yaml/automatic_speech_recognition_eng_sg_v1.0.yaml b/voice/automatic_speech_recognition_eng_sg_v1.0.yaml similarity index 100% rename from yaml/automatic_speech_recognition_eng_sg_v1.0.yaml rename to voice/automatic_speech_recognition_eng_sg_v1.0.yaml diff --git a/yaml/automatic_voice_recognition_eng.yaml b/voice/automatic_voice_recognition_eng.yaml similarity index 100% rename from yaml/automatic_voice_recognition_eng.yaml rename to voice/automatic_voice_recognition_eng.yaml diff --git a/yaml/online_automatic_speech_recognition_eng_sg.yaml b/voice/online_automatic_speech_recognition_eng_sg.yaml similarity index 100% rename from yaml/online_automatic_speech_recognition_eng_sg.yaml rename to voice/online_automatic_speech_recognition_eng_sg.yaml diff --git a/yaml/online_command_automatic_speech_recognition_eng_sg.yaml b/voice/online_command_automatic_speech_recognition_eng_sg.yaml similarity index 100% rename from yaml/online_command_automatic_speech_recognition_eng_sg.yaml rename to voice/online_command_automatic_speech_recognition_eng_sg.yaml diff --git a/yaml/text-to-speech_chi.yaml b/voice/text-to-speech_chi.yaml similarity index 100% rename from yaml/text-to-speech_chi.yaml rename to voice/text-to-speech_chi.yaml diff --git a/yaml/text-to-speech_eng.yaml b/voice/text-to-speech_eng.yaml similarity index 100% rename from yaml/text-to-speech_eng.yaml rename to voice/text-to-speech_eng.yaml diff --git a/yaml/voice_activity_detection_eng.yaml b/voice/voice_activity_detection_eng.yaml similarity index 100% rename from yaml/voice_activity_detection_eng.yaml rename to voice/voice_activity_detection_eng.yaml diff --git a/yaml/voice_activity_detection_eng_v1.0.yaml b/voice/voice_activity_detection_eng_v1.0.yaml similarity index 100% rename from yaml/voice_activity_detection_eng_v1.0.yaml rename to voice/voice_activity_detection_eng_v1.0.yaml diff --git a/yaml/index.yaml b/yaml/index.yaml deleted file mode 100644 index a076a26aa..000000000 --- a/yaml/index.yaml +++ /dev/null @@ -1,255 +0,0 @@ -Voice: - Automatic Speech Recognition ENG (SG): - title: automatic_speech_recognition_eng_sg - versions: - v1.0: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/automatic_speech_recognition_eng_sg_v1.0.yaml" - v0.1: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/automatic_speech_recognition_eng_sg.yaml" - Automatic Speech Recognition CHI (SG): - title: automatic_speech_recognition_chi_sg - versions: - v0.1: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/automatic_speech_recognition_chi_sg.yaml" - Online Automatic Speech Recognition ENG (SG): - title: online_automatic_speech_recognition_eng_sg - versions: - v0.1: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/online_automatic_speech_recognition_eng_sg.yaml" - Online Command Automatic Speech Recognition ENG (SG): - title: online_command_automatic_speech_recognition_eng_sg - versions: - v0.1: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/online_command_automatic_speech_recognition_eng_sg.yaml" - Text-To-Speech ENG: - title: text-to-speech_eng - versions: - v0.1: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/text-to-speech_eng.yaml" - Text-To-Speech CHI: - title: text-to-speech_chi - versions: - v0.1: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/text-to-speech_chi.yaml" - ASR with Voice Activity Detection ENG (SG): - title: asr_with_voice_activity_detection_eng_sg - versions: - v1.0: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/asr_with_voice_activity_detection_eng_sg_v1.0.yaml" - v0.1: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/asr_with_voice_activity_detection_eng_sg.yaml" - Voice Activity Detection ENG: - title: voice_activity_detection_eng - versions: - v1.0: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/voice_activity_detection_eng_v1.0.yaml" - v0.1: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/voice_activity_detection_eng.yaml" -NLP: - Inverse Text Normalisation ENG: - title: inverse_text_normalisation_eng - versions: - v1.0: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/inverse_text_normalisation_eng_v1.0.yaml" - v0.1: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/inverse_text_normalisation_eng.yaml" - Named-Entity Recognition ENG: - title: named-entity_recognition_eng - versions: - v1.0: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/named-entity_recognition_eng_v1.0.yaml" - v0.1: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/named-entity_recognition_eng.yaml" - spaCy NER: - title: spacy_ner - versions: - v0.1: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/spacy_named-entity_recognition_eng.yaml" - Page Profiler ENG: - title: page_profiler_eng - versions: - v2.1: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/page_profiler_eng_v2.1.yaml" - Page Profiler JP: - title: page_profiler_jp - versions: - v1.0: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/page_profiler_jp.yaml" - Page Profiler THAI: - title: page_profiler_thai - versions: - v1.0: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/page_profiler_thai.yaml" - Taxonomy Matcher ENG: - title: taxonomy_matcher_eng - versions: - v1.0: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/taxonomy_matcher_eng_v1.0.yaml" - v0.1: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/taxonomy_matcher_eng.yaml" - Word Sense Disambiguation ENG: - title: word_sense_disambiguation_eng - versions: - v1.0: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/word_sense_disambiguation_eng_v1.0.yaml" - v0.1: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/word_sense_disambiguation_eng.yaml" - Named-Entity Recognition JP: - title: named-entity_recognition_jp - versions: - v1.0: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/named-entity_recognition_jp_v1.0.yaml" - v0.1: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/named-entity_recognition_jp.yaml" - Named Entity Recognition THAI: - title: named-entity_recognition_thai - versions: - v1.0: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/named-entity_recognition_thai_v1.0.yaml" - v0.1: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/named-entity_recognition_thai.yaml" - Script Alignment: - title: script_alignment - versions: - v1.0: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/script_alignment_v1.0.yaml" - v0.1: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/script_alignment.yaml" -Computer Vision: - Object Detection: - title: object_detection - versions: - v0.1: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/object_detection.yaml" - Face Recognition: - title: face_recognition - versions: - v1.0: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/face_recognition_v1.0.yaml" - v0.1: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/face_recognition_politicians_sg.yaml" - People Counting: - title: people_counting - versions: - v0.1: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/people_counting.yaml" - Landmark Detection (SG): - title: landmark_detection_sg - versions: - v0.1: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/landmark_detection_sg.yaml" - Landmark Detection (JP): - title: landmark_detection_jp - versions: - v0.1: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/landmark_detection_jp.yaml" - Demographics Classification: - title: demographics_classification - versions: - v0.1: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/demographics_classification.yaml" -Utility: - Youtube Video Downloader: - title: youtube_video_downloader - versions: - v0.1: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/youtube_video_downloader.yaml" - Video-To-Audio Convertor: - title: video-to-audio_convertor - versions: - v0.1: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/video-to-audio_convertor.yaml" - Web Scraper: - title: web_scraper - versions: - v1.1: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/web_scraper.yaml" - Document Convertor ENG: - title: document_convertor_eng - versions: - v1.0: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/document_convertor_eng.yaml" - PDF Extractor: - title: pdf_extractor - versions: - v1.0: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/pdf_extractor.yaml" - PKI Key Generator: - title: pki_key_generator - versions: - v0.1: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/pki_key_generator.yaml" - Encryption using PKI Key: - title: encryption_using_pki_key - versions: - v0.1: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/encryption_using_pki_key.yaml" - Decryption using PKI Key: - title: decryption_using_pki_key - versions: - v0.1: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/decryption_using_pki_key.yaml" - Wikipedia Retrieval: - title: wikipedia_retrieval - versions: - v1.0: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/wikipedia_retrieval_v1.0.yaml" - v0.1: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/wikipedia_retrieval.yaml" - JSON-CSV Convertor: - title: json-csv_convertor - versions: - v1.0: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/json-csv_convertor.yaml" - CSV-JSON Convertor: - title: csv-json_convertor - versions: - v1.0: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/csv-json_convertor.yaml" - Audio Format Convertor: - title: audio_format_convertor - versions: - v0.1: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/audio_format_convertor.yaml" - Video-to-Image Convertor: - title: video-to-image_convertor - versions: - v0.1: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/video-to-image_convertor.yaml" - Newspaper Article Scraper: - title: newspaper_article_scraper - versions: - v0.1: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/newspaper_article_scraper.yaml" - URLs Retrieval: - title: urls_retrieval - versions: - v0.2: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/urls_retrieval.yaml" - Base64 Encoder: - title: base64_encoder - versions: - v0.1: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/base64-encoder.yaml" - Base64 Decoder: - title: base64_decoder - versions: - v0.1: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/base64-decoder.yaml" -Data: - HDB Commercial Directories (SG): - title: commercial_directories_hdb_sg - versions: - v0.1: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/commercial_directories_hdb_sg.yaml" - HDB Block Coordinates (SG): - title: building_addresses_hdb_sg - versions: - v0.1: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/building_addresses_hdb_sg.yaml" - HDB Residential Occupancy Status (SG): - title: residential_sales_and_rental_hdb_sg - versions: - v0.1: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/residential_sales_and_rental_hdb_sg.yaml" - HDB Carpark Locations (SG): - title: carpark_hdb_sg - versions: - v0.2: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/carpark_hdb_sg.yaml" - HDB Demographics (SG): - title: demographics_hdb_sg - versions: - v0.1: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/demographics_hdb_sg.yaml" - HDB Flat Ownership Duration (SG): - title: flat_ownership_hdb_sg - versions: - v0.1: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/flat_ownership_hdb_sg.yaml" - HDB Season Parking Availability (SG): - title: season_parking_availability_hdb_sg - versions: - v0.1: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/season_parking_availability_hdb_sg.yaml" - Directory of Singapore Startups: - title: directory_of_singapore_startups - versions: - v0.1: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/directory_of_singapore_startups.yaml" - HDB Fitness Stations and Playgrounds (SG): - title: fitness_stations_and_playgrounds_hdb_sg - versions: - v0.1: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/fitness_stations_and_playgrounds_hdb_sg.yaml" - HDB Lamp Posts Locations (SG): - title: amenities_lamp_posts_hdb_sg - versions: - v0.1: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/amenities_lamp_posts_hdb_sg.yaml" - HDB Hardcourts Locations (SG): - title: amenities_hardcourts_hdb_sg - versions: - v0.1: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/amenities_hardcourts_hdb_sg.yaml" - HDB Shelters Locations (SG): - title: amenities_shelters_hdb_sg - versions: - v0.1: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/amenities_shelters_hdb_sg.yaml" - D&B Business Check Plus (SG): - title: d&b_business_check_plus_sg - versions: - v0.1: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/d&b_business_check_plus_sg.yaml" - D&B Basic Individual Search (SG): - title: d&b_basic_individual_search_sg - versions: - v0.1: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/d&b_basic_individual_search_sg.yaml" - D&B Business Check (SG): - title: d&b_business_check_sg - versions: - v0.1: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/d&b_business_check_sg.yaml" - D&B Brief Financial Information (SG): - title: d&b_brief_financial_information_sg - versions: - v0.1: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/d&b_brief_financial_information_sg.yaml" -Data Alliance: - Download Dataset API: - title: download_dataset_api - urlkey: download_dataset_api - versions: - v0.1: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/download_dataset.yaml" diff --git a/yaml/staple_receipt.yaml b/yaml/staple_receipt.yaml deleted file mode 100644 index 050b4655e..000000000 --- a/yaml/staple_receipt.yaml +++ /dev/null @@ -1,1573 +0,0 @@ -openapi: 3.0.1 -info: - title: Staple Receipt - description: |+ - Scan the Receipt document from file and explore the data by catagorywise. - Supported formats are : pdf, jpg, png, docx, doc - version: '1.0.0' - x-subscribelink: staple_receipt -servers: - - url: 'https://dev-apis.sentient.io' -tags: -- name: "v1.0.0" - description: "Published Date - Oct 30, 2020" -paths: - /microservices/nlp/scanreceipt/v1/getresults: - post: - tags: - - v1.0.0 - responses: - '200': - description: success response - content: - application/json: - schema: - $ref: '#/components/schemas/success' - example: - message: Successfully Processed - results: - scanDocuments: - data: - AccountName: - UICategory: Payment Instructions - UIName: Account Name - UIType: Text - matches: - - keyword: - match: - matchmulti: - page: - value: - AccountNumber: - UICategory: Payment Instructions - UIName: Account Number - UIType: Text - matches: - - keyword: - match: - matchmulti: - page: - value: - BigBoxes: - - box: - - 106 - - 134 - - 385 - - 174 - - 245.5 - - 154 - - East Repair Inc. - - East Repair Inc. - page: 0 - - box: - - 1148 - - 129 - - 1308 - - 171 - - 1228 - - 150 - - RECEIPT - - RECEIPT - page: 0 - - box: - - 102 - - 208 - - 322 - - 273 - - 212 - - 240.5 - - |- - 1912 Harvest Lane - New York, NY 12210 - - |- - 1912 Harvest Lane - New York , NY 12210 - page: 0 - - box: - - 1232 - - 455 - - 1307 - - 479 - - 1269.5 - - 467 - - US-001 - - US-001 - page: 0 - - box: - - 102 - - 452 - - 322 - - 591 - - 212 - - 521.5 - - |- - Bill To - John Smith - 2 Court Square - New York, NY 12210 - - |- - Bill To - John Smith - 2 Court Square - New York , NY 12210 - page: 0 - - box: - - 529 - - 454 - - 766 - - 595 - - 647.5 - - 524.5 - - |- - Ship To - John Smith - 3787 Pineview Drive - Cambridge, MA 12210 - - |- - Ship To - John Smith - 3787 Pineview Drive - Cambridge , MA 12210 - page: 0 - - box: - - 972 - - 452 - - 1113 - - 531 - - 1042.5 - - 491.5 - - |- - Receipt # - Receipt Date - - |- - Receipt # - Receipt Date - page: 0 - - box: - - 1193 - - 500 - - 1309 - - 527 - - 1251 - - 513.5 - - 11/02/2019 - - 11/02/2019 - page: 0 - - box: - - 1055 - - 553 - - 1114 - - 575 - - 1084.5 - - 564 - - 'PO #' - - 'P.O. #' - page: 0 - - box: - - 1200 - - 553 - - 1310 - - 576 - - 1255 - - 564.5 - - 2312/2019 - - 2312/2019 - page: 0 - - box: - - 1012 - - 600 - - 1112 - - 622 - - 1062 - - 611 - - Due Date - - Due Date - page: 0 - - box: - - 1193 - - 600 - - 1310 - - 623 - - 1251.5 - - 611.5 - - 26/02/2019 - - 26/02/2019 - page: 0 - - box: - - 130 - - 732 - - 178 - - 751 - - 154 - - 741.5 - - QTY - - QTY - page: 0 - - box: - - 422 - - 731 - - 580 - - 752 - - 501 - - 741.5 - - DESCRIPTION - - DESCRIPTION - page: 0 - - box: - - 831 - - 722 - - 962 - - 759 - - 896.5 - - 740.5 - - UNIT PRICE - - UNIT PRICE - page: 0 - - box: - - 1102 - - 730 - - 1205 - - 752 - - 1153.5 - - 741 - - AMOUNT - - AMOUNT - page: 0 - - box: - - 149 - - 793 - - 155 - - 813 - - 152 - - 803 - - '1' - - '1' - page: 0 - - box: - - 229 - - 793 - - 518 - - 816 - - 373.5 - - 804.5 - - Front and rear brake cables - - Front and rear brake cables - page: 0 - - box: - - 911 - - 793 - - 981 - - 814 - - 946 - - 803.5 - - '100.00' - - '100.00' - page: 0 - - box: - - 1220 - - 793 - - 1289 - - 816 - - 1254.5 - - 804.5 - - '100.00' - - '100.00' - page: 0 - - box: - - 148 - - 857 - - 159 - - 876 - - 153.5 - - 866.5 - - '2' - - '2' - page: 0 - - box: - - 229 - - 852 - - 463 - - 884 - - 346 - - 868 - - New set of pedal arms - - New set of pedal arms - page: 0 - - box: - - 925 - - 857 - - 981 - - 879 - - 953 - - 868 - - '15.00' - - '15.00' - page: 0 - - box: - - 1231 - - 856 - - 1290 - - 879 - - 1260.5 - - 867.5 - - '30.00' - - '30.00' - page: 0 - - box: - - 149 - - 920 - - 160 - - 939 - - 154.5 - - 929.5 - - '3' - - '3' - page: 0 - - box: - - 229 - - 918 - - 340 - - 939 - - 284.5 - - 928.5 - - Labor 3hrs - - Labor 3hrs - page: 0 - - box: - - 936 - - 920 - - 980 - - 940 - - 958 - - 930 - - '5.00' - - '5.00' - page: 0 - - box: - - 1233 - - 920 - - 1289 - - 941 - - 1261 - - 930.5 - - '15.00' - - '15.00' - page: 0 - - box: - - 897 - - 981 - - 981 - - 1003 - - 939 - - 992 - - Subtotal - - Subtotal - page: 0 - - box: - - 1219 - - 980 - - 1288 - - 1002 - - 1253.5 - - 991 - - '145.00' - - '145.00' - page: 0 - - box: - - 803 - - 1042 - - 980 - - 1063 - - 891.5 - - 1052.5 - - Sales Tax 6.25% - - Sales Tax 6.25% - page: 0 - - box: - - 1244 - - 1042 - - 1289 - - 1065 - - 1266.5 - - 1053.5 - - '9.06' - - '9.06' - page: 0 - - box: - - 872 - - 1104 - - 981 - - 1137 - - 926.5 - - 1120.5 - - TOTAL - - TOTAL - page: 0 - - box: - - 1172 - - 1101 - - 1289 - - 1140 - - 1230.5 - - 1120.5 - - "$ 154.06" - - "$ 154.06" - page: 0 - - box: - - 102 - - 1728 - - 422 - - 1801 - - 262 - - 1764.5 - - |- - Terms & Conditions - Payment is due within 15 days - - |- - Terms & Conditions - Payment is due within 15 days - page: 0 - - box: - - 104 - - 1841 - - 616 - - 1871 - - 360 - - 1856 - - 'Please make checks payable to: East Repair Inc.' - - 'Please make checks payable to: East Repair Inc.' - page: 0 - BillingAddress: - UICategory: Vendor & Customer - UIName: Billing Address - UIType: Text - matches: - - keyword: - - 102 - - 452 - - 322 - - 591 - - 212 - - 521.5 - - |- - Bill To - John Smith - 2 Court Square - New York, NY 12210 - - |- - Bill To - John Smith - 2 Court Square - New York , NY 12210 - match: |- - John Smith - 2 Court Square - New York, NY 12210 - matchmulti: Bill To John Smith 2 Court Square New York , NY 12210 - page: 0 - value: - - 102 - - 452 - - 322 - - 591 - - 212 - - 521.5 - - |- - Bill To - John Smith - 2 Court Square - New York, NY 12210 - - |- - Bill To - John Smith - 2 Court Square - New York , NY 12210 - CompanyName: - UICategory: Vendor & Customer - UIName: Vendor Name - UIType: Text - matches: - - keyword: - - 106 - - 134 - - 385 - - 174 - - 245.5 - - 154 - - East Repair Inc. - - East Repair Inc. - match: East Repair Inc. - matchmulti: East Repair Inc. - page: 0 - value: - - 106 - - 134 - - 385 - - 174 - - 245.5 - - 154 - - East Repair Inc. - - East Repair Inc. - Currency: - UICategory: VAT & Amounts - UIName: Currency - UIType: Text - matches: - - keyword: - - 872 - - 1104 - - 981 - - 1137 - - 926.5 - - 1120.5 - - TOTAL - - TOTAL - match: "$" - matchmulti: "$ 154.06" - page: 0 - value: - - 1172 - - 1101 - - 1289 - - 1140 - - 1230.5 - - 1120.5 - - "$ 154.06" - - "$ 154.06" - Customer: - DetectedText: 'East Repair Inc. RECEIPT 1912 Harvest Lane New York, NY 12210 - US-001 Bill To John Smith 2 Court Square New York, NY 12210 Ship To John Smith - 3787 Pineview Drive Cambridge, MA 12210 Receipt # Receipt Date 11/02/2019 - PO # 2312/2019 Due Date 26/02/2019 QTY DESCRIPTION UNIT PRICE AMOUNT 1 Front - and rear brake cables 100.00 100.00 2 New set of pedal arms 15.00 30.00 3 - Labor 3hrs 5.00 15.00 Subtotal 145.00 Sales Tax 6.25% 9.06 TOTAL $ 154.06 - Terms & Conditions Payment is due within 15 days Please make checks payable - to: East Repair Inc. ' - DocSize: - - - 2000 - - 1413 - Email: - UICategory: Vendor & Customer - UIName: Email - UIType: Text - matches: - - keyword: - match: - matchmulti: - page: - value: - Freight: - UICategory: VAT & Amounts - UIName: Freight - UIType: Amount - matches: - - keyword: - match: - matchmulti: - page: - value: - IBAN: - UICategory: Payment Instructions - UIName: IBAN - UIType: Text - matches: - - keyword: - match: - matchmulti: - page: - value: - InvoiceDate: - UICategory: Basic Information - UIName: Invoice Date - UIType: Date - matches: - - keyword: - - 972 - - 499 - - 1113 - - 531 - - 1042.5 - - 515 - - Receipt Date - - Receipt Date - match: '2019-11-02' - matchmulti: 11/02/2019 - page: 0 - value: - - 1193 - - 500 - - 1309 - - 527 - - 1251 - - 513.5 - - 11/02/2019 - - 11/02/2019 - InvoiceNumber: - UICategory: Basic Information - UIName: Invoice Number - UIType: Text - matches: - - keyword: - match: - matchmulti: - page: - value: - LineItems: - - - 'AMOUNT ': - - '100.00' - 'DESCRIPTION ': - - Front and rear brake cables - 'QTY ': - - '1' - 'UNIT PRICE ': - - '100.00' - - 'AMOUNT ': - - '30.00' - 'DESCRIPTION ': - - New set of pedal arms - 'QTY ': - - '2' - 'UNIT PRICE ': - - '15.00' - - 'AMOUNT ': - - '15.00' - 'DESCRIPTION ': - - Labor 3hrs - 'QTY ': - - '3' - 'UNIT PRICE ': - - '5.00' - LineItems_standardHeader: - - - Description: Front and rear brake cables - LineAmount: 100 - Quantity: 1 - UnitAmount: 100 - - Description: New set of pedal arms - LineAmount: 30 - Quantity: 2 - UnitAmount: 15 - - Description: Labor 3hrs - LineAmount: 15 - Quantity: 3 - UnitAmount: 5 - OtherAddress: - UICategory: Vendor & Customer - UIName: Other Address - UIType: Text - matches: - - keyword: - match: - matchmulti: - page: - value: - OtherDate: - UICategory: Basic Information - UIName: Other Date - UIType: Date - matches: - - keyword: - match: - matchmulti: - page: - value: - PONumber: - UICategory: Vendor & Customer - UIName: PO Number - UIType: Text - matches: - - keyword: - - 1055 - - 553 - - 1114 - - 575 - - 1084.5 - - 564 - - 'PO #' - - 'P.O. #' - match: 2312/2019 - matchmulti: 2312/2019 - page: 0 - value: - - 1200 - - 553 - - 1310 - - 576 - - 1255 - - 564.5 - - 2312/2019 - - 2312/2019 - PaymentDate: - UICategory: Basic Information - UIName: Payment Date - UIType: Date - matches: - - keyword: - - 1012 - - 600 - - 1112 - - 622 - - 1062 - - 611 - - Due Date - - Due Date - match: '2019-02-26' - matchmulti: 26/02/2019 - page: 0 - value: - - 1193 - - 600 - - 1310 - - 623 - - 1251.5 - - 611.5 - - 26/02/2019 - - 26/02/2019 - SenderAddress: - UICategory: Vendor & Customer - UIName: Vendor Address - UIType: Text - matches: - - keyword: - - 106 - - 134 - - 385 - - 174 - - 245.5 - - 154 - - East Repair Inc. - - East Repair Inc. - match: East Repair Inc. - matchmulti: East Repair Inc. - page: 0 - value: - - 106 - - 134 - - 385 - - 174 - - 245.5 - - 154 - - East Repair Inc. - - East Repair Inc. - ShippingAddress: - UICategory: Vendor & Customer - UIName: Shipping Address - UIType: Text - matches: - - keyword: - - 529 - - 454 - - 766 - - 595 - - 647.5 - - 524.5 - - |- - Ship To - John Smith - 3787 Pineview Drive - Cambridge, MA 12210 - - |- - Ship To - John Smith - 3787 Pineview Drive - Cambridge , MA 12210 - match: |- - John Smith - 3787 Pineview Drive - Cambridge, MA 12210 - matchmulti: Ship To John Smith 3787 Pineview Drive Cambridge , MA 12210 - page: 0 - value: - - 529 - - 454 - - 766 - - 595 - - 647.5 - - 524.5 - - |- - Ship To - John Smith - 3787 Pineview Drive - Cambridge, MA 12210 - - |- - Ship To - John Smith - 3787 Pineview Drive - Cambridge , MA 12210 - SmallBoxes: - - box: - - 106 - - 134 - - 385 - - 174 - - 245.5 - - 154 - - East Repair Inc. - - East Repair Inc. - page: 0 - - box: - - 1148 - - 129 - - 1308 - - 171 - - 1228 - - 150 - - RECEIPT - - RECEIPT - page: 0 - - box: - - 105 - - 208 - - 302 - - 241 - - 203.5 - - 224.5 - - 1912 Harvest Lane - - 1912 Harvest Lane - page: 0 - - box: - - 102 - - 242 - - 322 - - 273 - - 212 - - 257.5 - - New York, NY 12210 - - New York , NY 12210 - page: 0 - - box: - - 1232 - - 455 - - 1307 - - 479 - - 1269.5 - - 467 - - US-001 - - US-001 - page: 0 - - box: - - 104 - - 452 - - 174 - - 481 - - 139 - - 466.5 - - Bill To - - Bill To - page: 0 - - box: - - 103 - - 492 - - 220 - - 524 - - 161.5 - - 508 - - John Smith - - John Smith - page: 0 - - box: - - 103 - - 527 - - 262 - - 559 - - 182.5 - - 543 - - 2 Court Square - - 2 Court Square - page: 0 - - box: - - 102 - - 560 - - 322 - - 591 - - 212 - - 575.5 - - New York, NY 12210 - - New York , NY 12210 - page: 0 - - box: - - 529 - - 454 - - 616 - - 482 - - 572.5 - - 468 - - Ship To - - Ship To - page: 0 - - box: - - 530 - - 494 - - 647 - - 523 - - 588.5 - - 508.5 - - John Smith - - John Smith - page: 0 - - box: - - 530 - - 527 - - 744 - - 555 - - 637 - - 541 - - 3787 Pineview Drive - - 3787 Pineview Drive - page: 0 - - box: - - 529 - - 559 - - 766 - - 595 - - 647.5 - - 577 - - Cambridge, MA 12210 - - Cambridge , MA 12210 - page: 0 - - box: - - 1009 - - 452 - - 1113 - - 483 - - 1061 - - 467.5 - - 'Receipt #' - - 'Receipt #' - page: 0 - - box: - - 972 - - 499 - - 1113 - - 531 - - 1042.5 - - 515 - - Receipt Date - - Receipt Date - page: 0 - - box: - - 1193 - - 500 - - 1309 - - 527 - - 1251 - - 513.5 - - 11/02/2019 - - 11/02/2019 - page: 0 - - box: - - 1055 - - 553 - - 1114 - - 575 - - 1084.5 - - 564 - - 'PO #' - - 'P.O. #' - page: 0 - - box: - - 1200 - - 553 - - 1310 - - 576 - - 1255 - - 564.5 - - 2312/2019 - - 2312/2019 - page: 0 - - box: - - 1012 - - 600 - - 1112 - - 622 - - 1062 - - 611 - - Due Date - - Due Date - page: 0 - - box: - - 1193 - - 600 - - 1310 - - 623 - - 1251.5 - - 611.5 - - 26/02/2019 - - 26/02/2019 - page: 0 - - box: - - 130 - - 732 - - 178 - - 751 - - 154 - - 741.5 - - QTY - - QTY - page: 0 - - box: - - 422 - - 731 - - 580 - - 752 - - 501 - - 741.5 - - DESCRIPTION - - DESCRIPTION - page: 0 - - box: - - 831 - - 722 - - 962 - - 759 - - 896.5 - - 740.5 - - UNIT PRICE - - UNIT PRICE - page: 0 - - box: - - 1102 - - 730 - - 1205 - - 752 - - 1153.5 - - 741 - - AMOUNT - - AMOUNT - page: 0 - - box: - - 149 - - 793 - - 155 - - 813 - - 152 - - 803 - - '1' - - '1' - page: 0 - - box: - - 229 - - 793 - - 518 - - 816 - - 373.5 - - 804.5 - - Front and rear brake cables - - Front and rear brake cables - page: 0 - - box: - - 911 - - 793 - - 981 - - 814 - - 946 - - 803.5 - - '100.00' - - '100.00' - page: 0 - - box: - - 1220 - - 793 - - 1289 - - 816 - - 1254.5 - - 804.5 - - '100.00' - - '100.00' - page: 0 - - box: - - 148 - - 857 - - 159 - - 876 - - 153.5 - - 866.5 - - '2' - - '2' - page: 0 - - box: - - 229 - - 852 - - 463 - - 884 - - 346 - - 868 - - New set of pedal arms - - New set of pedal arms - page: 0 - - box: - - 925 - - 857 - - 981 - - 879 - - 953 - - 868 - - '15.00' - - '15.00' - page: 0 - - box: - - 1231 - - 856 - - 1290 - - 879 - - 1260.5 - - 867.5 - - '30.00' - - '30.00' - page: 0 - - box: - - 149 - - 920 - - 160 - - 939 - - 154.5 - - 929.5 - - '3' - - '3' - page: 0 - - box: - - 229 - - 918 - - 340 - - 939 - - 284.5 - - 928.5 - - Labor 3hrs - - Labor 3hrs - page: 0 - - box: - - 936 - - 920 - - 980 - - 940 - - 958 - - 930 - - '5.00' - - '5.00' - page: 0 - - box: - - 1233 - - 920 - - 1289 - - 941 - - 1261 - - 930.5 - - '15.00' - - '15.00' - page: 0 - - box: - - 897 - - 981 - - 981 - - 1003 - - 939 - - 992 - - Subtotal - - Subtotal - page: 0 - - box: - - 1219 - - 980 - - 1288 - - 1002 - - 1253.5 - - 991 - - '145.00' - - '145.00' - page: 0 - - box: - - 803 - - 1042 - - 980 - - 1063 - - 891.5 - - 1052.5 - - Sales Tax 6.25% - - Sales Tax 6.25% - page: 0 - - box: - - 1244 - - 1042 - - 1289 - - 1065 - - 1266.5 - - 1053.5 - - '9.06' - - '9.06' - page: 0 - - box: - - 872 - - 1104 - - 981 - - 1137 - - 926.5 - - 1120.5 - - TOTAL - - TOTAL - page: 0 - - box: - - 1172 - - 1101 - - 1289 - - 1140 - - 1230.5 - - 1120.5 - - "$ 154.06" - - "$ 154.06" - page: 0 - - box: - - 102 - - 1728 - - 327 - - 1760 - - 214.5 - - 1744 - - Terms & Conditions - - Terms & Conditions - page: 0 - - box: - - 104 - - 1767 - - 422 - - 1801 - - 263 - - 1784 - - Payment is due within 15 days - - Payment is due within 15 days - page: 0 - - box: - - 104 - - 1841 - - 616 - - 1871 - - 360 - - 1856 - - 'Please make checks payable to: East Repair Inc.' - - 'Please make checks payable to: East Repair Inc.' - page: 0 - Subtotal: - UICategory: VAT & Amounts - UIName: Subtotal - UIType: Amount - matches: - - keyword: - - 897 - - 775 - - 981 - - 797 - - 939 - - 992 - - Subtotal - - Subtotal - match: 145 - matchmulti: '145.00' - page: 0 - value: - - 1219 - - 980 - - 1288 - - 1002 - - 1253.5 - - 991 - - '145.00' - - '145.00' - Supplier: - SwiftCode: - UICategory: Payment Instructions - UIName: Swift Code - UIType: Text - matches: - - keyword: - match: - matchmulti: - page: - value: - TableDetected: true - Tables: - - GridX: - - 106 - - 212 - - 797 - - 1002 - - 1309 - GridY: - - 775 - - 833 - - 895 - - 958 - GridYPages: - - 0 - - 0 - - 0 - - 0 - HeaderPage: 0 - header: - - 120 - - 720 - - 1293 - - 761 - headernum: 4 - TaxTotal: - UICategory: VAT & Amounts - UIName: Tax Total - UIType: Amount - matches: - - keyword: - - 803 - - 836 - - 980 - - 857 - - 891.5 - - 1052.5 - - Sales Tax 6.25% - - Sales Tax 6.25% - match: 6.2 - matchmulti: Sales Tax 6.25% - page: 0 - value: - - 803 - - 1042 - - 980 - - 1063 - - 891.5 - - 1052.5 - - Sales Tax 6.25% - - Sales Tax 6.25% - Total: - UICategory: VAT & Amounts - UIName: Total - UIType: Amount - matches: - - keyword: - - 872 - - 898 - - 981 - - 931 - - 926.5 - - 1120.5 - - TOTAL - - TOTAL - match: 154.06 - matchmulti: "$ 154.06" - page: 0 - value: - - 1172 - - 1101 - - 1289 - - 1140 - - 1230.5 - - 1120.5 - - "$ 154.06" - - "$ 154.06" - Type: invoice_image - URL: - UICategory: Vendor & Customer - UIName: URL - UIType: Text - matches: - - keyword: - match: - matchmulti: - page: - value: - num_pages: 1 - docId: 7650 - status: COMPLETED - status: Success - - '401': - description: Unauthorized - content: - application/json: - schema: - $ref: '#/components/schemas/unauthorized' - '402': - description: Payment Required - content: - application/json: - schema: - $ref: '#/components/schemas/paymentrequired' - '403': - description: Forbidden - content: - application/json: - schema: - $ref: '#/components/schemas/forbidden' - '404': - description: Not Found - content: - application/json: - schema: - $ref: '#/components/schemas/notfound' - '419': - description: Input Field Missing - content: - application/json: - schema: - $ref: '#/components/schemas/inputfieldmissing' - '420': - description: Input Limit Exceeded - content: - application/json: - schema: - $ref: '#/components/schemas/inputlimitexceeded' - '422': - description: Invalid Input - content: - application/json: - schema: - $ref: '#/components/schemas/invalidinput' - '500': - description: Internal Server Error - content: - application/json: - schema: - $ref: '#/components/schemas/servererror' - '504': - description: Gateway Timeout - content: - application/json: - schema: - $ref: '#/components/schemas/gatewaytimeout' - security: - - APIAuthorizer: [] - requestBody: - content: - multipart/form-data: - schema: - $ref: '#/components/schemas/input' - required: true -components: - schemas: - success: - type: object - properties: - results: - type: object - example: { "" } - description: The result of the API call - properties: - scanDocuments: - type: object - example: { "" } - description: The details of documents - message: - type: string - example: Successfully Processed - description: Detail description on the API status - status: - type: string - example: Success - description: The status of the API call success/failure - unauthorized: - type: object - properties: - message: - type: string - example: Missing Authentication Token - status: - type: string - example: Failure - forbidden: - type: object - properties: - message: - type: string - example: Access Denied Unauthorized User - status: - type: string - example: Failure - paymentrequired: - type: object - properties: - message: - type: string - example: Insufficient Credits Kindly Top Up - status: - type: string - example: Failure - notfound: - type: object - properties: - message: - type: string - example: Invalid Request URL - status: - type: string - example: Failure - invalidinput: - type: object - properties: - message: - type: string - example: Invalid Input - status: - type: string - example: Failure - servererror: - type: object - properties: - message: - type: string - example: Internal Server Error - status: - type: string - example: Failure - gatewaytimeout: - type: object - properties: - message: - type: string - example: Request Timeout - status: - type: string - example: Failure - inputfieldmissing: - type: object - properties: - message: - type: string - example: Input Field Missing - status: - type: string - example: Failure - inputlimitexceeded: - type: object - properties: - message: - type: string - example: Input Limit Exceeded - status: - type: string - example: Failure - versions: - type: object - properties: - v1.0.0: - type: array - items: - oneOf: - - type: string - example: Published Date - Oct 30, 2020 - description: Initial version release - input: - type: object - required: - - file - - endpointUrl - properties: - file: - type: string - format: binary - default: true - example: upload file - description: The receipt document - handwritten: - type: string - description: Sholud be true of false. Default is false - securitySchemes: - APIAuthorizer: - type: apiKey - name: x-api-key - in: header - x-amazon-apigateway-authtype: custom - description: Authentication is done using the x-api-key in the request header From a59e6798831b957bb8bc14dbff18c4a86ef212e3 Mon Sep 17 00:00:00 2001 From: Priyadharshini Date: Thu, 11 Feb 2021 21:56:48 +0530 Subject: [PATCH 409/792] latest docs --- .../demographics_classification.yaml | 293 +++ .../face_recognition_politicians_sg.yaml | 271 +++ computer_vision/face_recognition_v1.0.yaml | 358 ++++ computer_vision/landmark_detection_jp.yaml | 237 +++ .../landmark_detection_jp_v1.0.yaml | 260 +++ computer_vision/landmark_detection_sg.yaml | 241 +++ .../landmark_detection_sg_v1.0.yaml | 264 +++ computer_vision/object_detection.yaml | 250 +++ computer_vision/object_detection_v1.0.yaml | 278 +++ computer_vision/people_counting.yaml | 247 +++ computer_vision/people_counting_v1.0.yaml | 259 +++ data/amenities_hardcourts_hdb_sg.yaml | 236 +++ data/amenities_lamp_posts_hdb_sg.yaml | 238 +++ data/amenities_shelters_hdb_sg.yaml | 241 +++ data/building_addresses_hdb_sg.yaml | 415 ++++ data/carpark_hdb_sg.yaml | 506 +++++ data/commercial_directories_hdb_sg.yaml | 520 +++++ data/d&b_basic_individual_search_sg.yaml | 1307 +++++++++++++ data/d&b_brief_financial_information_sg.yaml | 1404 ++++++++++++++ data/d&b_business_check_plus_sg.yaml | 1705 +++++++++++++++++ data/d&b_business_check_sg.yaml | 1149 +++++++++++ data/demographics_classification.yaml | 293 +++ data/demographics_hdb_sg.yaml | 448 +++++ data/directory_of_singapore_startups.yaml | 548 ++++++ ...tness_stations_and_playgrounds_hdb_sg.yaml | 237 +++ data/flat_ownership_hdb_sg.yaml | 449 +++++ data/page_profiler_eng.yaml | 255 +++ data/residential_sales_and_rental_hdb_sg.yaml | 496 +++++ data/season_parking_availability_hdb_sg.yaml | 440 +++++ data_alliance/download_dataset.yaml | 10 + index.yaml | 284 +++ nlp/inverse_text_normalisation_eng.yaml | 228 +++ nlp/inverse_text_normalisation_eng_v1.0.yaml | 248 +++ nlp/named-entity_recognition_eng.yaml | 264 +++ nlp/named-entity_recognition_eng_v1.0.yaml | 269 +++ nlp/named-entity_recognition_jp.yaml | 255 +++ nlp/named-entity_recognition_jp_v1.0.yaml | 329 ++++ nlp/named-entity_recognition_thai.yaml | 237 +++ nlp/named-entity_recognition_thai_v1.0.yaml | 331 ++++ nlp/page_profiler_eng.yaml | 255 +++ nlp/page_profiler_eng_v2.0.yaml | 228 +++ nlp/page_profiler_eng_v2.1.yaml | 269 +++ nlp/page_profiler_jp.yaml | 335 ++++ nlp/page_profiler_thai.yaml | 346 ++++ nlp/script_alignment.yaml | 277 +++ nlp/script_alignment_v1.0.yaml | 302 +++ nlp/spacy_named-entity_recognition_eng.yaml | 317 +++ nlp/taxonomy_matcher_eng.yaml | 235 +++ nlp/taxonomy_matcher_eng_v1.0.yaml | 257 +++ nlp/word_sense_disambiguation_eng.yaml | 304 +++ nlp/word_sense_disambiguation_eng_v1.0.yaml | 326 ++++ utility/audio_format_convertor.yaml | 253 +++ utility/base64-decoder.yaml | 220 +++ utility/base64-encoder.yaml | 237 +++ utility/base64-file-decode.yaml | 220 +++ utility/base64-file-encode.yaml | 237 +++ utility/csv-json_convertor.yaml | 232 +++ utility/decryption_using_pki_key.yaml | 225 +++ utility/document_convertor_eng.yaml | 235 +++ utility/download_dataset.yaml | 10 + utility/encryption_using_pki_key.yaml | 225 +++ utility/inverse_text_normalisation_eng.yaml | 228 +++ .../inverse_text_normalisation_eng_v1.0.yaml | 248 +++ utility/json-csv_convertor.yaml | 233 +++ utility/newspaper_article_scraper.yaml | 325 ++++ utility/pdf_extractor.yaml | 267 +++ utility/pki_key_generator.yaml | 216 +++ utility/urls_retrieval.yaml | 271 +++ utility/video-to-audio_convertor.yaml | 239 +++ utility/video-to-image_convertor.yaml | 240 +++ utility/web_scraper.yaml | 393 ++++ utility/wikipedia_retrieval.yaml | 314 +++ utility/wikipedia_retrieval_v1.0.yaml | 342 ++++ utility/youtube_video_downloader.yaml | 223 +++ ..._with_voice_activity_detection_eng_sg.yaml | 261 +++ ..._voice_activity_detection_eng_sg_v1.0.yaml | 299 +++ .../automatic_speech_recognition_chi_sg.yaml | 244 +++ voice/automatic_speech_recognition_eng.yaml | 203 ++ .../automatic_speech_recognition_eng_sg.yaml | 287 +++ ...omatic_speech_recognition_eng_sg_v1.0.yaml | 317 +++ voice/automatic_voice_recognition_eng.yaml | 219 +++ ...e_automatic_speech_recognition_eng_sg.yaml | 17 + ...d_automatic_speech_recognition_eng_sg.yaml | 10 + voice/text-to-speech_chi.yaml | 228 +++ voice/text-to-speech_eng.yaml | 347 ++++ voice/voice_activity_detection_eng.yaml | 245 +++ voice/voice_activity_detection_eng_v1.0.yaml | 265 +++ 87 files changed, 28326 insertions(+) create mode 100644 computer_vision/demographics_classification.yaml create mode 100644 computer_vision/face_recognition_politicians_sg.yaml create mode 100644 computer_vision/face_recognition_v1.0.yaml create mode 100644 computer_vision/landmark_detection_jp.yaml create mode 100644 computer_vision/landmark_detection_jp_v1.0.yaml create mode 100644 computer_vision/landmark_detection_sg.yaml create mode 100644 computer_vision/landmark_detection_sg_v1.0.yaml create mode 100644 computer_vision/object_detection.yaml create mode 100644 computer_vision/object_detection_v1.0.yaml create mode 100644 computer_vision/people_counting.yaml create mode 100644 computer_vision/people_counting_v1.0.yaml create mode 100644 data/amenities_hardcourts_hdb_sg.yaml create mode 100644 data/amenities_lamp_posts_hdb_sg.yaml create mode 100644 data/amenities_shelters_hdb_sg.yaml create mode 100644 data/building_addresses_hdb_sg.yaml create mode 100644 data/carpark_hdb_sg.yaml create mode 100644 data/commercial_directories_hdb_sg.yaml create mode 100644 data/d&b_basic_individual_search_sg.yaml create mode 100644 data/d&b_brief_financial_information_sg.yaml create mode 100644 data/d&b_business_check_plus_sg.yaml create mode 100644 data/d&b_business_check_sg.yaml create mode 100644 data/demographics_classification.yaml create mode 100644 data/demographics_hdb_sg.yaml create mode 100644 data/directory_of_singapore_startups.yaml create mode 100644 data/fitness_stations_and_playgrounds_hdb_sg.yaml create mode 100644 data/flat_ownership_hdb_sg.yaml create mode 100644 data/page_profiler_eng.yaml create mode 100644 data/residential_sales_and_rental_hdb_sg.yaml create mode 100644 data/season_parking_availability_hdb_sg.yaml create mode 100644 data_alliance/download_dataset.yaml create mode 100644 index.yaml create mode 100644 nlp/inverse_text_normalisation_eng.yaml create mode 100644 nlp/inverse_text_normalisation_eng_v1.0.yaml create mode 100644 nlp/named-entity_recognition_eng.yaml create mode 100644 nlp/named-entity_recognition_eng_v1.0.yaml create mode 100644 nlp/named-entity_recognition_jp.yaml create mode 100644 nlp/named-entity_recognition_jp_v1.0.yaml create mode 100644 nlp/named-entity_recognition_thai.yaml create mode 100644 nlp/named-entity_recognition_thai_v1.0.yaml create mode 100644 nlp/page_profiler_eng.yaml create mode 100644 nlp/page_profiler_eng_v2.0.yaml create mode 100644 nlp/page_profiler_eng_v2.1.yaml create mode 100644 nlp/page_profiler_jp.yaml create mode 100644 nlp/page_profiler_thai.yaml create mode 100644 nlp/script_alignment.yaml create mode 100644 nlp/script_alignment_v1.0.yaml create mode 100644 nlp/spacy_named-entity_recognition_eng.yaml create mode 100644 nlp/taxonomy_matcher_eng.yaml create mode 100644 nlp/taxonomy_matcher_eng_v1.0.yaml create mode 100644 nlp/word_sense_disambiguation_eng.yaml create mode 100644 nlp/word_sense_disambiguation_eng_v1.0.yaml create mode 100644 utility/audio_format_convertor.yaml create mode 100644 utility/base64-decoder.yaml create mode 100644 utility/base64-encoder.yaml create mode 100644 utility/base64-file-decode.yaml create mode 100644 utility/base64-file-encode.yaml create mode 100644 utility/csv-json_convertor.yaml create mode 100644 utility/decryption_using_pki_key.yaml create mode 100644 utility/document_convertor_eng.yaml create mode 100644 utility/download_dataset.yaml create mode 100644 utility/encryption_using_pki_key.yaml create mode 100644 utility/inverse_text_normalisation_eng.yaml create mode 100644 utility/inverse_text_normalisation_eng_v1.0.yaml create mode 100644 utility/json-csv_convertor.yaml create mode 100644 utility/newspaper_article_scraper.yaml create mode 100644 utility/pdf_extractor.yaml create mode 100644 utility/pki_key_generator.yaml create mode 100644 utility/urls_retrieval.yaml create mode 100644 utility/video-to-audio_convertor.yaml create mode 100644 utility/video-to-image_convertor.yaml create mode 100644 utility/web_scraper.yaml create mode 100644 utility/wikipedia_retrieval.yaml create mode 100644 utility/wikipedia_retrieval_v1.0.yaml create mode 100644 utility/youtube_video_downloader.yaml create mode 100644 voice/asr_with_voice_activity_detection_eng_sg.yaml create mode 100644 voice/asr_with_voice_activity_detection_eng_sg_v1.0.yaml create mode 100644 voice/automatic_speech_recognition_chi_sg.yaml create mode 100644 voice/automatic_speech_recognition_eng.yaml create mode 100644 voice/automatic_speech_recognition_eng_sg.yaml create mode 100644 voice/automatic_speech_recognition_eng_sg_v1.0.yaml create mode 100644 voice/automatic_voice_recognition_eng.yaml create mode 100644 voice/online_automatic_speech_recognition_eng_sg.yaml create mode 100644 voice/online_command_automatic_speech_recognition_eng_sg.yaml create mode 100644 voice/text-to-speech_chi.yaml create mode 100644 voice/text-to-speech_eng.yaml create mode 100644 voice/voice_activity_detection_eng.yaml create mode 100644 voice/voice_activity_detection_eng_v1.0.yaml diff --git a/computer_vision/demographics_classification.yaml b/computer_vision/demographics_classification.yaml new file mode 100644 index 000000000..6fa1083f6 --- /dev/null +++ b/computer_vision/demographics_classification.yaml @@ -0,0 +1,293 @@ +openapi: 3.0.1 +info: + title: Demographics Classification + description: |+ + This Computer Vision microservice detects for faces from an input image and predicts the demographics of each face (age, gender and race). The image is given as an input encoded using base64. The microservice will a face detector and subsequently models to predict age, gender and race. The results will then be returned back to the user as a JSON output together with bounding box coordinates for each face.Races include: Asian, Indian, White, Black, Middle Eastern and Latino Hispanic + The size of your image file should **not exceed 5 MB**, and the image dimension should be **at least 416x416 pixels**. + x-additionalinfo: |+ + Suggested Use Cases: + - This microservice can be used as a solution to help businesses better understand and connect with their customers, engage new prospects and increase revenue. For example, it can be used to improve visitor experience and optimize operations in retail, leisure, and other sectors by identifying the type of demogrpahic that frequents a certain place the most. It can also be used to create intelligent prospect lists that ensure one is always maximizing their marketing investment. + version: v0.1.0 + x-subscribelink: demographics_classification +servers: + - url: 'https://apis.sentient.io' +tags: +- name: "v0.1.0" + description: "Published Date - Dec 09, 2020" +paths: + /microservices/cv/democlass/v0/getpredictions: + post: + tags: + - v0.1.0 + responses: + '200': + description: success response + content: + application/json: + schema: + $ref: '#/components/schemas/success' + example: + results: + persons: + - age: 33.21062944528088 + bbox: + bottom: 459 + left: 82 + right: 393 + top: 0 + gender: Man + race: white + + message: Successfully Processed + status: Success + '401': + description: Unauthorized + content: + application/json: + schema: + $ref: '#/components/schemas/unauthorized' + '402': + description: Payment Required + content: + application/json: + schema: + $ref: '#/components/schemas/paymentrequired' + '403': + description: Forbidden + content: + application/json: + schema: + $ref: '#/components/schemas/forbidden' + '404': + description: Not Found + content: + application/json: + schema: + $ref: '#/components/schemas/notfound' + '419': + description: Input Field Missing + content: + application/json: + schema: + $ref: '#/components/schemas/inputfieldmissing' + '413': + description: Input Limit Exceeded + content: + application/json: + schema: + $ref: '#/components/schemas/inputlimitexceeded' + '415': + description: Invalid Input + content: + application/json: + schema: + $ref: '#/components/schemas/invalidinput' + '500': + description: Internal Server error + content: + application/json: + schema: + $ref: '#/components/schemas/servererror' + '504': + description: Gateway Timeout + content: + application/json: + schema: + $ref: '#/components/schemas/gatewaytimeout' + security: + - APIAuthorizer: [] + + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/input' + required: true + + +components: + schemas: + success: + type: object + properties: + results: + type: object + description: The result of the API call. + example: { "" } + properties: + persons: + description: Demographic details of the detected person + example: + age: 33.21062944528088 + bbox: + bottom: 459 + left: 82 + right: 393 + top: 0 + gender: Man + race: white + items: + properties: + description: Demographic details of the detected person + example: ' ' + properties: + age: + description: Age of the detected person in the input image + example: 33.21062944528088 + type: float + bbox: + description: Bounding box of the detected person in the input image + example: ' ' + properties: + bottom: + description: Bottom coordinate of the box + example: 459 + type: integer + left: + description: Left coordinate of the box + example: 82 + type: integer + right: + description: Right coordinate of the box + example: 393 + type: integer + top: + description: Top coordinate of the box + example: 0 + type: integer + type: object + gender: + description: Gender of the detected person in the input image + example: Man + type: string + race: + description: Race of the detected person in the input image + example: white + type: string + type: object + type: object + type: array + + message: + type: string + example: Successfully Processed + description: Detail description on the API status + status: + type: string + example: Success + description: The status of the API call success/failure + + unauthorized: + type: object + properties: + message: + type: string + example: Missing Authentication Token + status: + type: string + example: Failure + forbidden: + type: object + properties: + message: + type: string + example: Access Denied Unauthorized User + status: + type: string + example: Failure + paymentrequired: + type: object + properties: + message: + type: string + example: Insufficient Credits Kindly Top Up + status: + type: string + example: Failure + notfound: + type: object + properties: + message: + type: string + example: Invalid Request + status: + type: string + example: Failure + servererror: + type: object + properties: + message: + type: string + example: Internal Server error + status: + type: string + example: Failure + gatewaytimeout: + type: object + properties: + message: + type: string + example: Request Timeout + status: + type: string + example: Failure + inputfieldmissing: + type: object + properties: + message: + type: string + example: Input Field Missing + status: + type: string + example: Failure + inputlimitexceeded: + type: object + properties: + message: + type: string + example: Input Limit Exceeded + status: + type: string + example: Failure + invalidinput: + type: object + properties: + message: + type: string + example: Invalid Input + status: + type: string + example: Failure + versions: + type: object + properties: + v0.1.0: + type: array + items: + oneOf: + - type: string + example: Published Date - Dec 09, 2020 + description: Initial version release + input: + type: object + required: + + - image_base64 + + properties: + image_base64: + x-name: image_base64 + type: string + default: True + example: /9j/4AAQSkZJRgABAQEASABIAAD/2wBDAAMCAgMCAgMDAwMEAwMEBQgFBQQEBQoHBwYIDAoMDAsKCwsNDhIQDQ4RDgsLEBYQERMUFRUVDA8XGBYUG... + description: |+ + Input image file in base64 format. + + + securitySchemes: + APIAuthorizer: + type: apiKey + name: x-api-key + in: header + x-amazon-apigateway-authtype: custom + description: Authentication is done using the x-api-key in the request header diff --git a/computer_vision/face_recognition_politicians_sg.yaml b/computer_vision/face_recognition_politicians_sg.yaml new file mode 100644 index 000000000..926daba86 --- /dev/null +++ b/computer_vision/face_recognition_politicians_sg.yaml @@ -0,0 +1,271 @@ +openapi: 3.0.1 +info: + title: Face Recognition + description: |+ + This Computer Vision microservice recognises faces of Singaporean and Japanese public figures (e.g. athletes, business leaders, celebrities, politicians, TV personalities, etc). + + This microservice returns the identity of the person, the bounding box in image coordinates, and the confidence of the prediction. Users can further filter + + Help us grow this microservice! [Let us know](https://www.sentient.io/contact) which other public figures you would like us this microservice to also recognise (e.g. a new country or a new category). We will expand the capability of this microservices based on user feedback and demand. + x-additionalinfo: |+ + Suggested Use Cases: + - For solutions related to identifying the speaker for auto-tagging, or matching the transcription to a person that is a Singaporean politician, or a Singaporean/Japanese public figure. + version: '0.1.0' + x-subscribelink: face_recognition +servers: + - url: 'https://apis.sentient.io' +tags: +- name: "v0.1.0" + description: "Published Date - Jul 03, 2020" +paths: + /microservices/cv/facerecognition/v0.1/getpredictions: + post: + tags: + - v0.1.0 + responses: + '200': + description: success response + content: + application/json: + schema: + $ref: '#/components/schemas/success' + example: + results: {conf: 0.6588699206768599,identity: "Lee Hsien Loong",location: [67,339,196,210]} + '401': + description: Unauthorized + content: + application/json: + schema: + $ref: '#/components/schemas/unauthorized' + '402': + description: Payment Required + content: + application/json: + schema: + $ref: '#/components/schemas/paymentrequired' + '403': + description: Forbidden + content: + application/json: + schema: + $ref: '#/components/schemas/forbidden' + '404': + description: Not Found + content: + application/json: + schema: + $ref: '#/components/schemas/notfound' + '419': + description: Input Field Missing + content: + application/json: + schema: + $ref: '#/components/schemas/inputfieldmissing' + '413': + description: Input Limit Exceeded + content: + application/json: + schema: + $ref: '#/components/schemas/inputlimitexceeded' + '415': + description: Invalid Input + content: + application/json: + schema: + $ref: '#/components/schemas/invalidinput' + '500': + description: Internal Server Error + content: + application/json: + schema: + $ref: '#/components/schemas/servererror' + '504': + description: Gateway Timeout + content: + application/json: + schema: + $ref: '#/components/schemas/gatewaytimeout' + security: + - APIAuthorizer: [] + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/input' + required: true +components: + schemas: + success: + type: object + properties: + results: + type: array + example: {conf: 0.6588699206768599,identity: "Lee Hsien Loong",location: [67,339,196,210]} + description: Details of the face recognised from the image + items: + oneOf: + - type: object + properties: + conf: + type: number + format: float + example: 0.6588699206768599 + description: 0.0 to 1.0. Confidence score of identification. Higher is more confidence. + identity: + type: string + example: Lee Hsien Loong + description: Person's formal name. If identity is not known, "UNKNOWN" is returned + location: + type: array + example: [67,339,196,210] + description: bounding box of the face in pixel coordinates of top, right, bottom, left. + items: + oneOf: + - type: number + example: 67 + + unauthorized: + type: object + properties: + message: + type: string + example: Missing Authentication Token + status: + type: string + example: Failure + restricted: + type: object + properties: + message: + type: string + example: The content is restricted + status: + type: string + example: Failure + forbidden: + type: object + properties: + message: + type: string + example: Access Denied Unauthorized User + status: + type: string + example: Failure + paymentrequired: + type: object + properties: + message: + type: string + example: Insufficient Credits Kindly Top Up + status: + type: string + example: Failure + notfound: + type: object + properties: + message: + type: string + example: Invalid Request + status: + type: string + example: Failure + servererror: + type: object + properties: + message: + type: string + example: Internal Server Error + status: + type: string + example: Failure + gatewaytimeout: + type: object + properties: + message: + type: string + example: Request Timeout + status: + type: string + example: Failure + inputfieldmissing: + type: object + properties: + message: + type: string + example: Input Field Missing + status: + type: string + example: Failure + inputlimitexceeded: + type: object + properties: + message: + type: string + example: Input Limit Exceeded + status: + type: string + example: Failure + versions: + type: object + properties: + v0.1.0: + type: array + items: + oneOf: + - type: string + example: Published Date - Jul 03,2020 + description: Initial version release + invalidinput: + type: object + properties: + message: + type: string + example: Invalid Input + status: + type: string + example: Failure + input: + type: object + required: + - model + - img_base64 + properties: + model: + x-name: model + type: string + default: true + example: sg-parliament-2019 + description: |+ + Model name. “sg-parliament-2019” is trained on Singapore Members of Parliament - 2019. + img_base64: + x-name: img_base64 + type: string + default: true + example: UklGRkbiBABXQVZFZm10IBAAAAABA... + description: |+ + Input image file in base64 format + file_type: + x-name: file_type + type: string + default: false + example: jpg + description: |+ + Type of image file. If not specified, the type of file is detected and processed. + + Refer to Python Imaging Library (PIL) for supported formats: bmp, gif, jpg/jpeg, png. + threshold: + x-name: threshold + type: float + format: float + default: false + example: 0.5 + description: |+ + 0.0 to 1.0. Default is 0.4. Higher threshold will return results with higher confidence. + + securitySchemes: + APIAuthorizer: + type: apiKey + name: x-api-key + in: header + x-amazon-apigateway-authtype: custom + description: Authentication is done using the x-api-key in the request header diff --git a/computer_vision/face_recognition_v1.0.yaml b/computer_vision/face_recognition_v1.0.yaml new file mode 100644 index 000000000..f26455b36 --- /dev/null +++ b/computer_vision/face_recognition_v1.0.yaml @@ -0,0 +1,358 @@ +openapi: 3.0.1 +info: + title: Face Recognition + description: |+ + This Computer Vision microservice recognises faces of Singaporean and Japanese public figures (e.g. athletes, business leaders, celebrities, politicians, TV personalities, etc). + + This microservice returns the identity of the person, the bounding box in image coordinates, and the confidence of the prediction. Users can further filter the results by countries, profession or even down to the individual names. + + Help us grow this microservice! [Let us know](https://www.sentient.io/contact) which other public figures you would like us this microservice to also recognise (e.g. a new country or a new category). We will expand the capability of this microservices based on user feedback and demand. + version: '1.0.1' + x-additionalinfo: |+ + **Full List of Filters** + Users may choose to filter the output using any of these filters below. + + 1. Countries: + - Japan + - Singapore + + 2. Categories: + - Olympic_medalist + - Paralympic_competitors + - Paralympic_medalist + - athletes + - bloggers + - broadcast_news_analysts + - business_executives + - business_leaders + - celebrities + - chairmen_of_corporations + - chief_executives + - columnists + - female_pop_singers + - female_singers + - film_actors + - film_actresses + - film_directors + - film_people + - film_producers + - journalists + - male_pop_singers + - male_singers + - participants_in_reality_television_series + - people_of_interest + - photojournalists + - politicians + - pop_singers + - radio_people + - screenwriters + - singer-songwriters + - social_media_personalities + - sportsman + - television_actors + - television_actresses + - television_personalities + - television_presenters + + 3. Individual Names + If you happen to know the individual names of the faces you hope to recognise, you may also put in the individual names as a filter. + + **Suggested Use Cases** + - For solutions related to identifying the speaker for auto-tagging, or matching the transcription to a person that is a Singaporean politician, or a Singaporean/Japanese public figure. + + + x-subscribelink: face_recognition +servers: + - url: 'https://apis.sentient.io' +tags: +- name: "v1.0.1" + description: "Published Date - Jan 11, 2021" +paths: + /microservices/cv/facerecognition/v1/getpredictions: + post: + tags: + - v1.0.1 + responses: + '200': + description: success response + content: + application/json: + schema: + $ref: '#/components/schemas/success' + example: + results: + output: {conf: 0.6588699206768599,identity: "Lee Hsien Loong",location: [67,339,196,210]} + message: Successfully Processed + status: Success + '401': + description: Unauthorized + content: + application/json: + schema: + $ref: '#/components/schemas/unauthorized' + '402': + description: Payment Required + content: + application/json: + schema: + $ref: '#/components/schemas/paymentrequired' + '403': + description: Forbidden + content: + application/json: + schema: + $ref: '#/components/schemas/forbidden' + '404': + description: Not Found + content: + application/json: + schema: + $ref: '#/components/schemas/notfound' + '419': + description: Input Field Missing + content: + application/json: + schema: + $ref: '#/components/schemas/inputfieldmissing' + '413': + description: Input Limit Exceeded + content: + application/json: + schema: + $ref: '#/components/schemas/inputlimitexceeded' + '415': + description: Invalid Input + content: + application/json: + schema: + $ref: '#/components/schemas/invalidinput' + '500': + description: Internal Server Error + content: + application/json: + schema: + $ref: '#/components/schemas/servererror' + '504': + description: Gateway Timeout + content: + application/json: + schema: + $ref: '#/components/schemas/gatewaytimeout' + security: + - APIAuthorizer: [] + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/input' + required: true +components: + schemas: + success: + type: object + properties: + results: + type: object + description: The result of the API call. + example: { "" } + properties: + output: + type: array + example: {conf: 0.6588699206768599,identity: "Lee Hsien Loong",location: [67,339,196,210]} + description: Details of the face recognised from the image + items: + oneOf: + - type: object + properties: + conf: + type: number + format: float + example: 0.6588699206768599 + description: 0.0 to 1.0. Confidence score of identification. Higher is more confidence. + identity: + type: string + example: Lee Hsien Loong + description: Person's formal name. If identity is not known, "UNKNOWN" is returned + location: + type: array + example: [67,339,196,210] + description: bounding box of the face in pixel coordinates of top, right, bottom, left. + items: + oneOf: + - type: number + example: 67 + message: + type: string + example: Successfully Processed + description: Detail description on the API status + status: + type: string + example: Success + description: The status of the API call success/failure + + unauthorized: + type: object + properties: + message: + type: string + example: Missing Authentication Token + status: + type: string + example: Failure + restricted: + type: object + properties: + message: + type: string + example: The content is restricted + status: + type: string + example: Failure + forbidden: + type: object + properties: + message: + type: string + example: Access Denied Unauthorized User + status: + type: string + example: Failure + paymentrequired: + type: object + properties: + message: + type: string + example: Insufficient Credits Kindly Top Up + status: + type: string + example: Failure + notfound: + type: object + properties: + message: + type: string + example: Invalid Request + status: + type: string + example: Failure + servererror: + type: object + properties: + message: + type: string + example: Internal Server Error + status: + type: string + example: Failure + gatewaytimeout: + type: object + properties: + message: + type: string + example: Request Timeout + status: + type: string + example: Failure + inputfieldmissing: + type: object + properties: + message: + type: string + example: Input Field Missing + status: + type: string + example: Failure + inputlimitexceeded: + type: object + properties: + message: + type: string + example: Input Limit Exceeded + status: + type: string + example: Failure + invalidinput: + type: object + properties: + message: + type: string + example: Invalid Input + status: + type: string + example: Failure + versions: + type: object + properties: + v1.0.1: + type: array + items: + oneOf: + - type: string + example: Published Date - Jan 11, 2021 + description: Bug fix - Threshold value + v1.0.0: + type: array + items: + oneOf: + - type: string + example: Published Date - Dec 09, 2020 + description: Standardizing Output JSON and model update + + v0.1.0: + type: array + items: + oneOf: + - type: string + example: Published Date - Jul 03,2020 + description: Initial version release + input: + type: object + required: + - model + - image_base64 + properties: + image_base64: + x-name: image_base64 + type: string + default: true + example: UklGRkbiBABXQVZFZm10IBAAAAABA... + description: |+ + Input image file in base64 format. + file_type: + x-name: file_type + type: string + default: false + example: jpg + description: |+ + Type of image file. If not specified, the type of file is detected and processed. + + Refer to Python Imaging Library (PIL) for supported formats: bmp, gif, jpg/jpeg, png. + threshold: + x-name: threshold + type: integer + format: float + default: false + example: 0.5 + description: |+ + 0.0 to 1.0. Default is 0.4. Higher threshold will return results with higher confidence. + filter: + x-name: filter + type: array + default: false + example: ["japan", "television_actors"] + description: |+ + Optional filters that allows the user to refine the output. There are 3 types of filters: + + 1. Countries - e.g. "Singapore", "Japan" + 2. Professions - e.g. "atheletes", "pop_singers" + 3. Individual person names - e.g. "Lee Hsien Loong". Useful if the user only wants to detect for specific people. + + See "Additional Information" section for full list of available filters + + securitySchemes: + APIAuthorizer: + type: apiKey + name: x-api-key + in: header + x-amazon-apigateway-authtype: custom + description: Authentication is done using the x-api-key in the request header diff --git a/computer_vision/landmark_detection_jp.yaml b/computer_vision/landmark_detection_jp.yaml new file mode 100644 index 000000000..aa0e23555 --- /dev/null +++ b/computer_vision/landmark_detection_jp.yaml @@ -0,0 +1,237 @@ +openapi: 3.0.1 +info: + title: Landmark Detection (JP) + description: |+ + This Computer Vision microservice identifies Japan landmarks from multiple input images. + + The microservice returns the detected landmark and confidence score. + + The size of your image file should **not exceed 5 MB**. + x-additionalinfo: |+ + Suggested Use Cases: + - Can be used for geo-targeting apps with map feature or property development planning resource apps. + version: '0.1.0' + x-subscribelink: landmark_detection_jp +servers: + - url: 'https://apis.sentient.io' +tags: +- name: "v0.1.0" + description: "Published Date - Jul 30, 2020" +paths: + /microservices/cv/landmarkjp/v0.1/getpredictions: + post: + tags: + - v0.1.0 + responses: + '200': + description: success response + content: + application/json: + schema: + $ref: '#/components/schemas/success' + example: + confidence: 100% + landmark: Gion + '401': + description: Unauthorized + content: + application/json: + schema: + $ref: '#/components/schemas/unauthorized' + '402': + description: Payment Required + content: + application/json: + schema: + $ref: '#/components/schemas/paymentrequired' + '403': + description: Forbidden + content: + application/json: + schema: + $ref: '#/components/schemas/forbidden' + '404': + description: Not Found + content: + application/json: + schema: + $ref: '#/components/schemas/notfound' + '419': + description: Input Field Missing + content: + application/json: + schema: + $ref: '#/components/schemas/inputfieldmissing' + '413': + description: Input Limit Exceeded + content: + application/json: + schema: + $ref: '#/components/schemas/inputlimitexceeded' + '415': + description: Invalid Input + content: + application/json: + schema: + $ref: '#/components/schemas/invalidinput' + '500': + description: Internal Server Error + content: + application/json: + schema: + $ref: '#/components/schemas/servererror' + '504': + description: Gateway Timeout + content: + application/json: + schema: + $ref: '#/components/schemas/gatewaytimeout' + security: + - APIAuthorizer: [] + + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/input' + required: true + + +components: + schemas: + success: + type: object + properties: + confidence: + x-name: confidence + type: string + example: 100% + description: Confidence score of identification. Higher is more confidence. + landmark: + x-name: landmark + type: string + example: Gion + description: Name of the landmark + + + + unauthorized: + type: object + properties: + message: + type: string + example: Missing Authentication Token + status: + type: string + example: Failure + restricted: + type: object + properties: + message: + type: string + example: The content is restricted + status: + type: string + example: Failure + forbidden: + type: object + properties: + message: + type: string + example: Access Denied Unauthorized User + status: + type: string + example: Failure + paymentrequired: + type: object + properties: + message: + type: string + example: Insufficient Credits Kindly Top Up + status: + type: string + example: Failure + notfound: + type: object + properties: + message: + type: string + example: Invalid Request + status: + type: string + example: Failure + servererror: + type: object + properties: + message: + type: string + example: Internal Server Error + status: + type: string + example: Failure + gatewaytimeout: + type: object + properties: + message: + type: string + example: Request Timeout + status: + type: string + example: Failure + inputfieldmissing: + type: object + properties: + message: + type: string + example: Input Field Missing + status: + type: string + example: Failure + inputlimitexceeded: + type: object + properties: + message: + type: string + example: Input Limit Exceeded + status: + type: string + example: Failure + invalidinput: + type: object + properties: + message: + type: string + example: Invalid Input + status: + type: string + example: Failure + versions: + type: object + properties: + v0.1.0: + type: array + items: + oneOf: + - type: string + example: Published Date - Jul 30,2020 + description: Initial version release + input: + type: object + properties: + image_base64: + x-name: image_base64 + type: string + default: true + example: UklGRkbiBABXQVZFZm10IBAAAAABA... + description: |+ + Input image in base64 format. + + Supported formats: blp, bmp, bufr, cur, dcx, dds, dib, eps, ps, fit, fits, flc, fli, fpx, ftc, ftu, gbr, gif, grib, h5, hd5, icns, ico, im, iim, jpeg, jp2, mic, mpeg, msp, pcd, pcx, pxr, png, ppm, psd, sgi, ras, tga, tiff, wmf, xbm, xpm. + + securitySchemes: + APIAuthorizer: + type: apiKey + name: x-api-key + in: header + x-amazon-apigateway-authtype: custom + description: Authentication is done using the x-api-key in the request header diff --git a/computer_vision/landmark_detection_jp_v1.0.yaml b/computer_vision/landmark_detection_jp_v1.0.yaml new file mode 100644 index 000000000..e0e2a920e --- /dev/null +++ b/computer_vision/landmark_detection_jp_v1.0.yaml @@ -0,0 +1,260 @@ +openapi: 3.0.1 +info: + title: Landmark Detection (JP) + description: |+ + This Computer Vision microservice identifies Japan landmarks from multiple input images. + + The microservice returns the detected landmark and confidence score. + + The size of your image file should **not exceed 5 MB**. + x-additionalinfo: |+ + Suggested Use Cases: + - Can be used for geo-targeting apps with map feature or property development planning resource apps. + version: '1.0.0' + x-subscribelink: landmark_detection_jp +servers: + - url: 'https://dev-apis.sentient.io' +tags: +- name: "v1.0.0" + description: "Published Date - Dec 31, 2020" +paths: + /microservices/cv/landmarkjp/v1/getpredictions: + post: + tags: + - v1.0.0 + responses: + '200': + description: success response + content: + application/json: + schema: + $ref: '#/components/schemas/success' + example: + results: + confidence: 100% + landmark: Gion + message: Successfully Processed + status: Success + '401': + description: Unauthorized + content: + application/json: + schema: + $ref: '#/components/schemas/unauthorized' + '402': + description: Payment Required + content: + application/json: + schema: + $ref: '#/components/schemas/paymentrequired' + '403': + description: Forbidden + content: + application/json: + schema: + $ref: '#/components/schemas/forbidden' + '404': + description: Not Found + content: + application/json: + schema: + $ref: '#/components/schemas/notfound' + '419': + description: Input Field Missing + content: + application/json: + schema: + $ref: '#/components/schemas/inputfieldmissing' + '420': + description: Input Limit Exceeded + content: + application/json: + schema: + $ref: '#/components/schemas/inputlimitexceeded' + '422': + description: Invalid Input + content: + application/json: + schema: + $ref: '#/components/schemas/invalidinput' + '500': + description: Internal Server Error + content: + application/json: + schema: + $ref: '#/components/schemas/servererror' + '504': + description: Gateway Timeout + content: + application/json: + schema: + $ref: '#/components/schemas/gatewaytimeout' + security: + - APIAuthorizer: [] + + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/input' + required: true + + +components: + schemas: + success: + type: object + properties: + results: + type: object + description: The result of the API call. + example: { "" } + properties: + confidence: + x-name: confidence + type: string + example: 100% + description: Confidence score of identification. Higher is more confidence. + landmark: + x-name: landmark + type: string + example: Gion + description: Name of the landmark + message: + type: string + example: Successfully Processed + description: Detail description on the API status + status: + type: string + example: Success + description: The status of the API call success/failure + + + + unauthorized: + type: object + properties: + message: + type: string + example: Missing Authentication Token + status: + type: string + example: Failure + restricted: + type: object + properties: + message: + type: string + example: The content is restricted + status: + type: string + example: Failure + forbidden: + type: object + properties: + message: + type: string + example: Access Denied Unauthorized User + status: + type: string + example: Failure + paymentrequired: + type: object + properties: + message: + type: string + example: Insufficient Credits Kindly Top Up + status: + type: string + example: Failure + notfound: + type: object + properties: + message: + type: string + example: Invalid Request + status: + type: string + example: Failure + servererror: + type: object + properties: + message: + type: string + example: Internal Server Error + status: + type: string + example: Failure + gatewaytimeout: + type: object + properties: + message: + type: string + example: Request Timeout + status: + type: string + example: Failure + inputfieldmissing: + type: object + properties: + message: + type: string + example: Input Field Missing + status: + type: string + example: Failure + inputlimitexceeded: + type: object + properties: + message: + type: string + example: Input Limit Exceeded + status: + type: string + example: Failure + invalidinput: + type: object + properties: + message: + type: string + example: Invalid Input + status: + type: string + example: Failure + versions: + type: object + properties: + v1.0.0: + type: array + items: + oneOf: + - type: string + example: Published Date - Dec 31, 2020 + description: Standardizing Output JSON + v0.1.0: + type: array + items: + oneOf: + - type: string + example: Published Date - Jul 30,2020 + description: Initial version release + input: + type: object + properties: + image_base64: + x-name: image_base64 + type: string + default: true + example: UklGRkbiBABXQVZFZm10IBAAAAABA... + description: |+ + Input image file in base64 format. + + Supported formats: blp, bmp, bufr, cur, dcx, dds, dib, eps, ps, fit, fits, flc, fli, fpx, ftc, ftu, gbr, gif, grib, h5, hd5, icns, ico, im, iim, jpeg, jp2, mic, mpeg, msp, pcd, pcx, pxr, png, ppm, psd, sgi, ras, tga, tiff, wmf, xbm, xpm. + + securitySchemes: + APIAuthorizer: + type: apiKey + name: x-api-key + in: header + x-amazon-apigateway-authtype: custom + description: Authentication is done using the x-api-key in the request header diff --git a/computer_vision/landmark_detection_sg.yaml b/computer_vision/landmark_detection_sg.yaml new file mode 100644 index 000000000..445b27108 --- /dev/null +++ b/computer_vision/landmark_detection_sg.yaml @@ -0,0 +1,241 @@ +openapi: 3.0.1 +info: + title: Landmark Detection (SG) + description: |+ + This Computer Vision microservice identifies Singapore landmarks from multiple input images. + + This microservice returns the detected landmark and confidence score. + + The size of your image file should **not exceed 5 MB**. + x-additionalinfo: |+ + Suggested Use Cases: + - Can be used for geo-targeting apps with map feature or property development planning resource apps. + version: '0.1.0' + x-subscribelink: landmark_detection_sg +servers: + - url: 'https://apis.sentient.io' +tags: +- name: "v0.1.0" + description: "Published Date - Jul 30, 2020" +paths: + /microservices/cv/landmarksg/v0.1/getpredictions: + post: + tags: + - v0.1.0 + + responses: + '200': + description: success response + content: + application/json: + schema: + $ref: '#/components/schemas/success' + example: + confidence: 100% + landmark: Artscience Museum + + '401': + description: Unauthorized + content: + application/json: + schema: + $ref: '#/components/schemas/unauthorized' + '402': + description: Payment Required + content: + application/json: + schema: + $ref: '#/components/schemas/paymentrequired' + '403': + description: Forbidden + content: + application/json: + schema: + $ref: '#/components/schemas/forbidden' + '404': + description: Not Found + content: + application/json: + schema: + $ref: '#/components/schemas/notfound' + '419': + description: Input Field Missing + content: + application/json: + schema: + $ref: '#/components/schemas/inputfieldmissing' + '413': + description: Input Limit Exceeded + content: + application/json: + schema: + $ref: '#/components/schemas/inputlimitexceeded' + '415': + description: Invalid Input + content: + application/json: + schema: + $ref: '#/components/schemas/invalidinput' + '500': + description: Internal Server Error + content: + application/json: + schema: + $ref: '#/components/schemas/servererror' + '504': + description: Gateway Timeout + content: + application/json: + schema: + $ref: '#/components/schemas/gatewaytimeout' + security: + - APIAuthorizer: [] + + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/input' + required: true + + +components: + schemas: + success: + type: object + properties: + confidence: + x-name: confidence + type: string + example: 100% + description: Confidence score of identification. Higher is more confidence. + landmark: + x-name: landmark + type: string + example: Artscience Museum + description: Name of the landmark + + + + unauthorized: + type: object + properties: + message: + type: string + example: Missing Authentication Token + status: + type: string + example: Failure + restricted: + type: object + properties: + message: + type: string + example: The content is restricted + status: + type: string + example: Failure + forbidden: + type: object + properties: + message: + type: string + example: Access Denied Unauthorized User + status: + type: string + example: Failure + paymentrequired: + type: object + properties: + message: + type: string + example: Insufficient Credits Kindly Top Up + status: + type: string + example: Failure + notfound: + type: object + properties: + message: + type: string + example: Invalid Request + status: + type: string + example: Failure + servererror: + type: object + properties: + message: + type: string + example: Internal Server Error + status: + type: string + example: Failure + gatewaytimeout: + type: object + properties: + message: + type: string + example: Request Timeout + status: + type: string + example: Failure + inputfieldmissing: + type: object + properties: + message: + type: string + example: Input Field Missing + status: + type: string + example: Failure + inputlimitexceeded: + type: object + properties: + message: + type: string + example: Input Limit Exceeded + status: + type: string + example: Failure + invalidinput: + type: object + properties: + message: + type: string + example: Invalid Input + status: + type: string + example: Failure + versions: + type: object + properties: + v0.1.0: + type: array + items: + oneOf: + - type: string + example: Published Date - Jul 30,2020 + description: Initial version release + input: + type: object + required: + - image_base64 + properties: + image_base64: + x-name: image_base64 + type: string + default: true + example: UklGRkbiBABXQVZFZm10IBAAAAABA... + description: |+ + Input image in base64 format. + + Supported formats: blp, bmp, bufr, cur, dcx, dds, dib, eps, ps, fit, fits, flc, fli, fpx, ftc, ftu, gbr, gif, grib, h5, hd5, icns, ico, im, iim, jpeg, jp2, mic, mpeg, msp, pcd, pcx, pxr, png, ppm, psd, sgi, ras, tga, tiff, wmf, xbm, xpm. + + securitySchemes: + APIAuthorizer: + type: apiKey + name: x-api-key + in: header + x-amazon-apigateway-authtype: custom + description: Authentication is done using the x-api-key in the request header diff --git a/computer_vision/landmark_detection_sg_v1.0.yaml b/computer_vision/landmark_detection_sg_v1.0.yaml new file mode 100644 index 000000000..13f03ef47 --- /dev/null +++ b/computer_vision/landmark_detection_sg_v1.0.yaml @@ -0,0 +1,264 @@ +openapi: 3.0.1 +info: + title: Landmark Detection (SG) + description: |+ + This Computer Vision microservice identifies Singapore landmarks from multiple input images. + + This microservice returns the detected landmark and confidence score. + + The size of your image file should **not exceed 5 MB**. + x-additionalinfo: |+ + Suggested Use Cases: + - Can be used for geo-targeting apps with map feature or property development planning resource apps. + version: '1.0.0' + x-subscribelink: landmark_detection_sg +servers: + - url: 'https://dev-apis.sentient.io' +tags: +- name: "v1.0.0" + description: "Published Date - Dec 31, 2020" +paths: + /microservices/cv/landmarksg/v1/getpredictions: + post: + tags: + - v1.0.0 + + responses: + '200': + description: success response + content: + application/json: + schema: + $ref: '#/components/schemas/success' + example: + results: + confidence: 100% + landmark: Artscience Museum + message: Successfully Processed + status: Success + + '401': + description: Unauthorized + content: + application/json: + schema: + $ref: '#/components/schemas/unauthorized' + '402': + description: Payment Required + content: + application/json: + schema: + $ref: '#/components/schemas/paymentrequired' + '403': + description: Forbidden + content: + application/json: + schema: + $ref: '#/components/schemas/forbidden' + '404': + description: Not Found + content: + application/json: + schema: + $ref: '#/components/schemas/notfound' + '419': + description: Input Field Missing + content: + application/json: + schema: + $ref: '#/components/schemas/inputfieldmissing' + '420': + description: Input Limit Exceeded + content: + application/json: + schema: + $ref: '#/components/schemas/inputlimitexceeded' + '422': + description: Invalid Input + content: + application/json: + schema: + $ref: '#/components/schemas/invalidinput' + '500': + description: Internal Server Error + content: + application/json: + schema: + $ref: '#/components/schemas/servererror' + '504': + description: Gateway Timeout + content: + application/json: + schema: + $ref: '#/components/schemas/gatewaytimeout' + security: + - APIAuthorizer: [] + + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/input' + required: true + + +components: + schemas: + success: + type: object + properties: + results: + type: object + description: The result of the API call. + example: { "" } + properties: + confidence: + x-name: confidence + type: string + example: 100% + description: Confidence score of identification. Higher is more confidence. + landmark: + x-name: landmark + type: string + example: Artscience Museum + description: Name of the landmark + message: + type: string + example: Successfully Processed + description: Detail description on the API status + status: + type: string + example: Success + description: The status of the API call success/failure + + + + unauthorized: + type: object + properties: + message: + type: string + example: Missing Authentication Token + status: + type: string + example: Failure + restricted: + type: object + properties: + message: + type: string + example: The content is restricted + status: + type: string + example: Failure + forbidden: + type: object + properties: + message: + type: string + example: Access Denied Unauthorized User + status: + type: string + example: Failure + paymentrequired: + type: object + properties: + message: + type: string + example: Insufficient Credits Kindly Top Up + status: + type: string + example: Failure + notfound: + type: object + properties: + message: + type: string + example: Invalid Request + status: + type: string + example: Failure + servererror: + type: object + properties: + message: + type: string + example: Internal Server Error + status: + type: string + example: Failure + gatewaytimeout: + type: object + properties: + message: + type: string + example: Request Timeout + status: + type: string + example: Failure + inputfieldmissing: + type: object + properties: + message: + type: string + example: Input Field Missing + status: + type: string + example: Failure + inputlimitexceeded: + type: object + properties: + message: + type: string + example: Input Limit Exceeded + status: + type: string + example: Failure + invalidinput: + type: object + properties: + message: + type: string + example: Invalid Input + status: + type: string + example: Failure + versions: + type: object + properties: + v1.0.0: + type: array + items: + oneOf: + - type: string + example: Published Date - Dec 31, 2020 + description: Standardizing Output JSON + v0.1.0: + type: array + items: + oneOf: + - type: string + example: Published Date - Jul 30,2020 + description: Initial version release + input: + type: object + required: + - image_base64 + properties: + image_base64: + x-name: image_base64 + type: string + default: true + example: UklGRkbiBABXQVZFZm10IBAAAAABA... + description: |+ + Input image file in base64 format. + + Supported formats: blp, bmp, bufr, cur, dcx, dds, dib, eps, ps, fit, fits, flc, fli, fpx, ftc, ftu, gbr, gif, grib, h5, hd5, icns, ico, im, iim, jpeg, jp2, mic, mpeg, msp, pcd, pcx, pxr, png, ppm, psd, sgi, ras, tga, tiff, wmf, xbm, xpm. + + securitySchemes: + APIAuthorizer: + type: apiKey + name: x-api-key + in: header + x-amazon-apigateway-authtype: custom + description: Authentication is done using the x-api-key in the request header diff --git a/computer_vision/object_detection.yaml b/computer_vision/object_detection.yaml new file mode 100644 index 000000000..d2025b37d --- /dev/null +++ b/computer_vision/object_detection.yaml @@ -0,0 +1,250 @@ +openapi: 3.0.1 +info: + title: Object Detection + description: |+ + This Computer Vision microservice detects objects in the input image. + + The microservice returns detected objects with their classes and their bounding boxes in the image coordinates. + + The classes are: person, bicycle, car, motorbike, aeroplane, bus, train, truck, boat, traffic light, fire hydrant, stop sign, parking meter, bench, bird, cat, dog, horse, sheep, cow, elephant, bear, zebra, giraffe, backpack, umbrella, handbag, tie, suitcase, frisbee, skis, snowboard, sports ball, kite, baseball bat, baseball glove, skateboard, surfboard, tennis racket, bottle, wine glass, cup, fork, knife, spoon, bowl, banana, apple, sandwich, orange, broccoli, carrot, hot dog, pizza, donut, cake, chair, sofa, pottedplant, bed, diningtable, toilet, tvmonitor, laptop, mouse, remote, keyboard, cell phone, microwave, oven, toaster, sink, refrigerator, book, clock, vase, scissors, teddy bear, hair drier, toothbrush. + + The size of your image file should **not exceed 5 MB**, and the image dimension should be **at least 416x416 pixels**. + x-additionalinfo: |+ + Suggested Use Cases: + - Industrial inspection - use Object Detection to automate the quality control process in manufacturing by enabling edge devices to identify defects. + + - Product search - build a product search app to find products of interest within images and visually search product catalogs. + + - Build an object detection app for the visually-impaired - help users identify daily objects that they may need aid in recognising + version: '0.1.0' + x-subscribelink: object_detection +servers: + - url: 'https://apis.sentient.io' +tags: +- name: "v0.1.0" + description: "Published Date - May 15, 2020" +paths: + /microservices/cv/objectdetection/v0.1/getpredictions: + post: + tags: + - v0.1.0 + responses: + '200': + description: success response + content: + application/json: + schema: + $ref: '#/components/schemas/success' + example: {"Object 1": ["person : 100%",{"Bounding Box": {"Bot": 742,"Left": 19,"Right": 1019,"Top": 73}}],"Object 2": ["tie : 100%",{"Bounding Box": {"Bot": 783,"Left": 411,"Right": 595,"Top": 520}}]} + + '401': + description: Unauthorized + content: + application/json: + schema: + $ref: '#/components/schemas/unauthorized' + '402': + description: Payment Required + content: + application/json: + schema: + $ref: '#/components/schemas/paymentrequired' + '403': + description: Forbidden + content: + application/json: + schema: + $ref: '#/components/schemas/forbidden' + '404': + description: Not Found + content: + application/json: + schema: + $ref: '#/components/schemas/notfound' + '419': + description: Input Field Missing + content: + application/json: + schema: + $ref: '#/components/schemas/inputfieldmissing' + '413': + description: Input Limit Exceeded + content: + application/json: + schema: + $ref: '#/components/schemas/inputlimitexceeded' + '415': + description: Invalid Input + content: + application/json: + schema: + $ref: '#/components/schemas/invalidinput' + '500': + description: Internal Server Error + content: + application/json: + schema: + $ref: '#/components/schemas/servererror' + '504': + description: Gateway Timeout + content: + application/json: + schema: + $ref: '#/components/schemas/gatewaytimeout' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/input' + required: true + security: + - APIAuthorizer: [] +components: + schemas: + success: + type: object + properties: + : + type: array + example: ["person : 100%",{"Bounding Box": {"Bot": 742,"Left": 19,"Right": 1019,"Top": 73}}] + description: "Details of the detected object" + items: + properties: + person: + type: string + example: 100% + description: people + Bounding Box: + type: object + example: {"Bot": 742,"Left": 19,"Right": 1019,"Top": 73} + description: Bounding box of the image + properties: + Bot: + type: number + example: 742 + description: Bottom coordinate of the box + Left: + type: number + example: 19 + description: Left coordinate of the box + Right: + type: number + example: 1019 + description: Right coordinate of the box + Top: + type: number + example: 73 + description: Top coordinate of the box + unauthorized: + type: object + properties: + message: + type: string + example: Missing Authentication Token + status: + type: string + example: Failure + forbidden: + type: object + properties: + message: + type: string + example: Access Denied Unauthorized User + status: + type: string + example: Failure + paymentrequired: + type: object + properties: + message: + type: string + example: Insufficient Credits Kindly Top Up + status: + type: string + example: Failure + notfound: + type: object + properties: + message: + type: string + example: Invalid Request URL + status: + type: string + example: Failure + servererror: + type: object + properties: + message: + type: string + example: Internal Server Error + status: + type: string + example: Failure + gatewaytimeout: + type: object + properties: + message: + type: string + example: Request Timeout + status: + type: string + example: Failure + invalidinput: + type: object + properties: + message: + type: string + example: Invalid Input + status: + type: string + example: Failure + inputfieldmissing: + type: object + properties: + message: + type: string + example: Input Field Missing + status: + type: string + example: Failure + inputlimitexceeded: + type: object + properties: + message: + type: string + example: Input Limit Exceeded + status: + type: string + example: Failure + + versions: + type: object + properties: + v0.1.0: + type: array + items: + oneOf: + - type: string + example: Published Date - May 15,2020 + description: Initial version release + input: + type: object + required: + - image_base64 + properties: + image_base64: + x-name: image_base64 + type: string + default: true + example: /9j/4AAQSkZJRgABAQEASABIAAD/2wBDAAMCAgMCAgMDAwMEAwMEBQgFBQQEBQoHBwYIDAoMDAsKCwsNDhIQDQ4RDgsLEBYQERMUFRUVDA8XGBYUG... + description: |+ + Input image file in base64 format. + + Supported formats: bmp, dib, exr, hdr, jpeg, jpg, jpe, jp2, png, pic, pbm, pgm, ppm, pxm, pnm, ras, sr, tiff, tif, webp. + securitySchemes: + APIAuthorizer: + type: apiKey + name: x-api-key + in: header + x-amazon-apigateway-authtype: custom + description: Authentication is done using the x-api-key in the request header diff --git a/computer_vision/object_detection_v1.0.yaml b/computer_vision/object_detection_v1.0.yaml new file mode 100644 index 000000000..e5db137ef --- /dev/null +++ b/computer_vision/object_detection_v1.0.yaml @@ -0,0 +1,278 @@ +openapi: 3.0.1 +info: + title: Object Detection + description: |+ + This Computer Vision microservice detects objects in the input image. + + The microservice returns detected objects with their classes and their bounding boxes in the image coordinates. + + The classes are: person, bicycle, car, motorbike, aeroplane, bus, train, truck, boat, traffic light, fire hydrant, stop sign, parking meter, bench, bird, cat, dog, horse, sheep, cow, elephant, bear, zebra, giraffe, backpack, umbrella, handbag, tie, suitcase, frisbee, skis, snowboard, sports ball, kite, baseball bat, baseball glove, skateboard, surfboard, tennis racket, bottle, wine glass, cup, fork, knife, spoon, bowl, banana, apple, sandwich, orange, broccoli, carrot, hot dog, pizza, donut, cake, chair, sofa, pottedplant, bed, diningtable, toilet, tvmonitor, laptop, mouse, remote, keyboard, cell phone, microwave, oven, toaster, sink, refrigerator, book, clock, vase, scissors, teddy bear, hair drier, toothbrush. + + The size of your image file should **not exceed 5 MB**, and the image dimension should be **at least 416x416 pixels**. + x-additionalinfo: |+ + Suggested Use Cases: + - Industrial inspection - use Object Detection to automate the quality control process in manufacturing by enabling edge devices to identify defects. + - Product search - build a product search app to find products of interest within images and visually search product catalogs. + - Build an object detection app for the visually-impaired - help users identify daily objects that they may need aid in recognising + version: '1.0.0' + x-subscribelink: object_detection +servers: + - url: 'https://apis.sentient.io' +tags: +- name: "v1.0.0" + description: "Published Date - Dec 31, 2020" +paths: + /microservices/cv/objectdetection/v1/getpredictions: + post: + tags: + - v1.0.0 + responses: + '200': + description: success response + content: + application/json: + schema: + $ref: '#/components/schemas/success' + example: {"results":{"objects": [{"bounding box": {"bottom": 742,"left": 19,"right": 1019,"top": 73},"class": "person","confidence": 1,"object id": 0}]},"message": "Successfully Processed","status": "Success"} + + '401': + description: Unauthorized + content: + application/json: + schema: + $ref: '#/components/schemas/unauthorized' + '402': + description: Payment Required + content: + application/json: + schema: + $ref: '#/components/schemas/paymentrequired' + '403': + description: Forbidden + content: + application/json: + schema: + $ref: '#/components/schemas/forbidden' + '404': + description: Not Found + content: + application/json: + schema: + $ref: '#/components/schemas/notfound' + '419': + description: Input Field Missing + content: + application/json: + schema: + $ref: '#/components/schemas/inputfieldmissing' + '420': + description: Input Limit Exceeded + content: + application/json: + schema: + $ref: '#/components/schemas/inputlimitexceeded' + '422': + description: Invalid Input + content: + application/json: + schema: + $ref: '#/components/schemas/invalidinput' + '500': + description: Internal Server Error + content: + application/json: + schema: + $ref: '#/components/schemas/servererror' + '504': + description: Gateway Timeout + content: + application/json: + schema: + $ref: '#/components/schemas/gatewaytimeout' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/input' + required: true + security: + - APIAuthorizer: [] +components: + schemas: + success: + type: object + properties: + results: + type: object + description: The result of the API call. + example: { "" } + properties: + objects: + type: array + example: [{"bounding box": {"bottom": 742,"left": 19,"right": 1019,"top": 73},"class": "person","confidence": 1,"object id": 0}] + description: "Details of the detected object" + items: + oneOf: + - type: object + properties: + bounding box: + type: object + example: {"bottom": 742,"left": 19,"right": 1019,"top": 73} + description: Bounding box of the image + properties: + bottom: + type: number + example: 742 + description: Bottom coordinate of the box + left: + type: number + example: 19 + description: Left coordinate of the box + right: + type: number + example: 1019 + description: Right coordinate of the box + top: + type: number + example: 73 + description: Top coordinate of the box + class: + type: string + example: person + description: Detected object + confidence: + type: number + example: 1 + description: Confidence of the detected object. Higher confidence, more accurate the detected object. + object id: + type: number + example: 0 + description: Detected object id + message: + type: string + example: Successfully Processed + description: Detail description on the API status + status: + type: string + example: Success + description: The status of the API call success/failure + unauthorized: + type: object + properties: + message: + type: string + example: Missing Authentication Token + status: + type: string + example: Failure + forbidden: + type: object + properties: + message: + type: string + example: Access Denied Unauthorized User + status: + type: string + example: Failure + paymentrequired: + type: object + properties: + message: + type: string + example: Insufficient Credits Kindly Top Up + status: + type: string + example: Failure + notfound: + type: object + properties: + message: + type: string + example: Invalid Request URL + status: + type: string + example: Failure + servererror: + type: object + properties: + message: + type: string + example: Internal Server Error + status: + type: string + example: Failure + gatewaytimeout: + type: object + properties: + message: + type: string + example: Request Timeout + status: + type: string + example: Failure + invalidinput: + type: object + properties: + message: + type: string + example: Invalid Input + status: + type: string + example: Failure + inputfieldmissing: + type: object + properties: + message: + type: string + example: Input Field Missing + status: + type: string + example: Failure + inputlimitexceeded: + type: object + properties: + message: + type: string + example: Input Limit Exceeded + status: + type: string + example: Failure + + versions: + type: object + properties: + v1.0.0: + type: array + items: + oneOf: + - type: string + example: Published Date - Dec 31, 2020 + description: Standardizing Output JSON + v0.1.0: + type: array + items: + oneOf: + - type: string + example: Published Date - May 15,2020 + description: Initial version release + input: + type: object + required: + - image_base64 + properties: + image_base64: + x-name: image_base64 + type: string + default: true + example: /9j/4AAQSkZJRgABAQEASABIAAD/2wBDAAMCAgMCAgMDAwMEAwMEBQgFBQQEBQoHBwYIDAoMDAsKCwsNDhIQDQ4RDgsLEBYQERMUFRUVDA8XGBYUG... + description: |+ + Input image file in base64 format. + + Supported formats: bmp, dib, exr, hdr, jpeg, jpg, jpe, jp2, png, pic, pbm, pgm, ppm, pxm, pnm, ras, sr, tiff, tif, webp. + securitySchemes: + APIAuthorizer: + type: apiKey + name: x-api-key + in: header + x-amazon-apigateway-authtype: custom + description: Authentication is done using the x-api-key in the request header diff --git a/computer_vision/people_counting.yaml b/computer_vision/people_counting.yaml new file mode 100644 index 000000000..56f42c7b0 --- /dev/null +++ b/computer_vision/people_counting.yaml @@ -0,0 +1,247 @@ +openapi: 3.0.1 +info: + title: People Counting + description: |+ + This Computer Vision microservice tracks and counts people appearing in the input video. + + This microservice returns the number of people detected in that video, the likelihood of overestimation/underestimation, the first appearance and the duration and confidence of each person detected. + + The size of your image file should **not exceed 10 MB**, and the image dimension should be **least more than 416x416 pixels**. + x-additionalinfo: |+ + Suggested Use Cases: + - Improve visitor experience and optimize operations in retail, leisure, and other sectors - build services to count visitor traffic in venues, measure detailed movements and interactions, and visualize that data to better understand what is happening in within a certain spaces. For example, one can optimize traffic, staff and marketing strategies to increase conversion rates and profits with actionable data. Businesses can use visitor count as a benchmark to figure out the conversion rate for a certain spot to see the real performance. Efficiently allocating the number of staff according to hourly visitor traffic will also create value in terms of revenue, profit and  efficiency. + version: '0.1.0' + x-subscribelink: people_counting +servers: + - url: 'https://apis.sentient.io' +tags: +- name: "v0.1.0" + description: "Published Date - Jul 30, 2020" +paths: + /microservices/cv/peoplecounting/v0.1/getpredictions: + post: + tags: + - v0.1.0 + + responses: + '200': + description: success response + content: + application/json: + schema: + $ref: '#/components/schemas/success' + example: {'counter': '11 people', 'likelihood of overestimation': '76.0%', 'likelihood of underestimation': '39.0%', 'people': [{'person id: 001': ['first appearance: 1.28s', 'duration appeared: 7.66s', 'detection confidence: 77%', 'assigning confidence: 100%']}, {'person id: 002': ['first appearance: 3.34s', 'duration appeared: 7.03s', 'detection confidence: 73%', 'assigning confidence: 82.0%']}]} + + '401': + description: Unauthorized + content: + application/json: + schema: + $ref: '#/components/schemas/unauthorized' + '402': + description: Payment Required + content: + application/json: + schema: + $ref: '#/components/schemas/paymentrequired' + '403': + description: Forbidden + content: + application/json: + schema: + $ref: '#/components/schemas/forbidden' + '404': + description: Not Found + content: + application/json: + schema: + $ref: '#/components/schemas/notfound' + '419': + description: Input Field Missing + content: + application/json: + schema: + $ref: '#/components/schemas/inputfieldmissing' + '413': + description: Input Limit Exceeded + content: + application/json: + schema: + $ref: '#/components/schemas/inputlimitexceeded' + '415': + description: Invalid Input + content: + application/json: + schema: + $ref: '#/components/schemas/invalidinput' + '500': + description: Internal Server Error + content: + application/json: + schema: + $ref: '#/components/schemas/servererror' + '504': + description: Gateway Timeout + content: + application/json: + schema: + $ref: '#/components/schemas/gatewaytimeout' + security: + - APIAuthorizer: [] + + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/input' + required: true + + +components: + schemas: + success: + type: object + example: {'counter': '11 people', 'likelihood of overestimation': '76.0%', 'likelihood of underestimation': '39.0%', 'people': [{'person id: 001': ['first appearance: 1.28s', 'duration appeared: 7.66s', 'detection confidence: 77%', 'assigning confidence: 100%']}, {'person id: 002': ['first appearance: 3.34s', 'duration appeared: 7.03s', 'detection confidence: 73%', 'assigning confidence: 82.0%']}]} + properties: + counter: + type: string + example: 11 people + description: Number of people detected in video + likelihood of overestimation: + type: string + example: 76.0% + description: How likely would there be ID spikes causing counter to increase People + likelihood of underestimation: + type: string + example: 39.0% + description: How likely the model might miss out detecting people in the video + people: + type: array + example: [{'person ID: 001': ['first appearance: 1.28s', 'duration appeared: 7.66s', 'detection confidence: 77%', 'assigning confidence: 100%']}, {'person ID: 002': ['first appearance: 3.34s', 'duration appeared: 7.03s', 'detection confidence: 73%', 'assigning confidence: 82.0%']}] + description: Contains a list of individual Persons and their metadata. + items: + oneOf: + - type: object + example: {'person ID: 001': ['first appearance: 1.28s', 'duration appeared: 7.66s', 'detection confidence: 77%', 'assigning confidence: 100%']} + unauthorized: + type: object + properties: + message: + type: string + example: Missing Authentication Token + status: + type: string + example: Failure + restricted: + type: object + properties: + message: + type: string + example: The content is restricted + status: + type: string + example: Failure + forbidden: + type: object + properties: + message: + type: string + example: Access Denied Unauthorized User + status: + type: string + example: Failure + paymentrequired: + type: object + properties: + message: + type: string + example: Insufficient Credits Kindly Top Up + status: + type: string + example: Failure + invalidinput: + type: object + properties: + message: + type: string + example: Invalid Input + status: + type: string + example: Failure + notfound: + type: object + properties: + message: + type: string + example: Invalid Request + status: + type: string + example: Failure + servererror: + type: object + properties: + message: + type: string + example: Internal Server Error + status: + type: string + example: Failure + gatewaytimeout: + type: object + properties: + message: + type: string + example: Request Timeout + status: + type: string + example: Failure + inputfieldmissing: + type: object + properties: + message: + type: string + example: Input Field Missing + status: + type: string + example: Failure + inputlimitexceeded: + type: object + properties: + message: + type: string + example: Input Limit Exceeded + status: + type: string + example: Failure + versions: + type: object + properties: + v0.1.0: + type: array + items: + oneOf: + - type: string + example: Published Date - Jul 30,2020 + description: Initial version release + input: + type: object + required: + - video_base64 + properties: + video_base64: + x-name: video_base64 + type: string + default: true + example: UklGRkbiBABXQVZFZm10IBAAAAABA... + description: |+ + Input video in base64 format. + + Supported formats: acm, anm, apc, au, avi, bfi, bmp_pipe, bmv, codec2, dsf, dss, dvd, fifo, genh, gif, gxf, hls, iff, ifv, ipod, jpeg_pipe, jv, m4v, mjpeg, mlp, mlv, mov, mp2, mp3, mp4, pbm_pipe, pmp, png_pipe, psd_pipe, psp, rawvideo, sdp, sds, sdx, tmv, uncodedframecrc, vcd, vidc, vmd, voc, vpk, wav, webm, wsd, wsvqa, wtv, xmv, xpm_pipe. + + securitySchemes: + APIAuthorizer: + type: apiKey + name: x-api-key + in: header + x-amazon-apigateway-authtype: custom + description: Authentication is done using the x-api-key in the request header diff --git a/computer_vision/people_counting_v1.0.yaml b/computer_vision/people_counting_v1.0.yaml new file mode 100644 index 000000000..bf40d0cc3 --- /dev/null +++ b/computer_vision/people_counting_v1.0.yaml @@ -0,0 +1,259 @@ +openapi: 3.0.1 +info: + title: People Counting + description: |+ + This Computer Vision microservice tracks and counts people appearing in the input video. + + This microservice returns the number of people detected in that video, the likelihood of overestimation/underestimation, the first appearance and the duration and confidence of each person detected. + + The size of your image file should **not exceed 10 MB**, and the image dimension should be **least more than 416x416 pixels**. + x-additionalinfo: |+ + Suggested Use Cases: + - Improve visitor experience and optimize operations in retail, leisure, and other sectors - build services to count visitor traffic in venues, measure detailed movements and interactions, and visualize that data to better understand what is happening in within a certain spaces. For example, one can optimize traffic, staff and marketing strategies to increase conversion rates and profits with actionable data. Businesses can use visitor count as a benchmark to figure out the conversion rate for a certain spot to see the real performance. Efficiently allocating the number of staff according to hourly visitor traffic will also create value in terms of revenue, profit and  efficiency. + version: '1.0.0' + x-subscribelink: people_counting +servers: + - url: 'https://dev-apis.sentient.io' +tags: +- name: "v1.0.0" + description: "Published Date - Dec 31, 2020" +paths: + /microservices/cv/peoplecounting/v1/getpredictions: + post: + tags: + - v1.0.0 + + responses: + '200': + description: success response + content: + application/json: + schema: + $ref: '#/components/schemas/success' + example: {"results": {"counter": 11, "likelihood of overestimation": 0.76,"likelihood of underestimation": 0.39,"people": [{"assigning confidence": 1,"bounding boxes": {"frame": {"294": {"bottom": 420,"left": 249,"right": 417,"top": 207},"300": {"bottom": 420,"left": 249,"right": 417,"top": 207}}},"detection confidence": 0.76,"duration appeared": 0.20689655172413793,"first appearance": 10.137931034482758,"person id": "011"}]},"message": "Successfully Processed","status": "Success"} + '401': + description: Unauthorized + content: + application/json: + schema: + $ref: '#/components/schemas/unauthorized' + '402': + description: Payment Required + content: + application/json: + schema: + $ref: '#/components/schemas/paymentrequired' + '403': + description: Forbidden + content: + application/json: + schema: + $ref: '#/components/schemas/forbidden' + '404': + description: Not Found + content: + application/json: + schema: + $ref: '#/components/schemas/notfound' + '419': + description: Input Field Missing + content: + application/json: + schema: + $ref: '#/components/schemas/inputfieldmissing' + '420': + description: Input Limit Exceeded + content: + application/json: + schema: + $ref: '#/components/schemas/inputlimitexceeded' + '422': + description: Invalid Input + content: + application/json: + schema: + $ref: '#/components/schemas/invalidinput' + '500': + description: Internal Server Error + content: + application/json: + schema: + $ref: '#/components/schemas/servererror' + '504': + description: Gateway Timeout + content: + application/json: + schema: + $ref: '#/components/schemas/gatewaytimeout' + security: + - APIAuthorizer: [] + + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/input' + required: true + + +components: + schemas: + success: + type: object + properties: + results: + type: object + description: The result of the API call. + example: { "" } + properties: + counter: + type: integer + example: 11 + description: Number of people detected in video + likelihood of overestimation: + type: number + format: float + example: 0.76 + description: How likely would there be ID spikes causing counter to increase People + likelihood of underestimation: + type: number + format: float + example: 0.39 + description: How likely the model might miss out detecting people in the video + people: + type: array + example: [{'person id': "001",'first appearance': 1.28, 'duration appeared': 7.66, 'detection confidence': 0.77, 'assigning confidence': 1,"bounding boxes": {"frame": {"294": {"bottom": 420,"left": 249,"right": 417,"top": 207},"300": {"bottom": 420,"left": 249,"right": 417,"top": 207}}}}] + description: Contains a list of individual Persons and their metadata. + items: + oneOf: + - type: object + example: {'person id': "001",'first appearance': 1.28, 'duration appeared': 7.66, 'detection confidence': 0.77, 'assigning confidence': 1,"bounding boxes": {"frame": {"294": {"bottom": 420,"left": 249,"right": 417,"top": 207},"300": {"bottom": 420,"left": 249,"right": 417,"top": 207}}}} + unauthorized: + type: object + properties: + message: + type: string + example: Missing Authentication Token + status: + type: string + example: Failure + restricted: + type: object + properties: + message: + type: string + example: The content is restricted + status: + type: string + example: Failure + forbidden: + type: object + properties: + message: + type: string + example: Access Denied Unauthorized User + status: + type: string + example: Failure + paymentrequired: + type: object + properties: + message: + type: string + example: Insufficient Credits Kindly Top Up + status: + type: string + example: Failure + invalidinput: + type: object + properties: + message: + type: string + example: Invalid Input + status: + type: string + example: Failure + notfound: + type: object + properties: + message: + type: string + example: Invalid Request + status: + type: string + example: Failure + servererror: + type: object + properties: + message: + type: string + example: Internal Server Error + status: + type: string + example: Failure + gatewaytimeout: + type: object + properties: + message: + type: string + example: Request Timeout + status: + type: string + example: Failure + inputfieldmissing: + type: object + properties: + message: + type: string + example: Input Field Missing + status: + type: string + example: Failure + inputlimitexceeded: + type: object + properties: + message: + type: string + example: Input Limit Exceeded + status: + type: string + example: Failure + versions: + type: object + properties: + v1.0.0: + type: array + items: + oneOf: + - type: string + example: Published Date - Dec 31, 2020 + description: Standardizing Output JSON + v0.1.0: + type: array + items: + oneOf: + - type: string + example: Published Date - Jul 30,2020 + description: Initial version release + input: + type: object + required: + - video_base64 + properties: + video_base64: + x-name: video_base64 + type: string + default: true + example: UklGRkbiBABXQVZFZm10IBAAAAABA... + description: |+ + Input video file in base64 format. + + Supported formats: acm, anm, apc, au, avi, bfi, bmp_pipe, bmv, codec2, dsf, dss, dvd, fifo, genh, gif, gxf, hls, iff, ifv, ipod, jpeg_pipe, jv, m4v, mjpeg, mlp, mlv, mov, mp2, mp3, mp4, pbm_pipe, pmp, png_pipe, psd_pipe, psp, rawvideo, sdp, sds, sdx, tmv, uncodedframecrc, vcd, vidc, vmd, voc, vpk, wav, webm, wsd, wsvqa, wtv, xmv, xpm_pipe. + + securitySchemes: + APIAuthorizer: + type: apiKey + name: x-api-key + in: header + x-amazon-apigateway-authtype: custom + description: Authentication is done using the x-api-key in the request header diff --git a/data/amenities_hardcourts_hdb_sg.yaml b/data/amenities_hardcourts_hdb_sg.yaml new file mode 100644 index 000000000..d259b8da7 --- /dev/null +++ b/data/amenities_hardcourts_hdb_sg.yaml @@ -0,0 +1,236 @@ +openapi: 3.0.1 +info: + title: HDB Hardcourts Locations (SG) + x-subscribelink: amenities_hardcourts_hdb_sg + description: |+ + This Data microservice returns the indicative outline of hardcourts for all Housing Development Board of Singapore (HDB) Towns, HDB Estates and on HDB Land. The features were identified visually from high definition ortho-rectified aerial imagery and manually digitised. The imagery was obtained from Singapore Land Authority (SLA) (captured in 2014). Objects largely obstructed by trees, structures and / or shadow are likely not captured in this dataset. The outlines of partially obstructed objects were extrapolated where possible and may not fully represent the actual shape of the actual object. + As this is a dataset download microservice, a successful call will return a pre-signed URL where the entire dataset can be downloaded as a CSV file. + The HDB POTH programme makes selected public and non-public datasets available to developers and companies to improve their service offerings to benefit the lives of Singapore citizens. Sentient.io is proud to partner with HDB to manage and facilitate the sharing of data for the POTH Programme. + x-additionalinfo: |+ + Suggested Use Cases: + - Real estate services - can be used as a solution to extract information related to the types and number of hardcourts present in an area for people buying or renting a HDB home. + + Download the complete dataset using a pre-signed URL. It's a two steps process + + **Step 1:** Get the pre-signed URL + + Replace the correct x-api-key, and API endpoint + + > **curl -X GET -H "Content-Type: application/json" -H "x-api-key:XXXXX" <\>** + + **Step 2:** Download file + + Using the results.url (i.e) the pre-signed URL to download the dataset + + > **curl --request GET "results.url" >> "FILE_NAME"** + + **Data schema** + + | Name | Type | Size | Description | + |---|---|---|---|---| + | FEATID | Integer | N/A | Feature ID. Unique running number. | + | TYPE | Char | N/A | Captures the type of object. | + | LVL | Char | N/A | Captures whether the object is located at Ground level or Above Ground level. | + | QUALITY | Char | N/A | Captures whether the section of the feature was Fully Visible or Partially Visible. | + | INC_CRC | Varchar | 50 | Sub Location Id | + | FMEL_UPD_D | Datetime | N/A | Area of the feature | + | Shape__Length | Float | N/A | Length of the feature | + version: '0.1.0' +servers: + - url: 'https://api.sentient.io' +tags: +- name: "v0.1.0" + description: "Published Date - Mar 24, 2020" +paths: + /DaaS/prod/hdb/amenities/gs/csv/hardcourt/hdb: + get: + tags: + - v0.1.0 + responses: + '200': + description: success response + content: + application/json: + schema: + $ref: '#/components/schemas/success' + example: + results: + url: "" + status: Success + message: Successfully Processed + '401': + description: Unauthorized + content: + application/json: + schema: + $ref: '#/components/schemas/unauthorized' + '402': + description: Payment Required + content: + application/json: + schema: + $ref: '#/components/schemas/paymentrequired' + '403': + description: Forbidden + content: + application/json: + schema: + $ref: '#/components/schemas/forbidden' + '404': + description: Not Found + content: + application/json: + schema: + $ref: '#/components/schemas/notfound' + '419': + description: Input Field Missing + content: + application/json: + schema: + $ref: '#/components/schemas/inputfieldmissing' + '413': + description: Input Limit Exceeded + content: + application/json: + schema: + $ref: '#/components/schemas/inputlimitexceeded' + '415': + description: Invalid Input + content: + application/json: + schema: + $ref: '#/components/schemas/invalidinput' + '500': + description: Internal Server Error + content: + application/json: + schema: + $ref: '#/components/schemas/servererror' + '504': + description: Gateway Timeout + content: + application/json: + schema: + $ref: '#/components/schemas/gatewaytimeout' + security: + - APIAuthorizer: [] +components: + schemas: + success: + type: object + properties: + results: + type: object + example: { "" } + description: Json Object of returned results + properties: + url: + type: string + description: pre-signed URL to download the file + example: "" + status: + type: string + example: Success + description: The status of the API call. success/failure + message: + type: string + example: Successfully Processed + description: Detail description on the api status + unauthorized: + type: object + properties: + message: + type: string + example: Missing Authentication Token + status: + type: string + example: Failure + forbidden: + type: object + properties: + message: + type: string + example: Access Denied Unauthorized User + status: + type: string + example: Failure + paymentrequired: + type: object + properties: + message: + type: string + example: Insufficient Credits Kindly Top Up + status: + type: string + example: Failure + notfound: + type: object + properties: + message: + type: string + example: Invalid Request URL + status: + type: string + example: Failure + servererror: + type: object + properties: + message: + type: string + example: Internal Server Error + status: + type: string + example: Failure + gatewaytimeout: + type: object + properties: + message: + type: string + example: Request Timeout + status: + type: string + example: Failure + inputfieldmissing: + type: object + properties: + message: + type: string + example: Input Field Missing + status: + type: string + example: Failure + inputlimitexceeded: + type: object + properties: + message: + type: string + example: Input Limit Exceeded + status: + type: string + example: Failure + invalidinput: + type: object + properties: + message: + type: string + example: Invalid Input + status: + type: string + example: Failure + versions: + type: object + properties: + v0.1.0: + type: array + items: + oneOf: + - type: string + example: Published Date - Mar 24, 2020 + description: Initial version release + securitySchemes: + APIAuthorizer: + type: apiKey + name: x-api-key + in: header + x-amazon-apigateway-authtype: custom + description: Authentication is done using the x-api-key in the request header. diff --git a/data/amenities_lamp_posts_hdb_sg.yaml b/data/amenities_lamp_posts_hdb_sg.yaml new file mode 100644 index 000000000..c5fb4f0ad --- /dev/null +++ b/data/amenities_lamp_posts_hdb_sg.yaml @@ -0,0 +1,238 @@ +openapi: 3.0.1 +info: + title: HDB Lamp Posts Locations (SG) + x-subscribelink: amenities_lamp_posts_hdb_sg + description: |+ + This Data microservice returns the indicative location of lamp posts for all Housing Development Board of Singapore (HDB) Towns, HDB Estates and on HDB Land. The features were identified visually from high definition ortho-rectified aerial imagery and manually digitised. The imagery was obtained from Singapore Land Authority (SLA) (captured in 2014). Objects largely obstructed by trees, structures and / or shadow are likely not captured in this dataset. + As this is a dataset download microservice, a successful call will return a pre-signed URL where the entire dataset can be downloaded as a CSV file. + The HDB POTH programme makes selected public and non-public datasets available to developers and companies to improve their service offerings to benefit the lives of Singapore citizens. Sentient.io is proud to partner with HDB to manage and facilitate the sharing of data for the POTH Programme. + x-additionalinfo: |+ + Suggested Use Cases: + - Real estate services or social service solutions - can be used as a background check solution to extract information related to lampposts present in an area for people with certain preferences when buying or renting a HDB home. For example, the elderly may prefer HDB homes surrounded with more lampposts as they require more aid in terms of lighting when walking home. + + Download the complete dataset using a pre-signed URL. It's a two steps process + + **Step 1:** Get the pre-signed URL + + Replace the correct x-api-key, and API endpoint + + > **curl -X GET -H "Content-Type: application/json" -H "x-api-key:XXXXX" ** + + **Step 2:** Download file + + Using the results.url (i.e) the pre-signed URL to download the dataset + + > **curl --request GET "results.url" >> "FILE_NAME"** + + **Data schema** + + | Name | Type | Size | Description | + |---|---|---|---|---| + | FEATID | Integer | N/A | Feature ID. Unique running number. | + | TYPE | Char | N/A | Captures the type of object. | + | LVL | Char | N/A | Captures whether the object is located at Ground level or Above Ground level. | + | QUALITY | Char | N/A | Captures whether the section of the feature was Fully Visible or Partially Visible. | + | INC_CRC | Varchar | 50 | Sub Location Id | + | FMEL_UPD_D | Datetime | N/A | Area of the feature | + | x | Float | N/A | ESRI x coordinate | + | y | Float | N/A | ESRI y coordinate | + version: '0.1.0' +servers: + - url: 'https://api.sentient.io' +tags: +- name: "v0.1.0" + description: "Published Date - Mar 24, 2020" + +paths: + /DaaS/prod/hdb/amenities/gs/csv/lamppost/hdb: + get: + tags: + - v0.1.0 + responses: + '200': + description: success response + content: + application/json: + schema: + $ref: '#/components/schemas/success' + example: + results: + url: "" + status: Success + message: Successfully Processed + '401': + description: Unauthorized + content: + application/json: + schema: + $ref: '#/components/schemas/unauthorized' + '402': + description: Payment Required + content: + application/json: + schema: + $ref: '#/components/schemas/paymentrequired' + '403': + description: Forbidden + content: + application/json: + schema: + $ref: '#/components/schemas/forbidden' + '404': + description: Not Found + content: + application/json: + schema: + $ref: '#/components/schemas/notfound' + '419': + description: Input Field Missing + content: + application/json: + schema: + $ref: '#/components/schemas/inputfieldmissing' + '413': + description: Input Limit Exceeded + content: + application/json: + schema: + $ref: '#/components/schemas/inputlimitexceeded' + '415': + description: Invalid Input + content: + application/json: + schema: + $ref: '#/components/schemas/invalidinput' + '500': + description: Internal Server Error + content: + application/json: + schema: + $ref: '#/components/schemas/servererror' + '504': + description: Gateway Timeout + content: + application/json: + schema: + $ref: '#/components/schemas/gatewaytimeout' + security: + - APIAuthorizer: [] +components: + schemas: + success: + type: object + properties: + results: + type: object + example: { "" } + description: Json Object of returned results + properties: + url: + type: string + description: pre-signed URL to download the file + example: "" + status: + type: string + example: Success + description: The status of the API call. success/failure + message: + type: string + example: Successfully Processed + description: Detail description on the api status + unauthorized: + type: object + properties: + message: + type: string + example: Missing Authentication Token + status: + type: string + example: Failure + forbidden: + type: object + properties: + message: + type: string + example: Access Denied Unauthorized User + status: + type: string + example: Failure + paymentrequired: + type: object + properties: + message: + type: string + example: Insufficient Credits Kindly Top Up + status: + type: string + example: Failure + notfound: + type: object + properties: + message: + type: string + example: Invalid Request URL + status: + type: string + example: Failure + servererror: + type: object + properties: + message: + type: string + example: Internal Server Error + status: + type: string + example: Failure + gatewaytimeout: + type: object + properties: + message: + type: string + example: Request Timeout + status: + type: string + example: Failure + inputfieldmissing: + type: object + properties: + message: + type: string + example: Input Field Missing + status: + type: string + example: Failure + inputlimitexceeded: + type: object + properties: + message: + type: string + example: Input Limit Exceeded + status: + type: string + example: Failure + invalidinput: + type: object + properties: + message: + type: string + example: Invalid Input + status: + type: string + example: Failure + versions: + type: object + properties: + v0.1.0: + type: array + items: + oneOf: + - type: string + example: Published Date - Mar 24, 2020 + description: Initial version release + securitySchemes: + APIAuthorizer: + type: apiKey + name: x-api-key + in: header + x-amazon-apigateway-authtype: custom + description: Authentication is done using the x-api-key in the request header. diff --git a/data/amenities_shelters_hdb_sg.yaml b/data/amenities_shelters_hdb_sg.yaml new file mode 100644 index 000000000..db33f0c34 --- /dev/null +++ b/data/amenities_shelters_hdb_sg.yaml @@ -0,0 +1,241 @@ +openapi: 3.0.1 +info: + title: HDB Shelters Locations (SG) + x-subscribelink: amenities_shelters_hdb_sg + description: |+ + This Data microservice returns the indicative outline of shelters for all HDB Towns and Estates and only on HDB Land. The features were identified visually from high definition ortho-rectified aerial imagery and manually digitised. The imagery was obtained from SLA (captured in 2014). Objects largely obstructed by trees, structures and / or shadow are likely not captured in this dataset. The outlines of partially obstructed objects were extrapolated where possible and may not fully represent the actual shape of the actual object. Precinct Pavilions are not included in this microservice. + As this is a dataset download microservice, a successful call will return a pre-signed URL where the entire dataset can be downloaded as a CSV file. + The HDB POTH programme makes selected public and non-public datasets available to developers and companies to improve their service offerings to benefit the lives of Singapore citizens. Sentient.io is proud to partner with HDB to manage and facilitate the sharing of data for the POTH Programme. + x-additionalinfo: |+ + Suggested Use Cases: + - Real estate services - can be used as a solution to extract information related to the types and number of shelters present for people buying or renting a HDB home. + + - Property background checks - can be used as a background check service for retail shops owners looking to set up their shops in HDBs, as areas with shelters may induce the likelihood of more customers. + + - Can also be used as a solution to improve user awareness and personalization - for example, a weather app can refer a user to the nearest HDB shelter in the case of a rainy day. + + Download the complete dataset using a pre-signed URL. It's a two steps process + + **Step 1:** Get the pre-signed URL + + Replace the correct x-api-key, and API endpoint + + > **curl -X GET -H "Content-Type: application/json" -H "x-api-key:XXXXX" <\>** + + **Step 2:** Download file + + Using the results.url (i.e) the pre-signed URL to download the dataset + + > **curl --request GET "results.url" >> "FILE_NAME"** + + **Data schema** + + | Name | Type | Size | Description | + |---|---|---|---|---| + | FEATID | Integer | N/A | Feature ID. Unique running number. | + | TYPE | Char | N/A | Captures the type of object. | + | LVL | Char | N/A | Captures whether the object is located at Ground level or Above Ground level. | + | QUALITY | Char | N/A | Captures whether the section of the feature was Fully Visible or Partially Visible. | + | INC_CRC | Varchar | 50 | Sub Location Id | + | FMEL_UPD_D | Datetime | N/A | Area of the feature | + | Shape__Area | Float | N/A | Area of the feature | + | Shape__Length | Float | N/A | Length of the feature | + version: '0.1.0' +servers: + - url: 'https://api.sentient.io' +tags: +- name: "v0.1.0" + description: "Published Date - Mar 24, 2020" +paths: + /DaaS/prod/hdb/amenities/gs/csv/shelter/hdb: + get: + tags: + - v0.1.0 + responses: + '200': + description: success response + content: + application/json: + schema: + $ref: '#/components/schemas/success' + example: + results: + url: "" + status: Success + message: Successfully Processed + '401': + description: Unauthorized + content: + application/json: + schema: + $ref: '#/components/schemas/unauthorized' + '402': + description: Payment Required + content: + application/json: + schema: + $ref: '#/components/schemas/paymentrequired' + '403': + description: Forbidden + content: + application/json: + schema: + $ref: '#/components/schemas/forbidden' + '404': + description: Not Found + content: + application/json: + schema: + $ref: '#/components/schemas/notfound' + '419': + description: Input Field Missing + content: + application/json: + schema: + $ref: '#/components/schemas/inputfieldmissing' + '413': + description: Input Limit Exceeded + content: + application/json: + schema: + $ref: '#/components/schemas/inputlimitexceeded' + '415': + description: Invalid Input + content: + application/json: + schema: + $ref: '#/components/schemas/invalidinput' + '500': + description: Internal Server Error + content: + application/json: + schema: + $ref: '#/components/schemas/servererror' + '504': + description: Gateway Timeout + content: + application/json: + schema: + $ref: '#/components/schemas/gatewaytimeout' + security: + - APIAuthorizer: [] +components: + schemas: + success: + type: object + properties: + results: + type: object + example: { "" } + description: Json Object of returned results + properties: + url: + type: string + description: pre-signed URL to download the file + example: "" + status: + type: string + example: Success + description: The status of the API call. success/failure + message: + type: string + example: Successfully Processed + description: Detail description on the api status + unauthorized: + type: object + properties: + message: + type: string + example: Missing Authentication Token + status: + type: string + example: Failure + forbidden: + type: object + properties: + message: + type: string + example: Access Denied Unauthorized User + status: + type: string + example: Failure + paymentrequired: + type: object + properties: + message: + type: string + example: Insufficient Credits Kindly Top Up + status: + type: string + example: Failure + notfound: + type: object + properties: + message: + type: string + example: Invalid Request URL + status: + type: string + example: Failure + servererror: + type: object + properties: + message: + type: string + example: Internal Server Error + status: + type: string + example: Failure + gatewaytimeout: + type: object + properties: + message: + type: string + example: Request Timeout + status: + type: string + example: Failure + inputfieldmissing: + type: object + properties: + message: + type: string + example: Input Field Missing + status: + type: string + example: Failure + inputlimitexceeded: + type: object + properties: + message: + type: string + example: Input Limit Exceeded + status: + type: string + example: Failure + invalidinput: + type: object + properties: + message: + type: string + example: Invalid Input + status: + type: string + example: Failure + versions: + type: object + properties: + v0.1.0: + type: array + items: + oneOf: + - type: string + example: Published Date - Mar 24, 2020 + description: Initial version release + securitySchemes: + APIAuthorizer: + type: apiKey + name: x-api-key + in: header + x-amazon-apigateway-authtype: custom + description: Authentication is done using the x-api-key in the request header. diff --git a/data/building_addresses_hdb_sg.yaml b/data/building_addresses_hdb_sg.yaml new file mode 100644 index 000000000..78aeb1ee9 --- /dev/null +++ b/data/building_addresses_hdb_sg.yaml @@ -0,0 +1,415 @@ +openapi: 3.0.1 +info: + title: HDB Block Coordinates (SG) + x-subscribelink: building_addresses_hdb_sg + description: |+ + This Data microservice retrieves information on the Singapore Housing Development Board building blocks in Singapore that includes addresses, postal code, latitude and longitude coordinates. Updated monthly + + The HDB POTH programme makes selected public and non-public datasets available to developers and companies to improve their service offerings to benefit the lives of Singapore citizens. Sentient.io is proud to partner with HDB to manage and facilitate the sharing of data for the POTH Programme. + + **Note:** As this microservice uses the GET method, developers using this microservice must remember to have their app encode all the input values to be URL friendly (i.e. all spaces and special characters must be replaced). Here’s a reference on [URL encoding](https://www.w3schools.com/tags/ref_urlencode.ASP). + + x-additionalinfo : |+ + Suggested Use Cases: + - Information from this microservice can be used to build a geo-targeting app with precise map features. + + **Refining queries in the filterdata field using filter types and match types** + + The filterdata fields use elasticsearch’s syntax (specifically filter types and match types) to help further refine search results and provide greater flexibility in structuring more sophisticated queries. + + **Filter Types:** + + A filter type is a logic operator to which the search results must fulfill certain logical conditions to be returned. The supported match types are: + + * **must** - All of the stated conditions must match. Equivalent to an AND operator. + + > {"must":[{"range":{"block":{"gte":100}}}]} + + * **must_not** - All of the stated conditions must not match. Equivalent to a NOT operator. + > {"must_not":[{"match":{"street":"avenue 3"}}]} + + * **should** - At least one of the stated conditions should match. Equivalent to an OR operator. + > {"should":[{"range":{"block":{"lte":200}}}]} + + * **filter** - All of the stated conditions that must match. However, results are not scored unlike the other filter types which returns results based on how well the conditions are met. + > {"filter":[{"match_phrase":{"street":"ang mo kio"}}]} + + For a more detailed guide on filter types, [refer to this](https://www.elastic.co/guide/en/elasticsearch/reference/6.8/query-dsl-bool-query.html). + + Filter types cannot be used alone and must be used in conjunction with a match type to complete the query. + + **Match Types:** + + A match type is a match operator nested within a filter type that fine-tunes the matching condition of the text search. The supported match types are: + + * **match** - Search within a full text field for a single word + + > {"match":{"street":"serangoon"}} + + * **match_phrase** - Search within a full text field + + > {"match_phrase":{"street":"ang mo kio street"}} + + * **match_phrase_prefix** - Search within a full text field with prefix + + > {"match_phrase_prefix":{"street":"ang mo kio"}} + + * **term** - Returns results that contain an exact term in a provided field + + > {"term":{"postalcode":"550151"}} + + * **terms** - Returns results that contain one or more exact terms in a provided field + + > {"terms":{"postalcode":["550151","550152"]}} + + * **range** - Returns results that contain terms within a stipulated range + > {"range":{"postalcode":{"lte":650347}}} + > {"range":{"postalcode":{"gte":650347}}} + > {"range":{"postalcode":{"gte":650347,"lte":760415}}} + + * **exists** - Returns results that contain any indexed value for a field + > {"exists":{ "field": "postalcode"}} + + For a more detailed guide to match types, [refer to this](https://www.elastic.co/guide/en/elasticsearch/reference/7.9/term-level-queries.html). + + **Forming sophisticated queries using combinations of filter types (in JSON)** + + Multiple filter types can be combined together in one query (written in JSON format) to form a very sophisticated query. Here’s one example below: + + > { + > "must":[{"range":{"block":{"gte":100}}}], + > "should":[{"range":{"block":{"lte":200}}}], + > "filter":[{"match_phrase":{"street":"ang mo kio"}}], + > "must_not":[{"match":{"street":"avenue 3"}}] + > } + + + **Sample Queries Based on Use Cases** + 1. **Search the latitude and longitude coordinates for 442 Pasir Ris Drive 6** + + Using a filterdata only: + > filterdata = {"filter":[{"geo_distance": {"distance": "1km","location": "1.368960,103.957980"}}]} + + version: '0.1.0' +servers: + - url: 'https://api.sentient.io' +tags: +- name: "v0.1.0" + description: "Published Date - Nov 25, 2019" +paths: + /DaaS/prod/directories/searchbranch: + get: + tags: + - v0.1.0 + parameters: + - in: query + name: querystring + schema: + type: string + description: |+ + Simple keyword search for matches in all searchable fields. Keywords separated by spaces will return results containing any of those keywords. For exact phrase match, put entire phrase in double quotes (" "). + + If this field is set to null, by default the microservice will return all buildings (within the stated limit), which can be further refined through the filterdata field for more sophisticated queries. + + example: "serangoon" + default: false + - in: query + name: offset + schema: + type: integer + description: The offset of the record list ie the starting index + example: "0" + default: false + - in: query + name: limit + schema: + type: integer + description: The max records to return for the request. Default - 10, Max - 10000 + example: "10" + default: false + - in: query + name: filterdata + schema: + type: string + description: |+ + Refine the search further on any of the possible through the 4 filter types : + * must + * must_not + * should + * filter + default: false + example: |+ + {"must":[{"range":{"block":{"gte":100}}}],"should":[{"range":{"block":{"lte":200}}}],"filter":[{"match_phrase":{"street":"ang mo kio"}}],"must_not":[{"match":{"street":"avenue 3"}}]} + responses: + '200': + description: success response + content: + application/json: + schema: + $ref: '#/components/schemas/success' + example: + results: + total: 1 + max_score: 12.08503 + hits: + - _index: sentient_directory_building_index + _type: dir_doc + _id: uLxcqWgBv3dNEHq2Dznn + _score: 12.08503 + _source: + buildingname: nex + postalcode: '556083' + block: '23' + street: serangoon central + location: + lat: 1.350748 + lon: 103.872798 + source: starhub + createddate: '2019-02-01' + message: Successfully Processed + status: Success + '401': + description: Unauthorized + content: + application/json: + schema: + $ref: '#/components/schemas/unauthorized' + '402': + description: Payment Required + content: + application/json: + schema: + $ref: '#/components/schemas/paymentrequired' + '403': + description: Forbidden + content: + application/json: + schema: + $ref: '#/components/schemas/forbidden' + '404': + description: Not Found + content: + application/json: + schema: + $ref: '#/components/schemas/notfound' + '419': + description: Input Field Missing + content: + application/json: + schema: + $ref: '#/components/schemas/inputfieldmissing' + '413': + description: Input Limit Exceeded + content: + application/json: + schema: + $ref: '#/components/schemas/inputlimitexceeded' + '415': + description: Invalid Input + content: + application/json: + schema: + $ref: '#/components/schemas/invalidinput' + '500': + description: Internal Server Error + content: + application/json: + schema: + $ref: '#/components/schemas/servererror' + '504': + description: Gateway Timeout + content: + application/json: + schema: + $ref: '#/components/schemas/gatewaytimeout' + security: + - APIAuthorizer: [] +components: + schemas: + success: + type: object + properties: + results: + type: object + example: {} + description: Json Object of returned results + properties: + total: + type: number + example: 1 + description: Total number of records + max_score: + type: number + example: 17.995623 + description: The highest score value + hits: + type: array + example: [{} + description: Json Object of returned hits + properties: + buildingname: + type: string + description: Building Name + example: "nex" + street: + type: string + description: Street Name of Building + example: "serangoon central" + postalcode: + type: string + description: Postal code + example: "556083" + block: + type: string + description: Block Number + example: "23" + location: + type: object + description: WGS84 coordinates lat/long + example: {"lat":1.350748,"lon":103.872798} + properties: + lat: + type: string + description: WGS84 latitude + example: 1.350748 + lon: + type: string + description: WGS84 longitude + example: 103.872798 + source: + type: string + description: Dataset source + example: "hdb" + createddate: + type: string + description: Record first released date on Sentient.io + example: "2019-02-01" + message: + type: string + example: Successfully Processed + description: The detail description on the status + status: + type: string + example: Success + description: The status of the API call Success/Failure + unauthorized: + type: object + properties: + message: + type: string + example: Missing Authentication Token + status: + type: string + example: Failure + forbidden: + type: object + properties: + message: + type: string + example: Access Denied Unauthorized User + status: + type: string + example: Failure + paymentrequired: + type: object + properties: + message: + type: string + example: Insufficient Credits Kindly Top Up + status: + type: string + example: Failure + notfound: + type: object + properties: + message: + type: string + example: Invalid Request URL + status: + type: string + example: Failure + servererror: + type: object + properties: + message: + type: string + example: Internal Server Error + status: + type: string + example: Failure + gatewaytimeout: + type: object + properties: + message: + type: string + example: Request Timeout + status: + type: string + example: Failure + inputfieldmissing: + type: object + properties: + message: + type: string + example: Input Field Missing + status: + type: string + example: Failure + inputlimitexceeded: + type: object + properties: + message: + type: string + example: Input Limit Exceeded + status: + type: string + example: Failure + invalidinput: + type: object + properties: + message: + type: string + example: Invalid Input + status: + type: string + example: Failure + versions: + type: object + properties: + v0.1.0: + type: array + items: + oneOf: + - type: string + example: Published Date - Nov 25,2019 + description: Initial version release + securitySchemes: + APIAuthorizer: + type: apiKey + name: x-api-key + in: header + x-amazon-apigateway-authtype: custom + description: Authentication is done using the x-api-key in the request header. diff --git a/data/carpark_hdb_sg.yaml b/data/carpark_hdb_sg.yaml new file mode 100644 index 000000000..e3f0a2708 --- /dev/null +++ b/data/carpark_hdb_sg.yaml @@ -0,0 +1,506 @@ +openapi: 3.0.1 +info: + title: HDB Carpark Locations (SG) + x-subscribelink: carpark_hdb_sg + description: |+ + This Data microservice retrieves the Singapore Housing Development Board's carpark information within Singapore HDB estates and includes the location address, postal code and parking lot capacity for different types of vehicle by carpark location. Updated monthly. + + The HDB POTH programme makes selected public and non-public datasets available to developers and companies to improve their service offerings to benefit the lives of Singapore citizens. Sentient.io is proud to partner with HDB to manage and facilitate the sharing of data for the POTH Programme. + + **Note:** As this microservice uses the GET method, developers using this microservice must remember to have their app encode all the input values to be URL friendly (i.e. all spaces and special characters must be replaced). Here’s a reference on [URL encoding](https://www.w3schools.com/tags/ref_urlencode.ASP). + + x-additionalinfo : |+ + Suggested Use Cases: + - Geo-targeting app with map feature, property development planning resource, or planning for vehicle-sharing app. + + - Real estate services - can be used as a background check solution to extract information related to the types and number of carparks present in an area for people with certain preferences when buying or renting a HDB home. + + - Can also be integrated into apps related to maps or parking for more detailed carpark information within Singapore HDB estates + + **Refining queries in the filterdata field using filter types and match types** + + The filterdata fields use elasticsearch’s syntax (specifically filter types and match types) to help further refine search results and provide greater flexibility in structuring more sophisticated queries. + + **Filter Types:** + + A filter type is a logic operator to which the search results must fulfill certain logical conditions to be returned. The supported match types are: + + * **must** - All of the stated conditions must match. Equivalent to an AND operator. + + > {"must":[{"match":{"mc":0}}]} + + * **must_not** - All of the stated conditions must not match. Equivalent to a NOT operator. + + > {"must_not":[{"match":{"postalcode":"570251"}}]} + + * **should** - At least one of the stated conditions should match. Equivalent to an OR operator. + + > {"should":[{"match_phrase":{"street":"ang mo kio"}}]} + + * **filter** - All of the stated conditions that must match. However, results are not scored unlike the other filter types which returns results based on how well the conditions are met. + + > {"filter":[{"match":{"street":"bishan"}}]} + + For a more detailed guide on filter types, [refer to this](https://www.elastic.co/guide/en/elasticsearch/reference/6.8/query-dsl-bool-query.html). + + Filter types cannot be used alone and must be used in conjunction with a match type to complete the query. + + **Match Types:** + + A match type is a match operator nested within a filter type that fine-tunes the matching condition of the text search. The supported match types are: + + * **match** - Search within a full text field for a single word + + > {"match":{"street":"bishan"}} + + * **match_phrase** - Search within a full text field + + > {"match_phrase":{"street":"bishan street 24"}} + + * **match_phrase_prefix** - Search within a full text field with prefix + + > {"match_phrase_prefix":{"street":"bishan street 24"}} + + * **term** - Returns results that contain an exact term in a provided field + + > {"term":{"cpk_no":"ak19"}} + + * **terms** - Returns results that contain one or more exact terms in a provided field + + > {"terms":{"cpk_no":["ak19","be33"]}} + + * **range** - Returns results that contain terms within a stipulated range + + > {"range":{"car":{"gte":100}}} + > {"range":{"car":{"lte":500}}} + > {"range":{"car":{"gte":100,"lte":500}}} + + * **exists** - Returns results that contain any indexed value for a field + + > {"exists":{ "field": "postalcode"}} + + For a more detailed guide to match types, [refer to this](https://www.elastic.co/guide/en/elasticsearch/reference/7.9/term-level-queries.html). + + **Forming sophisticated queries using combinations of filter types (in JSON)** + + Multiple filter types can be combined together in one query (written in JSON format) to form a very sophisticated query. Here’s one example below: + + > { + > "must":[{"match":{"mc":0}}], + > "filter":[{"match":{"street":"bishan"}}], + > "should":[{"match_phrase":{"street":"ang mo kio"}}], + > "must_not":[{"match":{"postalcode":"570251"}}] + > } + + **Sample Queries Based on Use Cases** + + 1. **Search for all carparks around 414 Bedok North Road** + + Using a querystring only: + + > querystring = "414 bedok north road" + + 2. **Search for all carparks within a 1KM radius from Tampines Mall** + + Using a filterdata only: + + > filterdata = {"filter":[{"geo_distance": {"distance": "1km","location": "1.3525,103.9447"}}]} + + 3. **Search for all carparks around Tampines with motorcycle parking** + + Using both querystring + filterdata: + + > querystring = tampines + > filterdata = {"filter":[ {"range":{"mc":{"gte":1}}} ]} + + 4. **Search for all lorry parking lots for Bishan Street 22** + + Using both querystring + filterdata: + + > querystring = "bishan street 22" + > filterdata = {"filter":[ {"range":{"lorry":{"gte":1}}} ]} + + version: '0.2.0' +servers: + - url: 'https://api.sentient.io' +tags: +- name: "v0.2.0" + description: "Published Date - Sep 15, 2020" +paths: + /DaaS/prod/hdb/carpark: + get: + tags: + - v0.2.0 + parameters: + - in: query + name: querystring + schema: + type: string + description: |+ + Simple keyword search for matches in all searchable fields. Keywords separated by spaces will return results containing any of those keywords. For exact phrase match, put entire phrase in double quotes (" "). + + If this field is set to null, by default the microservice will return all carparks (within the stated limit), which can be further refined through the filterdata field for more sophisticated queries. + + example: BE33 + default: false + - in: query + name: offset + schema: + type: integer + description: The offset of the record list ie the starting index + example: "0" + default: false + - in: query + name: limit + schema: + type: integer + description: The max records to return for the request. Default - 10, Max - 10000 + example: "10" + default: false + - in: query + name: filterdata + schema: + type: string + description: |+ + Refine the search further on any of the possible through the 4 filter types : + + * must + * must_not + * should + * filter + + default: false + example: |+ + {"must":[{"match":{"mc":0}}],"filter":[{"match":{"street":"bishan"}}],"should":[{"match_phrase":{"street":"ang mo kio"}}],"must_not":[{"match":{"postalcode":"570251"}}]} + responses: + '200': + description: success response + content: + application/json: + schema: + $ref: '#/components/schemas/success' + example: + results: + total: 1 + max_score: 7.510164 + hits: + - _index: sentient_carpark_hdb_index + _type: dir_doc + _id: BE37 + _score: 7.510164 + _source: + cpk_no: BE37 + block: BLK 282 + street: BISHAN STREET 22 + address: BLK 282 BISHAN STREET 22 + source: hdb + xcoord: '29235.553' + ycoord: '37787.1371' + car: 402 + lorry: 40 + mc: 0 + createddate: '2020-09-11' + lastupdated: '2020-09-11' + location: + lat: 1.3580079412271227 + lon: 103.84442083770412 + postalcode: + - '570278' + - '570279' + - '570280' + - '570281' + - '570282' + - '570283' + - '570284' + - '570285' + - '570286' + - '570287' + message: Successfully Processed + status: Success + '401': + description: Unauthorized + content: + application/json: + schema: + $ref: '#/components/schemas/unauthorized' + '402': + description: Payment Required + content: + application/json: + schema: + $ref: '#/components/schemas/paymentrequired' + '403': + description: Forbidden + content: + application/json: + schema: + $ref: '#/components/schemas/forbidden' + '404': + description: Not Found + content: + application/json: + schema: + $ref: '#/components/schemas/notfound' + '419': + description: Input Field Missing + content: + application/json: + schema: + $ref: '#/components/schemas/inputfieldmissing' + '413': + description: Input Limit Exceeded + content: + application/json: + schema: + $ref: '#/components/schemas/inputlimitexceeded' + '415': + description: Invalid Input + content: + application/json: + schema: + $ref: '#/components/schemas/invalidinput' + '500': + description: Internal Server Error + content: + application/json: + schema: + $ref: '#/components/schemas/servererror' + '504': + description: Gateway Timeout + content: + application/json: + schema: + $ref: '#/components/schemas/gatewaytimeout' + security: + - APIAuthorizer: [] +components: + schemas: + success: + type: object + properties: + results: + type: object + example: {} + description: Json Object of returned results + properties: + total: + type: number + example: 986 + description: Total number of records + max_score: + type: number + example: 17.995623 + description: The highest score value + hits: + type: array + example: [{} + description: Json Object of returned hits + properties: + cpk_no: + type: string + description: Carpark Number + example: AK19 + block: + type: string + description: Address block no + example: "BLOCK 253" + street: + type: string + description: Address street or building name + example: "ANG MO KIO STREET 21" + address: + type: string + description: Address full address + example: "BLOCK 253 ANG MO KIO STREET 21" + source: + type: string + description: Dataset source + example: "hdb" + postalcode: + type: array + description: List of postal code + example: ["570253", "570254"] + items: + type: string + description: postal code + example: "570253" + xcoord: + type: string + description: SVY21 X coordinates (Note, SVY21 is a localised plane coordinate system used specifically by Singapore. For global GPS lat/long coordinates, refer to "location" object) + example: 28185.4359 + ycoord: + type: string + description: SVY21 Y coordinates (Note, SVY21 is a localised plane coordinate system used specifically by Singapore. For global GPS lat/long coordinates, refer to "location" object) + example: 39012.6664 + location: + type: object + description: WGS84 (World Geodetic System) lat/long coordinates. This is the standard coordinate system used Global Positioning System (GPS). + example: {"lat":1.364299477060462,"lon":103.8350609414261} + properties: + lat: + type: string + description: WGS84 (GPS) latitude + example: 1.37179535 + lon: + type: string + description: WGS84 (GPS) longitude + example: 103.8469821 + car: + type: number + description: Number of car parking lots + example: 18 + lorry: + type: number + description: Number of lorry parking lots + example: 6 + mc: + type: number + description: Number of motorcycle parking lots + example: 0 + createddate: + type: string + description: Record first release date on sentient + example: "2019-10-17" + lastupdated: + type: string + description: Record last updated date on sentient + example: "2019-10-17" + message: + type: string + example: Successfully Processed + description: The detail description on the status + status: + type: string + example: Success + description: The status of the API call Success/Failure + unauthorized: + type: object + properties: + message: + type: string + example: Missing Authentication Token + status: + type: string + example: Failure + forbidden: + type: object + properties: + message: + type: string + example: Access Denied Unauthorized User + status: + type: string + example: Failure + paymentrequired: + type: object + properties: + message: + type: string + example: Insufficient Credits Kindly Top Up + status: + type: string + example: Failure + notfound: + type: object + properties: + message: + type: string + example: Invalid Request URL + status: + type: string + example: Failure + servererror: + type: object + properties: + message: + type: string + example: Internal Server Error + status: + type: string + example: Failure + gatewaytimeout: + type: object + properties: + message: + type: string + example: Request Timeout + status: + type: string + example: Failure + inputfieldmissing: + type: object + properties: + message: + type: string + example: Input Field Missing + status: + type: string + example: Failure + inputlimitexceeded: + type: object + properties: + message: + type: string + example: Input Limit Exceeded + status: + type: string + example: Failure + invalidinput: + type: object + properties: + message: + type: string + example: Invalid Input + status: + type: string + example: Failure + versions: + type: object + properties: + v0.2.0: + type: array + items: + oneOf: + - type: string + example: Published Date - Sep 15,2020 + description: |+ + The following additional fields are added: + 1. postalcode - list of postal code + 2. location - lat / log of the carpark park + v0.1.0: + type: array + items: + oneOf: + - type: string + example: Published Date - Nov 25,2019 + description: Initial version release + securitySchemes: + APIAuthorizer: + type: apiKey + name: x-api-key + in: header + x-amazon-apigateway-authtype: custom + description: Authentication is done using the x-api-key in the request header. diff --git a/data/commercial_directories_hdb_sg.yaml b/data/commercial_directories_hdb_sg.yaml new file mode 100644 index 000000000..8de02e396 --- /dev/null +++ b/data/commercial_directories_hdb_sg.yaml @@ -0,0 +1,520 @@ +openapi: 3.0.1 +info: + title: HDB Commercial Directories (SG) + x-subscribelink: commercial_directories_hdb_sg + description: |+ + This Data microservice retrieves the list of all retail shops within Singapore HDBs and allows you to search for a shop by its name, address, building name, postal code, latitude and longitude coordinates type of business. The resultant dataset offers useful information like the shop operating hours and contact number. Updated weekly. + + The HDB POTH programme makes selected public and non-public datasets available to developers and companies to improve their service offerings to benefit the lives of Singapore citizens. Sentient.io is proud to partner with HDB to manage and facilitate the sharing of data for the POTH Programme. + + **Note:** As this microservice uses the GET method, developers using this microservice must remember to have their app encode all the input values to be URL friendly (i.e. all spaces and special characters must be replaced). Here’s a reference on [URL encoding](https://www.w3schools.com/tags/ref_urlencode.ASP). + + x-additionalinfo : |+ + Suggested Use Cases: + - Build a resident community mobile app with e-commerce collection and estate directory features. To illustrate, the app can: + Name retail shops in HDBs based on their GPS location. + + **Refining queries in the filterdata field using filter types and match types** + + The filterdata fields use elasticsearch’s syntax (specifically filter types and match types) to help further refine search results and provide greater flexibility in structuring more sophisticated queries. + + **Filter Types:** + + A filter type is a logic operator to which the search results must fulfill certain logical conditions to be returned. The supported match types are: + + * **must** - All of the stated conditions must match. Equivalent to an AND operator. + + > {"must":[{"match_phrase":{"name":"ang mo kio"}}]} + + * **must_not** - All of the stated conditions must not match. Equivalent to a NOT operator. + + > {"must_not":[{"match":{"trade":"shop"}}]} + + * **should** - At least one of the stated conditions should match. Equivalent to an OR operator. + + > {"should":[{"match":{"postalcode":"650633"}}]} + + * **filter** - All of the stated conditions that must match. However, results are not scored unlike the other filter types which returns results based on how well the conditions are met. + + > {"filter":[{"match":{"trade":"retail"}}]} + + For a more detailed guide on filter types, [refer to this](https://www.elastic.co/guide/en/elasticsearch/reference/6.8/query-dsl-bool-query.html). + + Filter types cannot be used alone and must be used in conjunction with a match type to complete the query. + + **Match Types:** + + A match type is a match operator nested within a filter type that fine-tunes the matching condition of the text search. The supported match types are: + + * **match** - Search within a full text field for a single word + + > {"match":{"street":"bishan"}} + + * **match_phrase** - Search within a full text field + + > {"match_phrase":{ "street":bishan street 24"}} + + * **match_phrase_prefix** - Search within a full text field with prefix + + > {"match_phrase_prefix":{"street":"bishan street"}} + + * **term** - Returns results that contain an exact term in a provided field + + > {"term":{"postalcode":"560720"}} + + * **terms** - Returns results that contain one or more exact terms in a provided field + + > {"terms":{"postalcode":["560720","560721"]}} + + * **range** - Returns results that contain terms within a stipulated range + + > {"range":{"postalcode":{"lte":650347}}} + > {"range":{"postalcode":{"gte":650347}}} + > {"range":{"postalcode":{"gte":650347,"lte":760415}}} + + * **exists** - Returns results that contain any indexed value for a field + + > {"exists":{ "field": "postalcode"}} + + For a more detailed guide to match types, [refer to this](https://www.elastic.co/guide/en/elasticsearch/reference/7.9/term-level-queries.html). + + **Forming sophisticated queries using combinations of filter types (in JSON)** + + Multiple filter types can be combined together in one query (written in JSON format) to form a very sophisticated query. Here’s one example below: + + > { + > "must":[{"match_phrase":{"street":"ang mo kio avenue 6"}}], + > "filter":[{"match":{"trade":"shop"}}], + > "should":[{"match":{"postalcode":"650633"}}], + > "must_not":[{"match":{"trade":"betting"}}] + > } + + **Sample Queries Based on Use Cases** + + 1. **Search for all commercial directories around ang mo kio street 21** + + Using a querystring only: + + > querystring = "ang mo kio street 21" + + 2. **Search for all commercial directories within a 1KM radius from Tampines Mall** + + Using a filterdata only: + + > filterdata = {"filter":[{"geo_distance": {"distance": "1km","location": "1.3525,103.9447"}}]} + + 3. **Search for all cake shop shops at Blk 122, Bukit Merah Lane 1** + + Using a filterdata only: + + > filterdata = {"filter":[{"match_phrase": {"trade":"cake shop"}},{"match": {"block":"122"}},{"match_phrase": {"street":"bukit merah lane 1"}}]} + + version: '0.1.0' +servers: + - url: 'https://api.sentient.io' +tags: +- name: "v0.1.0" + description: "Published Date - Dec 26, 2018" +paths: + /DaaS/prod/directories/hdb/searchdir: + get: + tags: + - v0.1.0 + parameters: + - in: query + name: querystring + schema: + type: string + description: |+ + Simple keyword search for matches in all searchable fields. Keywords separated by spaces will return results containing any of those keywords. For exact phrase match, put entire phrase in double quotes (" "). + + If this field is set to null, by default the microservice will return all retail shops (within the stated limit), which can be further refined through the filterdata field for more sophisticated queries. + + example: "retail" + default: false + - in: query + name: offset + schema: + type: integer + description: The offset of the record list ie the starting index + example: "0" + default: false + - in: query + name: limit + schema: + type: integer + description: The max records to return for the request. Default - 10, Max - 10000 + example: "10" + default: false + - in: query + name: filterdata + schema: + type: string + description: |+ + Refine the search further on any of the possible through the 4 filter types : + * must + * must_not + * should + * filter + default: false + example: |+ + {"must":[{"match_phrase":{"street":"ang mo kio avenue 6"}}],"filter":[{"match":{"trade":"shop"}}],"should":[{"match":{"postalcode":"650633"}}],"must_not":[{"match":{"trade":"betting"}}]} + + responses: + '200': + description: success response + content: + application/json: + schema: + $ref: '#/components/schemas/success' + example: + results: + total: 3735 + max_score: 17.995623 + hits: + - _index: sentient_directory_hdb_index + _type: dir_doc + _id: K7scqWgBv3dNEHq2WvMo + _score: 17.995623 + _source: + id: '201902011250341437360' + postalcode: '560720' + unit: '4102' + level: '01' + source: hdb + name: Ang Mo Kio Polyclinic + phonenumber: '63553000' + email: '' + operatinghours: mon - fri 8am - 4.30pm sat 8am - 12.30pm + trade: shop/retail + createddate: '2019-02-01' + type: shop + block: '720' + street: ang mo kio avenue 6 + xcoord: 29520.58 + ycoord: 39311.68 + location: + lat: 1.37179535 + lon: 103.8469821 + message: Successfully Processed + status: Success + '401': + description: Unauthorized + content: + application/json: + schema: + $ref: '#/components/schemas/unauthorized' + '402': + description: Payment Required + content: + application/json: + schema: + $ref: '#/components/schemas/paymentrequired' + '403': + description: Forbidden + content: + application/json: + schema: + $ref: '#/components/schemas/forbidden' + '404': + description: Not Found + content: + application/json: + schema: + $ref: '#/components/schemas/notfound' + '419': + description: Input Field Missing + content: + application/json: + schema: + $ref: '#/components/schemas/inputfieldmissing' + '413': + description: Input Limit Exceeded + content: + application/json: + schema: + $ref: '#/components/schemas/inputlimitexceeded' + '415': + description: Invalid Input + content: + application/json: + schema: + $ref: '#/components/schemas/invalidinput' + '500': + description: Internal Server Error + content: + application/json: + schema: + $ref: '#/components/schemas/servererror' + '504': + description: Gateway Timeout + content: + application/json: + schema: + $ref: '#/components/schemas/gatewaytimeout' + security: + - APIAuthorizer: [] +components: + schemas: + success: + type: object + properties: + results: + type: object + example: {} + description: Json Object of returned results + properties: + total: + type: number + example: 986 + description: Total number of records + max_score: + type: number + example: 17.995623 + description: The highest score value + hits: + type: array + example: [{} + description: Json Object of returned hits + properties: + id: + type: string + description: Unique Id + example: "201902011250341437360" + postalcode: + type: string + description: Postal code of a block + example: "560720" + unit: + type: string + description: Unit number + example: "4102" + level: + type: string + description: Floor level + example: "01" + source: + type: string + description: Dataset source + example: "hdb" + name: + type: string + description: Business name + example: "Ang Mo Kio Polyclinic" + phonenumber: + type: string + description: Contact number + example: "63553000" + email: + type: string + description: Email address + example: "amk128@renalteam.org" + operatinghours: + type: string + description: Business operating hours. Multiple values are separated using ‘;’ + example: "mon - fri 8am - 4.30pm sat 8am - 12.30pm" + trade: + type: string + description: |+ + Business trade type. Trade List are: + commercial school + shop/retail + childcare centre + confectionery + office + betting + eating house/fast food restaurant/food court + family restaurant + health centre and amusement ctr + laundry shop + showroom + pet shop + social com + supermarket + specific use + health & fitness + home + fashion & accessories + groceries + schools & centres + business + pets + dining + food products + beauty + cake shop + shopping + finance + entertainment & leisure + hobbies & interests + travel and tourism + light industrial + sports and recreation building + others + example: "shop/retail" + createddate: + type: string + description: Record created date + example: "2019-02-01" + type: + type: string + description: Record type + example: "shop" + block: + type: string + description: Block number + example: "720" + street: + type: string + description: Full street name + example: "ang mo kio avenue 6" + xcoord: + type: string + description: SVY21 X coordinates + example: 29520.58 + ycoord: + type: string + description: SVY21 Y coordinates + example: 39311.68 + location: + type: object + description: WGS84 coordinates lat/long + example: {"lat":1.364299477060462,"lon":103.8350609414261} + properties: + lat: + type: string + description: WGS84 latitude + example: 1.37179535 + lon: + type: string + description: WGS84 longitude + example: 103.8469821 + message: + type: string + example: Successfully Processed + description: The detail description on the status + status: + type: string + example: Success + description: The status of the API call Success/Failure + unauthorized: + type: object + properties: + message: + type: string + example: Missing Authentication Token + status: + type: string + example: Failure + forbidden: + type: object + properties: + message: + type: string + example: Access Denied Unauthorized User + status: + type: string + example: Failure + paymentrequired: + type: object + properties: + message: + type: string + example: Insufficient Credits Kindly Top Up + status: + type: string + example: Failure + notfound: + type: object + properties: + message: + type: string + example: Invalid Request URL + status: + type: string + example: Failure + servererror: + type: object + properties: + message: + type: string + example: Internal Server Error + status: + type: string + example: Failure + gatewaytimeout: + type: object + properties: + message: + type: string + example: Request Timeout + status: + type: string + example: Failure + inputfieldmissing: + type: object + properties: + message: + type: string + example: Input Field Missing + status: + type: string + example: Failure + inputlimitexceeded: + type: object + properties: + message: + type: string + example: Input Limit Exceeded + status: + type: string + example: Failure + invalidinput: + type: object + properties: + message: + type: string + example: Invalid Input + status: + type: string + example: Failure + versions: + type: object + properties: + v0.1.0: + type: array + items: + oneOf: + - type: string + example: Published Date - Dec 26,2018 + description: Initial version release + securitySchemes: + APIAuthorizer: + type: apiKey + name: x-api-key + in: header + x-amazon-apigateway-authtype: custom + description: Authentication is done using the x-api-key in the request header. diff --git a/data/d&b_basic_individual_search_sg.yaml b/data/d&b_basic_individual_search_sg.yaml new file mode 100644 index 000000000..768d48d54 --- /dev/null +++ b/data/d&b_basic_individual_search_sg.yaml @@ -0,0 +1,1307 @@ +openapi: 3.0.1 +info: + title: D&B Basic Individual Search (SG) + description: |+ + This Data microservice provides the information on the (Singapore-registered) business interest of an individual that includes the individual’s actual name, residential address, business and shareholding in businesses, current & previous ownership, litigation against individual and businesses, bankruptcy record and count on the times this individual has been searched on. Updated daily. + x-additionalinfo: |+ + Suggested Use Cases: + - Software solutions that require personal checks, e.g. in the appointment of Board Members, Directorship or C-suite level hiring, where the appointee’s background is paramount to the Company and its reputation. + + - Swift pre-employment screening solution - information provided by the microservice can be used to protect one's company's reputation from potential negative publicity by conducting background checks on individuals prior to hiring. + version: '0.1.0' + x-subscribelink: d&b_basic_individual_search_sg +servers: + - url: 'https://api.sentient.io' +tags: +- name: "v0.1.0" + description: "Published Date - Aug 15, 2019" +paths: + /dnb/prod/sbis: + post: + tags: + - v0.1.0 + summary: Adds a new user + requestBody: + content: + application/xml: + schema: + $ref: '#/components/schemas/REQUEST' + responses: + '200': + description: success response + content: + application/xml: + schema: + $ref: '#/components/schemas/success' + example: |+ + + 25/02/2009 17:31:44.678 + + + + + + 25/02/2009 17:31:44 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - - S7250163B + + + - - S7250163B + + + + + + 1 1 1 1 1 1 1 1 1 1 1 1 2017 1 + + 0 0 0 0 0 0 0 0 0 0 0 0 2016 1 + + 0 0 0 0 0 0 0 0 0 0 0 0 2015 1 + + 0 0 0 0 0 0 0 0 0 0 0 0 2017 0 + + 0 0 0 0 0 0 0 0 0 0 0 0 2016 0 + + 0 0 0 0 0 0 0 0 0 0 0 + 0 2015 0 + + + '401': + description: Unauthorized + content: + application/json: + schema: + $ref: '#/components/schemas/unauthorized' + '402': + description: Payment Required + content: + application/json: + schema: + $ref: '#/components/schemas/paymentrequired' + '403': + description: Forbidden + content: + application/json: + schema: + $ref: '#/components/schemas/forbidden' + '404': + description: Not Found + content: + application/json: + schema: + $ref: '#/components/schemas/notfound' + '419': + description: Input Field Missing + content: + application/json: + schema: + $ref: '#/components/schemas/inputfieldmissing' + '413': + description: Input Limit Exceeded + content: + application/json: + schema: + $ref: '#/components/schemas/inputlimitexceeded' + '415': + description: Invalid Input + content: + application/json: + schema: + $ref: '#/components/schemas/invalidinput' + '500': + description: Internal Server Error + content: + application/json: + schema: + $ref: '#/components/schemas/servererror' + '504': + description: Gateway Timeout + content: + application/json: + schema: + $ref: '#/components/schemas/gatewaytimeout' + security: + - APIAuthorizer: [] +components: + schemas: + success: + type: object + properties: + REPORT: + type: object + example: + description: |+ + Report details with following children: + [META_INFO] + [BASIC_INFO] + [LIT_SEARCH_INFO] + [LIST_CURRENT_COMP] + [LIST_PREVIOUS_COMP] + [LIST_BANKRUPTCY] + [LIST_LIT] + [LIST_LIT_DTL] + properties: + META_INFO: + type: object + example: |+ + + + + 25/02/2009 17:31:44.678 + + + description: |+ + Meta Information details with following children: + SERVICE + SYSTEM_ID + CREATION_DATE + USER_ID + properties: + SERVICE: + type: string + example: "BIS" + description: Report Requested + SYSTEM_ID : + type: string + example: "DDP" + description: System ID + CREATION_DATE: + type: datetime + example: "25/02/2009 17:31:44.678" + description: Report Request Date + USER_ID : + type: string + example: N/A + description: Valid user id in DDP system. It is for (For internal use) + BASIC_INFO : + type: object + description: |+ + Basic Information with following children: + PA_REG_NO + ADDRESS1 + ADDRESS2 + ADDRESS3 + example: |+ + + + + + + + properties: + PA_REG_NO: + type: string + description: Public Accountant Registration No. + example: "00091" + ADDRESS1: + type: string + description: Address 1 + example: "137" + ADDRESS2: + type: string + description: Address 2 + example: "vvvvv" + ADDRESS3: + type: string + description: Address 3 + example: "470137, SINGAPORE" + LIT_SEARCH_INFO : + type: object + example: |+ + + + + + 25/02/2009 17:31:44 + + + + + description: |+ + Litigation search information with following children: + COMP_NAME + REG_NO + REPORT_TYPE + REQ_DATE + REQ_REG_NO + REQ_NAME + REQ_DATE_STR + properties: + COMP_NAME: + type: string + description: Company Name + example: "ENG YICK HOLDINGS PTE LTD" + REG_NO: + type: string + description: Company Registration No + example: "197803191K" + REPORT_TYPE: + type: string + description: Report Type + example: "BIS" + REQ_DATE: + type: datetime + description: Requested Date + example: "25/02/2009 17:31:44" + REQ_REG_NO: + type: string + description: Request Registration Number + example: "197803191K" + REQ_NAME: + type: string + description: Request Name + example: "LOY KOK TOON" + REQ_DATE_STR: + type: string + description: Request Date String + example: "25/02/2009 15:04:14" + LIST_CURRENT_COMP : + type: array + description: |+ + List of current companies with following children: + [CURRENT_COMP] + example: |+ + + + + + + + + + + + + + + + + + + + items: + properties: + CURRENT_COMP: + type: object + description: |+ + Current companies detail with following children: + POSITION + APPOINTMENT_DATE + COMP_NAME + SEQ_NO + SHARE_VALUE1 + COMP_STATUS + PROFIT_VALUE + SHARE_VALUE + TEL + FAX + SIC + SIC_DESC + example: |+ + + + + + + + + + + + + + + + + + properties: + POSITION: + type: string + description: Position + example: "OWNER" + APPOINTMENT_DATE: + type: string + description: Appointment Date + example: "01/09/1971" + COMP_NAME: + type: string + description: Company Name + example: "BAN HOE LEONG COMPANY" + SEQ_NO: + type: string + description: Company Registration No. + example: "03647300J" + SHARE_VALUE1: + type: string + description: Share Percentage + example: "15.00" + COMP_STATUS: + type: string + description: Company Status + example: "LIVE" + PROFIT_VALUE1: + type: string + description: Profit Making 1 + example: "2008 = -" + PROFIT_VALUE2: + type: string + description: Profit Making 2 + example: "2007 = -" + PROFIT_VALUE3: + type: string + description: Profit Making 3 + example: "2006 = -" + SHARE_VALUE: + type: string + description: Number Of Shares + example: "150000" + TEL: + type: string + description: Telephone Number + example: "62994842" + FAX: + type: string + description: Fax Number + example: "62992797" + SIC: + type: string + description: SIC Code + example: "5012" + SIC_DESC: + type: string + description: SIC Description + example: "Automobiles and other Motor Vehicles" + LIST_PREVIOUS_COMP: + type: array + example: |+ + + + + + + + + + + + + + + + + + description: |+ + List of previous companies with following children: + [PREVIOUS_COMP] + items: + properties: + PREVIOUS_COMP : + type: object + description: |+ + Previous companies detail with following children: + POSITION + APPOINTMENT_DATE + COMP_NAME + SEQ_NO + SHARE_VALUE1 + COMP_STATUS + CESSATION_DATE + SHARE_VALUE + TEL + FAX + SIC + SIC_DESC + example: |+ + + + + + + + + + + + + + + + properties: + POSITION : + type: string + description: Position + example: "SHAREHOLDER" + APPOINTMENT_DATE: + type: string + description: Appointment Date + example: "30/06/1988" + COMP_NAME: + type: string + description: Company Name + example: "ENG YICK INDUSTRIES PTE LTD" + SEQ_NO: + type: string + description: Company Registration No. + example: "198101820Z" + SHARE_VALUE1: + type: string + description: Share Value Percentage + example: "100.00" + COMP_STATUS: + type: string + description: Company Status + example: "DISSOLVED - COMPULSORY WINDING UP (INSOLVENCY)" + CESSATION_DATE : + type: string + description: Cessation Date + example: "22/09/1992" + SHARE_VALUE: + type: string + description: Number Of Shares + example: "390002" + TEL: + type: string + description: Telephone Number + example: "62994842" + FAX: + type: string + description: Fax Number + example: "67467646" + SIC: + type: string + description: SIC Code + example: "2325" + SIC_DESC: + type: string + description: SIC Description + example: "Men’s and Boys’ Separate Trousers and Slacks" + LIST_BANKRUPTCY: + type: array + description: |+ + Bankruptcy/ Winding up with following children: + [BANKRUPTCY] + example: |+ + + + + + + + + + + + + + + + + + + + + + + + + + + + items: + properties: + BANKRUPTCY : + type: object + description: |+ + Bankruptcy/Winding up detail with following children: + SUBJECT_NAME + COURT_CODE + CASE_CODE + CASE_YEAR + ACTION_DATE + BANKRUPTCY_ACT + HEARING_DATE + CURRENCY1 + AMOUNT1 + CURRENCY2 + AMOUNT2 + CURRENCY3 + AMOUNT3 + BANKRUPTCY_TYPE + [LIST_PLAINTIFF] + example: |+ + + + + + + + + + + + + + + + + + + + + + + + + + properties: + SUBJECT_NAME : + type: string + description: Subject Name + example: + COURT_CODE: + type: string + description: Court Code + example: "CWU" + CASE_CODE: + type: string + description: Case Code + example: "381" + CASE_YEAR: + type: string + description: Case Year + example: "2000" + ACTION_DATE: + type: string + description: Action Date + example: "22/12/2000" + BANKRUPTCY_ACT: + type: string + description: Act of Bankruptcy + example: "Petition for Winding Up" + HEARING_DATE : + type: string + description: Hearing Date + example: "26/03/2009" + CURRENCY1: + type: string + description: Currency + example: + AMOUNT1: + type: string + description: Amount + example: "334,616.00" + CURRENCY2: + type: string + description: Currency + example: + AMOUNT2: + type: string + description: Amount + example: "0.00" + CURRENCY3: + type: string + description: Currency + example: + AMOUNT3: + type: string + description: Amount + example: "0.00" + BANKRUPTCY_TYPE: + type: string + description: Bankruptcy Type + example: "COMPANY WINDING UP PETITION" + LIST_PLAINTIFF: + type: array + description: |+ + List of Plaintiff with following children: + [PLAINTIFF] + example: |+ + + + + + + + + + items: + properties: + PLAINTIFF: + type: object + description: |+ + Plaintiff detail with following children: + PLA_NAME + PLA_SOLICITOR + PLA_SOLICITOR_ID + PLA_FILE_REF + example: |+ + + + + + + + properties: + PLA_NAME: + type: string + description: Pla. Name + example: "B 2003 P1" + PLA_SOLICITOR: + type: string + description: Pla. Solicitor + example: "PATRICK KHOO ENG HOCK" + PLA_SOLICITOR_ID: + type: string + description: Pla. Solicitor ID + example: + PLA_FILE_REF: + type: string + description: Pla. File Ref. + example: "RSP/292668/1" + LIST_LIT: + type: array + description: |+ + List of litigation with following children: + [LIT] + example: |+ + + + + + + + + items: + properties: + LIT: + type: object + description: |+ + Basic litigation info with following children: + SUBJECT_NAME + SEQ_NO + FORMATTED_ID + [LIST_LIT_DTL] + example: |+ + + + + + + properties: + SUBJECT_NAME: + type: string + description: Name + example: "ENG YICK HOLDINGS PTE LTD" + SEQ_NO: + type: integer + description: Sequence No. + example: 1 + FORMATTED_ID: + type: string + description: Formatted ID + example: "197803191K" + LIST_LIT_DTL: + type: array + description: |+ + List of litigation detail with following children: + [LIT_DTL] + example: |+ + + + + + + + + + + + + + + + + + + + + + + + + + + + - + - + S7250163B + + + + + + + + + - + - + S7250163B + + + + + + + + + + + + + items: + properties: + LIT_DTL: + type: object + description: |+ + Litigation detail with following children: + NATURE_OF_CLAIM + STATUS_DATE + CASE_NO + FORMATTED_ID + DOC_REMARKS + CURRENCY1 + CURRENCY2 + CURRENCY3 + CURRENCY4 + CURRENCY5 + CASE_STATUS + AMOUNT1 + AMOUNT2 + AMOUNT3 + AMOUNT4 + AMOUNT5 + [LIST_PLAINTIFF] + [LIST_DEFENDANT] + example: |+ + + + + + + + + + + + + + + + + + + + + + + + + + + - + - + S7250163B + + + + + + + + + - + - + S7250163B + + + + + + + + + + + + properties: + NATURE_OF_CLAIM: + type: string + description: Nature of Claim + example: "CONTRACTS-WORK DONE & SERVICES RENDERED" + STATUS_DATE: + type: string + description: Status Date + example: "13/08/2001" + CASE_NO: + type: string + description: Case No. + example: "MC 23631 / 2001" + FORMATTED_ID: + type: string + description: Formatted ID + example: "197803191K" + DOC_REMARKS: + type: string + description: Document Remark + example: "WRIT OF SUMMONS" + CURRENCY1: + type: string + description: Currency 1 + example: "SIN" + CURRENCY2: + type: string + description: Currency 2 + example: + CURRENCY3: + type: string + description: Currency 3 + example: + CURRENCY4: + type: string + description: Currency 4 + example: + CURRENCY5: + type: string + description: Currency 5 + example: + CASE_STATUS: + type: string + description: Status + example: "PENDING AS AT STATUS DATE" + AMOUNT1: + type: string + description: Amount 1 + example: "36,196.00" + AMOUNT2: + type: string + description: Amount 2 + example: "0.00" + AMOUNT3: + type: string + description: Amount 3 + example: "0.00" + AMOUNT4: + type: string + description: Amount 4 + example: "0.00" + AMOUNT5: + type: string + description: Amount 5 + example: "0.00" + LIST_PLAINTIFF: + type: array + description: |+ + List of plaintiff with following children: + [PLAINTIFF] + example: |+ + + + + + + + + + - + - + S7250163B + + + items: + properties: + PLAINTIFF: + type: object + description: |+ + Plaintiff detail with following children: + PLA_NAME + LAW_FIRM + WRITE_DATE + PLA_SOLICITOR + PLA_SOLICITOR_ID + PLA_FILE_REF + PLA_STATUS + PLA_STATUS_DATE + PLA_ID + example: |+ + + + + + + + + - + - + S7250163B + + properties: + PLA_NAME: + type: string + description: Plaintiff Name + example: "ROTARY PILING PTE LTD" + LAW_FIRM: + type: string + description: Pla. Law Firm + example: "JOSEPH HOO MORRIS & KUMAR" + WRITE_DATE: + type: string + description: Writ date + example: "13/08/2001" + PLA_SOLICITOR: + type: string + description: Plaintiff Solicitor + example: "HOO JOSEPH" + PLA_SOLICITOR_ID: + type: string + description: Plaintiff Solicitor ID + example: "ORS" + PLA_FILE_REF: + type: string + description: Pla. File Ref. + example: "CHH 6253 D27" + PLA_STATUS: + type: string + description: Plaintiff Status + example: + PLA_STATUS_DATE: + type: string + description: Plaintiff Status Date + example: + PLA_ID: + type: string + description: Plaintiff ID + example: "S7250163B" + LIST_DEFENDANT: + type: array + description: |+ + List of defendant with following children: + [DEFENDANT] + example: |+ + + + + + + + + + items: + properties: + DEFENDANT: + type: object + description: |+ + Defendant detail with following children: + DEF_SOLICITOR + DEF_SOLICITOR_ID + DEF_LAW_FIRM + DEF_FILE_REF + example: |+ + + + + + + + properties: + DEF_SOLICITOR: + type: string + description: Def. Solicitor + example: + DEF_SOLICITOR_ID: + type: string + description: Def. Solicitor ID + example: N/A + DEF_LAW_FIRM: + type: string + description: Def. Law Firm + example: + DEF_FILE_REF: + type: string + description: Def. File Ref. + example: + LIST_Ddrptcount: + type: array + description: |+ + List of Search By Financial Sectors and Search By Non-Financial Sectors with following children: + [Ddrptcount] + example: |+ + + + 1 + 1 + 1 + 1 + 1 + 1 + 1 + 1 + 1 + 1 + 1 + 1 + 2017 + 1 + + + items: + properties: + Ddrptcount: + type: object + description: |+ + 6 XML tags (open then close) displays Search By Financial Sectors (counts for 3 recent years).Search By Non-Financial Sectors (counts for 3 recent years) with following children: + Rcjan + Rcfeb + Rcmar + Rcapr + Rcmay + Rcjun + Rcjul + Rcaug + Rcsep + Rcoct + Rcnov + Rcdec + Rcyear + Rcsecflag + example: |+ + + 1 + 1 + 1 + 1 + 1 + 1 + 1 + 1 + 1 + 1 + 1 + 1 + 2017 + 1 + + properties: + Rcjan: + type: integer + description: Count for January + example: "1" + Rcfeb: + type: integer + description: Count for February + example: "1" + Rcmar: + type: integer + description: Count for March + example: "1" + Rcapr: + type: integer + description: Count for April + example: "1" + Rcmay: + type: integer + description: Count for May + example: "1" + Rcjun: + type: integer + description: Count for June + example: "1" + Rcjul: + type: integer + description: Count for July + example: "1" + Rcaug: + type: integer + description: Count for August + example: "1" + Rcsep: + type: integer + description: Count for September + example: "1" + Rcoct: + type: integer + description: Count for October + example: "1" + Rcnov: + type: integer + description: Count for November + example: "1" + Rcdec: + type: integer + description: Count for December + example: "1" + Rcyear: + type: integer + description: To show the year + example: "1" + Rcsecflag: + type: integer + description: Differentiate Search By Financial Sectors and Search By Non-Financial Sectors + example: "1" + unauthorized: + type: object + properties: + message: + type: string + example: Missing Authentication Token + status: + type: string + example: Failure + forbidden: + type: object + properties: + message: + type: string + example: Access Denied Unauthorized User + status: + type: string + example: Failure + paymentrequired: + type: object + properties: + message: + type: string + example: Insufficient Credits Kindly Top Up + status: + type: string + example: Failure + notfound: + type: object + properties: + message: + type: string + example: Invalid Request URL + status: + type: string + example: Failure + servererror: + type: object + properties: + message: + type: string + example: Internal Server Error + status: + type: string + example: Failure + gatewaytimeout: + type: object + properties: + message: + type: string + example: Request Timeout + status: + type: string + example: Failure + inputfieldmissing: + type: object + properties: + message: + type: string + example: Input Field Missing + status: + type: string + example: Failure + inputlimitexceeded: + type: object + properties: + message: + type: string + example: Input Limit Exceeded + status: + type: string + example: Failure + invalidinput: + type: object + properties: + message: + type: string + example: Invalid Input + status: + type: string + example: Failure + REQUEST: + type: object + properties: + TOT_ITEMS: + type: number + example: 1 + description: Number of subjects being enquired relating to the Run + default: false + ENQUIRY: + type: object + example: |+ + 197601887ETRANSTAR TRAVEL PTE LTD + description: Contains information of each request details + default: true + properties: + SUBJECT_IDNO: + type: string + example: 199707714C + description: "Subject’s ID Number (individual) or Registration Number (company/business) as captured in DDP" + default: true + SUBJECT_NAME: + type: string + example: GPS INDUSTRIES PTE LTD + description: Subjects Name as captured in DDP + default: false + versions: + type: object + properties: + v0.1.0: + type: array + items: + oneOf: + - type: string + example: Published Date - Aug 15, 2019 + description: Initial version release + securitySchemes: + APIAuthorizer: + type: apiKey + name: x-api-key + in: header + x-amazon-apigateway-authtype: custom + description: Authentication is done using the x-api-key in the request header diff --git a/data/d&b_brief_financial_information_sg.yaml b/data/d&b_brief_financial_information_sg.yaml new file mode 100644 index 000000000..22143c37a --- /dev/null +++ b/data/d&b_brief_financial_information_sg.yaml @@ -0,0 +1,1404 @@ +openapi: 3.0.1 +info: + title: D&B Brief Financial Information (SG) + description: This Data microservice provides the annual financial information of Singapore-registered businesses, inclusive of annual profit and loss and financial ratios. Updated daily. + x-additionalinfo: |+ + Suggested Use Cases: + - Software solutions with functions for personal credit checks, e.g. for parties who have a vested interest (e.g. banks, investors) in the company’s performance and to evaluate the company’s gearing and acid ratios. + + - Information from this microservice can be used for financial analysis - one can build models based on historical behavior. Continually update fraud patterns and compare with real-time transactions. Store and consolidate market data, trade activity, and other data, such as social and transactional data. + version: '0.1.0' + x-subscribelink: d&b_brief_financial_information_sg +servers: + - url: 'https://api.sentient.io' +tags: +- name: "v0.1.0" + description: "Published Date - Aug 15, 2019" +paths: + /dnb/prod/sbfe: + post: + tags: + - v0.1.0 + summary: Adds a new user + requestBody: + content: + application/xml: + schema: + $ref: '#/components/schemas/REQUEST' + responses: + '200': + description: success response + content: + application/xml: + schema: + $ref: '#/components/schemas/success' + example: |+ + + 25/02/2009 17:31:44> + + + 2009-04-21 10:56:06.716 + 2004 2003 2002 2005 + 2006 2007 2008 2009 2008 2007 2006 2005 2004 + + 9403795.00 8617168.00 7807393.00 31467.00 162620.00 1281387.00 31467.00 162620.00 1281387.00 0.00 0.00 60318.00> 31467.00 162620.00 1341705.00 3889213.00 3395740.00 4374368.00 3359007.00 2855754.00 3546381.00 530206.00 539986.00 827987.00> 7370430.00 6845490.00 7661498.00 6739073.00 6157560.00 6435365.00 631357.00 687930.00 122133.00 -3481217.00 -3449750.00 -3287130.00 2000000.00 2000000.00 2000000.00 0.00 0.00 0.00 5481217.00 5449750.00 5287130.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 + 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 + + 10877254.00 9982533.00 1121483.00 262632.00 1347380.00 262632.00 6562990.00 5424551.00 6283449.00 4948821.00 279541.00 475730.00 8434195.00 8643136.00 8434195.00 7933013.00 0.00 710123.00 -1871205.00 -3218585.00 2000000.00 2000000.00 0.00 0.00 -3,871,205.00 -5,218,585.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 + 0.00 0.00 0.00 0.00 + + 12.39 2.63 0.00 0.00 0.00 20.53 4.84 0.00 0.00 0.00 -72.01 -8.16 -0.00 -0.00 -0.00 1.66 1.84 2.42 2.54 1.78 0.74 0.62 0.50 0.46 0.55 -28.51 -59.33 -89.51 -101.59 -75.15 128.51 168.27 189.51 201.59 175.15 + + 1121483.0 10877254 2008 + + 262632.0> 9982533 2007 + + -31467.0 9403795 2006 + + -162620.0 8617168 2005 + + -1281387.0 7807393 2004 + + + '401': + description: Unauthorized + content: + application/json: + schema: + $ref: '#/components/schemas/unauthorized' + '402': + description: Payment Required + content: + application/json: + schema: + $ref: '#/components/schemas/paymentrequired' + '403': + description: Forbidden + content: + application/json: + schema: + $ref: '#/components/schemas/forbidden' + '404': + description: Not Found + content: + application/json: + schema: + $ref: '#/components/schemas/notfound' + '419': + description: Input Field Missing + content: + application/json: + schema: + $ref: '#/components/schemas/inputfieldmissing' + '413': + description: Input Limit Exceeded + content: + application/json: + schema: + $ref: '#/components/schemas/inputlimitexceeded' + '415': + description: Invalid Input + content: + application/json: + schema: + $ref: '#/components/schemas/invalidinput' + '500': + description: Internal Server Error + content: + application/json: + schema: + $ref: '#/components/schemas/servererror' + '504': + description: Gateway Timeout + content: + application/json: + schema: + $ref: '#/components/schemas/gatewaytimeout' + security: + - APIAuthorizer: [] +components: + schemas: + success: + type: object + properties: + REPORT: + type: object + description: |+ + Report details with following children: + [META_INFO] + [FH_SEARCH_INFO] + [FH_DTL] + [XBRL_DTL] + [FH_RATIO_DTL] + [LIST_FH_CHART_INFO] + example: + properties: + META_INFO: + type: object + description: |+ + Meta Information details with following children: + SERVICE + SYSTEM_ID + CREATION_DATE + USER_ID + example: |+ + + + + 25/02/2009 17:31:44> + + + properties: + SERVICE: + type: string + description: Report Requested + example: "BFE" + SYSTEM_ID : + type: string + description: System ID + example: "DDP" + CREATION_DATE: + type: string + description: Report Request Date + example: "25/02/2009 17:31:44" + USER_ID : + type: string + description: Valid user id in DDP system. It is for (For internal use) + example: N/A + FH_SEARCH_INFO: + type: object + description: |+ + FH search information with following children: + COMP_NAME + REG_NO + REQ_DATE + REQ_REG_NO + REQ_NAME + REQ_DATE_STR + FH_BEFORE_YR1 + FH_BEFORE_YR2 + FH_BEFORE_YR3 + FH_BEFORE_YR4 + FH_BEFORE_YR5 + FH_AFTER_YR1 + FH_AFTER_YR2 + FH_AFTER_YR3 + FH_AFTER_YR4 + FH_AFTER_YR5 + AC_RATIOS_YR1 + AC_RATIOS_YR2 + AC_RATIOS_YR3 + AC_RATIOS_YR4 + AC_RATIOS_YR5 + example: |+ + + + + 2009-04-21 10:56:06.716 + + + + 2004 + 2003 + 2002 + 2005 + 2006 + 2007 + 2008 + 2009 + 2008 + 2007 + 2006 + 2005 + 2004 + + properties: + COMP_NAME : + type: string + description: Company Name + example: "DUN & BRADSTREET (SINGAPORE) PTE. LTD." + REG_NO : + type: string + description: Company Registration No + example: "200003058W" + REQ_DATE : + type: datetime + description: Requested Date + example: "2009-04-21 10:56:06.716" + REQ_REG_NO : + type: string + description: Request Registration Number + example: "200003058W" + REQ_NAME : + type: string + description: Request Name + example: "DUN & BRADSTREET (SINGAPORE) PTE. LTD." + REQ_DATE_STR : + type: string + description: Request Date String + example: "21/04/2009 10:56:06" + FH_BEFORE_YR1 : + type: string + description: Financial Highlight filed before year 1 + example: "2004" + FH_BEFORE_YR2 : + type: string + description: Financial Highlight filed before year 2 + example: "2003" + FH_BEFORE_YR3 : + type: string + description: Financial Highlight filed before year 3 + example: "2002" + FH_AFTER_YR1: + type: string + description: Financial Highlight filed after year 1 + example: "2005" + FH_AFTER_YR2 : + type: string + description: Financial Highlight filed after year 2 + example: "2006" + FH_AFTER_YR3 : + type: string + description: Financial Highlight filed after year 3 + example: "2007" + FH_AFTER_YR4: + type: string + description: Financial Highlight filed after year 4 + example: "2008" + FH_AFTER_YR5: + type: string + description: Financial Highlight filed after year 5 + example: "2009" + AC_RATIOS_YR1 : + type: string + description: Account Ratio year 1 + example: "2008" + AC_RATIOS_YR2 : + type: string + description: Account Ratio year 2 + example: "2007" + AC_RATIOS_YR3 : + type: string + description: Account Ratio year 3 + example: "2006" + AC_RATIOS_YR4 : + type: string + description: Account Ratio year 4 + example: "2005" + AC_RATIOS_YR5 : + type: string + description: Account Ratio year 5 + example: "2004" + FH_DTL: + type: object + description: |+ + Financial Highlight with following children: + FH_YR1_CURR + TURNOVER1 + PL_BEF_TAX1 + PL_AFT_TAX1 + NETINC_NON_EXT1 + PL_AFT_TAX_EXT1 + TOT_ASSETS1 + TA_CURRENT1 + TA_FIXED1 + TOT_LIABILITIES1 + TL_CURRENT1 + TL_NON_CURRENT1 + SH_FUNDS1 + SH_PAIDUP_CAPITAL1 + SH_RESERVES1 + SH_ACCUM_LOSS1 + GRP_TURNOVER1 + GRP_PL_BEF_TAX1 + GRP_PL_AFT_TAX1 + GRP_NETINC_NON_EXT1 + GRP_PL_AFT_TAX_EXT1 + GRP_TOT_ASSETS1 + GRP_TA_CURRENT1 + GRP_TA_FIXED1 + GRP_TOT_LIABILITIES1 + GRP_TL_CURRENT1 + GRP_TL_NON_CURRENT1 + GRP_SH_FUNDS1 + GRP_SH_PAIDUP_CAPITAL1 + GRP_SH_RESERVES1 + GRP_SH_ACCUM_LOSS1 + GRP_INDICATOR1 + + Note: Each tag will consist of maximum 5 sets with suffix 1 to 5. But it is optional, depending on how many years of FH data displayed in the report. + example: |+ + + + + + 9403795.00 + 8617168.00 + 7807393.00 + 31467.00 + 162620.00 + 1281387.00 + 31467.00 + 162620.00 + 1281387.00 + 0.00 + 0.00 + 60318.00> + 31467.00 + 162620.00 + 1341705.00 + 3889213.00 + 3395740.00 + 4374368.00 + 3359007.00 + 2855754.00 + 3546381.00 + 530206.00 + 539986.00 + 827987.00> + 7370430.00 + 6845490.00 + 7661498.00 + 6739073.00 + 6157560.00 + 6435365.00 + 631357.00 + 687930.00 + 122133.00 + -3481217.00 + -3449750.00 + -3287130.00 + 2000000.00 + 2000000.00 + 2000000.00 + 0.00 + 0.00 + 0.00 + 5481217.00 + 5449750.00 + 5287130.00 + 0.00 + 0.00 + 0.00 + 0.00 + 0.00 + 0.00 + 0.00 + 0.00 + 0.00 + 0.00 + 0.00 + 0.00 + 0.00 + 0.00 + 0.00 + 0.00 + 0.00 + 0.00 + 0.00 + 0.00 + 0.00 + 0.00 + 0.00 + 0.00 + 0.00 + 0.00 + 0.00 + 0.00 + 0.00 + 0.00 + 0.00 + 0.00 + 0.00 + 0.00 + 0.00 + 0.00 + 0.00 + 0.00 + 0.00 + 0.00 + 0.00 + 0.00 + 0.00 + 0.00 + 0.00 + + + + + properties: + FH_YR1_CURR : + type: string + description: |+ + FH Before Year 1 Currency + Subsequent Years: + FH_YR2_CURR + FH_YR3_CURR + FH_YR4_CURR + FH_YR5_CURR + example: "(SGD)" + TURNOVER1 : + type: string + description: |+ + Turnover / Sales And Other Operating Revenues + Subsequent Years: + TURNOVER2 + TURNOVER3 + TURNOVER4 + TURNOVER5 + example: "9403795.00" + PL_BEF_TAX1 : + type: string + description: |+ + Profit / Loss Before Tax + Subsequent Years: + PL_BEF_TAX2 + PL_BEF_TAX3 + PL_BEF_TAX4 + PL_BEF_TAX5 + example: "31467.00" + PL_AFT_TAX1: + type: string + description: |+ + Profit / Loss After Tax + Subsequent Years: + PL_AFT_TAX2 + PL_AFT_TAX3 + PL_AFT_TAX4 + PL_AFT_TAX5 + example: "31467.00" + NETINC_NON_EXT1: + type: string + description: |+ + Net Income / Loss From Extraordinary And Non- Operating Items + Subsequent Years: + NETINC_NON_EXT2 + NETINC_NON_EXT3 + NETINC_NON_EXT4 + NETINC_NON_EXT5 + example: "0.00" + PL_AFT_TAX_EXT1 : + type: string + description: |+ + Profit / Loss After Tax and Extraordinary Items + Subsequent Years: + PL_AFT_TAX_EXT2 + PL_AFT_TAX_EXT3 + PL_AFT_TAX_EXT4 + PL_AFT_TAX_EXT5 + example: "31467.00" + TOT_ASSETS1 : + type: string + description: |+ + Total Assets + Subsequent Years: + TOT_ASSETS2 + TOT_ASSETS3 + TOT_ASSETS4 + TOT_ASSETS5 + example: "3889213.00" + TA_CURRENT1 : + type: string + description: |+ + Total Assets - Current + Subsequent Years: + TA_CURRENT2 + TA_CURRENT3 + TA_CURRENT4 + TA_CURRENT5 + example: "3359007.00" + TA_FIXED1 : + type: string + description: |+ + Total Assets – Fixed and Others + Subsequent Years: + TA_FIXED2 + TA_FIXED3 + TA_FIXED4 + TA_FIXED5 + example: "530206.00" + TOT_LIABILITIES1 : + type: string + description: |+ + Total Liabilities + Subsequent Years: + TOT_LIABILITIES2 + TOT_LIABILITIES3 + TOT_LIABILITIES4 + TOT_LIABILITIES5 + example: "7370430.00" + TL_CURRENT1 : + type: string + description: |+ + Total Liabilities - Current + Subsequent Years: + TL_CURRENT2 + TL_CURRENT3 + TL_CURRENT4 + TL_CURRENT5 + example: "6739073.00" + TL_NON_CURRENT1 : + type: string + description: |+ + Total Liabilities – Non- Current & Long Term + Subsequent Years: + TL_NON_CURRENT2 + TL_NON_CURRENT3 + TL_NON_CURRENT4 + TL_NON_CURRENT5 + example: "631357.00" + SH_FUNDS1: + type: string + description: |+ + Shareholder’s Fund + Subsequent Years: + SH_FUNDS2 + SH_FUNDS3 + SH_FUNDS4 + SH_FUNDS5 + example: "-3481217.00" + SH_PAIDUP_CAPITAL1 : + type: string + description: |+ + Shareholder’s Fund – Paid Up Capital + Subsequent Years: + SH_PAIDUP_CAPITAL2 + SH_PAIDUP_CAPITAL3 + SH_PAIDUP_CAPITAL4 + SH_PAIDUP_CAPITAL5 + example: "2000000.00" + SH_RESERVES1 : + type: string + description: |+ + Shareholder’s Fund - Reserves + Subsequent Years: + SH_RESERVES2 + SH_RESERVES3 + SH_RESERVES4 + SH_RESERVES5 + example: "0.00" + SH_ACCUM_LOSS1: + type: string + description: |+ + Shareholder’s Fund – Accumulated Loss + Subsequent Years: + SH_ACCUM_LOSS2 + SH_ACCUM_LOSS3 + SH_ACCUM_LOSS4 + SH_ACCUM_LOSS5 + example: "5481217.00" + GRP_TURNOVER1 : + type: string + description: |+ + Group Turnover / Sales and Other Operating Revenues + Subsequent Years: + GRP_TURNOVER2 + GRP_TURNOVER3 + GRP_TURNOVER4 + GRP_TURNOVER5 + example: "0.00" + GRP_PL_BEF_TAX1 : + type: string + description: |+ + Group Profit / Loss Before Tax + Subsequent Years: + GRP_PL_BEF_TAX2 + GRP_PL_BEF_TAX3 + GRP_PL_BEF_TAX4 + GRP_PL_BEF_TAX5 + example: "0.00" + GRP_PL_AFT_TAX1 : + type: string + description: |+ + Group Profit / Loss After Tax + Subsequent Years: + GRP_PL_AFT_TAX2 + GRP_PL_AFT_TAX3 + GRP_PL_AFT_TAX4 + GRP_PL_AFT_TAX5 + example: "0.00" + GRP_NETINC_NON_EXT1 : + type: string + description: |+ + Group Net Income / Loss From Extraordinary and Non-Operating Items + Subsequent Years: + GRP_NETINC_NON_EXT2 + GRP_NETINC_NON_EXT3 + GRP_NETINC_NON_EXT4 + GRP_NETINC_NON_EXT5 + example: "0.00" + GRP_PL_AFT_TAX_EXT1: + type: string + description: |+ + Group Profit / Loss After Tax and Extraordinary items + Subsequent Years: + GRP_ PL_AFT_TAX_EXT2 + GRP_ PL_AFT_TAX_EXT3 + GRP_ PL_AFT_TAX_EXT4 + GRP_ PL_AFT_TAX_EXT5 + example: "0.00" + GRP_TOT_ASSETS1: + type: string + description: |+ + Group Total Assets + Subsequent Years: + GRP_TOT_ASSETS2 + GRP_TOT_ASSETS3 + GRP_TOT_ASSETS4 + GRP_TOT_ASSETS5 + example: "0.00" + GRP_TA_CURRENT1 : + type: string + description: |+ + Group Total Assets – Current + Subsequent Years: + GRP_TA_CURRENT2 + GRP_TA_CURRENT3 + GRP_TA_CURRENT4 + GRP_TA_CURRENT5 + example: "0.00" + GRP_TA_FIXED1 : + type: string + description: |+ + Group Total Assets – Fixed and Others + Subsequent Years: + GRP_TA_FIXED2 + GRP_TA_FIXED3 + GRP_TA_FIXED4 + GRP_TA_FIXED5 + example: "0.00" + GRP_TOT_LIABILITIES1 : + type: string + description: |+ + Group Total Liabilities + Subsequent Years: + GRP_TOT_LIABILITIES2 + GRP_TOT_LIABILITIES3 + GRP_TOT_LIABILITIES4 + GRP_TOT_LIABILITIES5 + example: "0.00" + GRP_TL_CURRENT1 : + type: string + description: |+ + Group Total Liabilities - Current + Subsequent Years: + GRP_TL_CURRENT2 + GRP_TL_CURRENT3 + GRP_TL_CURRENT4 + GRP_TL_CURRENT5 + example: "0.00" + GRP_TL_NON_CURRENT1 : + type: string + description: |+ + Group Total Liabilities – Non-Current & Long Term + Subsequent Years: + GRP_TL_NON_CURRENT2 + GRP_TL_NON_CURRENT3 + GRP_TL_NON_CURRENT4 + GRP_TL_NON_CURRENT5 + example: "0.00" + GRP_SH_FUNDS1 : + type: string + description: |+ + Group Shareholder’s Fund + Subsequent Years: + GRP_ SH_FUNDS2 + GRP_ SH_FUNDS3 + GRP_ SH_FUNDS4 + GRP_ SH_FUNDS5 + example: "0.00" + GRP_SH_PAIDUP_CAPITAL1 : + type: string + description: |+ + Group Shareholder’s Fund – Paid Up Capital + Subsequent Years: + GRP_SH_PAIDUP_CAPITAL2 + GRP_SH_PAIDUP_CAPITAL3 + GRP_SH_PAIDUP_CAPITAL4 + GRP_SH_PAIDUP_CAPITAL5 + example: "0.00" + GRP_SH_RESERVES1: + type: string + description: |+ + Group Shareholder’s Fund - Reserves + Subsequent Years: + GRP_SH_RESERVES2 + GRP_SH_RESERVES3 + GRP_SH_RESERVES4 + GRP_SH_RESERVES5 + example: "0.00" + GRP_SH_ACCUM_LOSS1 : + type: string + description: |+ + Group Shareholder’s Fund – Accumulated Loss + Subsequent Years: + GRP_SH_ACCUM_LOSS2 + GRP_SH_ACCUM_LOSS3 + GRP_SH_ACCUM_LOSS4 + GRP_SH_ACCUM_LOSS5 + example: "0.00" + GRP_INDICATOR1 : + type: string + description: |+ + Company Financial Highlights Group Indicator + Subsequent Years: + GRP_INDICATOR2 + GRP_INDICATOR3 + GRP_INDICATOR4 + GRP_INDICATOR5 + example: "B" + XBRL_DTL: + type: object + description: |+ + XBRL filed after 1 Nov 2007 with following children: + XBRL_YR1_CURR + REVENUE1 + PL_BEF_TAX1 + PL_AFT_TAX1 + TOT_ASSETS1 + TA_CURRENT1 + TA_NON_CURRENT1 + TOT_LIABILITIES1 + TL_CURRENT1 + TL_NON_CURRENT1 + TOT_EQUITY1 + EQ_SH_CAPITAL1 + EQ_RESERVES1 + EQ_RETAINED_EARN1 + GRP_REVENUE1 + GRP_PL_BEF_TAX1 + GRP_PL_AFT_TAX1 + GRP_TOT_ASSETS1 + GRP_TA_CURRENT1 + GRP_TA_NON_CURRENT1 + GRP_TOT_LIABILITIES1 + GRP_TL_CURRENT1 + GRP_TL_NON_CURRENT1 + GRP_TOT_EQUITY1 + GRP_SH_CAPITAL1 + GRP_RESERVES1 + GRP_RETAINED_EARN1 + GRP_INDICATOR1 + + Note: Each tag will consist of maximum 5 sets with suffix 1 to 5. But it is optional, depending on how many years of XBRL data displayed in the report. + example: |+ + + + + 10877254.00 + 9982533.00 + 1121483.00 + 262632.00 + 1347380.00 + 262632.00 + 6562990.00 + 5424551.00 + 6283449.00 + 4948821.00 + 279541.00 + 475730.00 + 8434195.00 + 8643136.00 + 8434195.00 + 7933013.00 + 0.00 + 710123.00 + -1871205.00 + -3218585.00 + 2000000.00 + 2000000.00 + 0.00 + 0.00 + -3,871,205.00 + -5,218,585.00 + 0.00 + 0.00 + 0.00 + 0.00 + 0.00 + 0.00 + 0.00 + 0.00 + 0.00 + 0.00 + 0.00 + 0.00 + 0.00 + 0.00 + 0.00 + 0.00 + 0.00 + 0.00 + 0.00 + 0.00 + 0.00 + 0.00 + 0.00 + 0.00 + 0.00 + 0.00 + + + + + properties: + XBRL_YR1_CURR: + type: string + description: |+ + FH After Year 1 Currency + Subsequent Years: + XBRL_YR2_CURR + XBRL_YR3_CURR + XBRL_YR4_CURR + XBRL_YR5_CURR + example: "(SGD)" + REVENUE1 : + type: string + description: |+ + Revenue Amount + Subsequent Years: + REVENUE2 + REVENUE3 + REVENUE4 + REVENUE5 + example: "10877254.00" + PL_BEF_TAX1 : + type: string + description: |+ + Profit / Loss Before Tax from Continuing Operations + Subsequent Years: + PL_BEF_TAX2 + PL_BEF_TAX3 + PL_BEF_TAX4 + PL_BEF_TAX5 + example: "1121483.00" + PL_AFT_TAX1 : + type: string + description: |+ + Profit / Loss After Tax from Continuing Operations + Subsequent Years: + PL_AFT_TAX2 + PL_AFT_TAX3 + PL_AFT_TAX4 + PL_AFT_TAX5 + example: "1347380.00" + TOT_ASSETS1 : + type: string + description: |+ + Total Assets + Subsequent Years: + TOT_ASSETS2 + TOT_ASSETS3 + TOT_ASSETS4 + TOT_ASSETS5 + example: "6562990.00" + TA_CURRENT1 : + type: string + description: |+ + Total Current Assets (Only for Balance Sheet by Current / Non-Current) + Subsequent Years: + TA_CURRENT2 + TA_CURRENT3 + TA_CURRENT4 + TA_CURRENT5 + example: "6283449.00" + TA_NON_CURRENT1 : + type: string + description: |+ + Total Non-Current Assets (Only for Balance Sheet by Current / Non-Current) + Subsequent Years: + TA_NON_CURRENT2 + TA_NON_CURRENT3 + TA_NON_CURRENT4 + TA_NON_CURRENT5 + example: "279541.00" + TOT_LIABILITIES1 : + type: string + description: |+ + Total Liabilities + Subsequent Years: + TOT_LIABILITIES2 + TOT_LIABILITIES3 + TOT_LIABILITIES4 + TOT_LIABILITIES5 + example: "8434195.00" + TL_CURRENT1 : + type: string + description: |+ + Total Current Liabilities (Only for Balance Sheet by Current / Non-Current) + Subsequent Years: + TL_CURRENT2 + TL_CURRENT3 + TL_CURRENT4 + TL_CURRENT5 + example: "8434195.00" + TL_NON_CURRENT1 : + type: string + description: |+ + Total Non-Current Liabilities (Only for Balance Sheet by Current / Non- Current) + Subsequent Years: + TL_NON_CURRENT2 + TL_NON_CURRENT3 + TL_NON_CURRENT4 + TL_NON_CURRENT5 + example: "0.00" + TOT_EQUITY1 : + type: string + description: |+ + Total Equity (inclusive of Equity Attributable to Equity Holders of Parent and Minority Interest) + Subsequent Years: + TOT_EQUITY2 + TOT_EQUITY3 + TOT_EQUITY4 + TOT_EQUITY5 + example: "-1871205.00" + EQ_SH_CAPITAL1 : + type: string + description: |+ + Total Equity – Share Capital + Subsequent Years: + EQ_SH_CAPITAL2 + EQ_SH_CAPITAL3 + EQ_SH_CAPITAL4 + EQ_SH_CAPITAL5 + example: "2000000.00" + EQ_RESERVES1 : + type: string + description: |+ + Total Equity – Other Reserves + Subsequent Years: + EQ_RESERVES2 + EQ_RESERVES3 + EQ_RESERVES4 + EQ_RESERVES5 + example: "0.00" + EQ_RETAINED_EARN1 : + type: string + description: |+ + Total Equity – Retained Earnings (Accumulated Loss) + Subsequent Years: + EQ_RETAINED_EARN2 + EQ_RETAINED_EARN3 + EQ_RETAINED_EARN4 + EQ_RETAINED_EARN5 + example: "-3,871,205.00" + GRP_REVENUE1 : + type: string + description: |+ + Group’s Revenue Amount + Subsequent Years: + GRP_REVENUE2 + GRP_REVENUE3 + GRP_REVENUE4 + GRP_REVENUE5 + example: "0.00" + GRP_PL_BEF_TAX1 : + type: string + description: |+ + Group Profit / Loss Before Tax from Continuing Operations + Subsequent Years: + GRP_PL_BEF_TAX2 + GRP_PL_BEF_TAX3 + GRP_PL_BEF_TAX4 + GRP_PL_BEF_TAX5 + example: "0.00" + GRP_PL_AFT_TAX1 : + type: string + description: |+ + Group Profit / Loss After Tax from Continuing Operations + Subsequent Years: + GRP_PL_AFT_TAX2 + GRP_PL_AFT_TAX3 + GRP_PL_AFT_TAX4 + GRP_PL_AFT_TAX5 + example: "0.00" + GRP_TOT_ASSETS1 : + type: string + description: |+ + Group’s Total Assets + Subsequent Years: + GRP_TOT_ASSETS2 + GRP_TOT_ASSETS3 + GRP_TOT_ASSETS4 + GRP_TOT_ASSETS5 + example: "0.00" + GRP_TA_CURRENT1 : + type: string + description: |+ + Group’s Total Current Assets (Only for Balance Sheet by Current / Non- Current) + Subsequent Years: + GRP_TA_CURRENT2 + GRP_TA_CURRENT3 + GRP_TA_CURRENT4 + GRP_TA_CURRENT4 + example: "0.00" + GRP_TA_NON_CURRENT1 : + type: string + description: |+ + Group’s Total Non-Current Assets (Only for Balance Sheet by Current / Non- Current) + Subsequent Years: + GRP_TA_NON_CURRENT2 + GRP_TA_NON_CURRENT3 + GRP_TA_NON_CURRENT4 + GRP_TA_NON_CURRENT4 + example: "0.00" + GRP_TOT_LIABILITIES1 : + type: string + description: |+ + Group’s Total Liabilities + Subsequent Years: + GRP_TOT_LIABILITIES2 + GRP_TOT_LIABILITIES3 + GRP_TOT_LIABILITIES4 + GRP_TOT_LIABILITIES5 + example: "0.00" + GRP_TL_CURRENT1 : + type: string + description: |+ + Group’s Total Current Liabilities (Only for Balance Sheet by Current / Non- Current) + Subsequent Years: + GRP_TL_CURRENT2 + GRP_TL_CURRENT3 + GRP_TL_CURRENT4 + GRP_TL_CURRENT5 + example: "0.00" + GRP_TL_NON_CURRENT1 : + type: string + description: |+ + Group’s Total Non-Current Liabilities (Only for Balance Sheet by Current / Non- Current) + Subsequent Years: + GRP_TL_NON_CURRENT2 + GRP_TL_NON_CURRENT3 + GRP_TL_NON_CURRENT4 + GRP_TL_NON_CURRENT5 + example: "0.00" + GRP_TOT_EQUITY1 : + type: string + description: |+ + Group’s Total Equity (inclusive of Equity Attributable to Equity Holders of Parent and Minority Interest) + Subsequent Years: + GRP_TOT_EQUITY2 + GRP_TOT_EQUITY3 + GRP_TOT_EQUITY4 + GRP_TOT_EQUITY5 + example: "0.00" + GRP_SH_CAPITAL1 : + type: string + description: |+ + Group’s Share Capital + Subsequent Years: + GRP_SH_CAPITAL2 + GRP_SH_CAPITAL3 + GRP_SH_CAPITAL4 + GRP_SH_CAPITAL5 + example: "0.00" + GRP_RESERVES1 : + type: string + description: |+ + Group’s Other Reserves + Subsequent Years: + GRP_RESERVES2 + GRP_RESERVES3 + GRP_RESERVES4 + GRP_RESERVES5 + example: "0.00" + GRP_RETAINED_EARN1 : + type: string + description: |+ + Group’s – Retained Earnings (Accumulated Loss) + Subsequent Years: + GRP_RETAINED_EARN2 + GRP_RETAINED_EARN3 + GRP_RETAINED_EARN4 + GRP_RETAINED_EARN5 + example: "0.00" + GRP_INDICATOR1 : + type: string + description: |+ + XBRL Financial Highlights Group Indicator + Subsequent Years: + GRP_INDICATOR2 + GRP_INDICATOR3 + GRP_INDICATOR4 + GRP_INDICATOR5 + example: "B" + FH_RATIOS_DTL: + type: object + description: |+ + Accounting Ratios Details with following children: + RATE_NET_PROFIT1 + RET_INVESTMENT1 + RET_SH_FUNDS1 + TOT_ASSETS_TURNOVER1 + CURR_CAPITAL_RATIO1 + PROPRIETARY_RATIO1 + TOTAL_DEBT_RATIO1 + + Note: Each tag will consist of maximum 5 sets with suffix 1 to 5. But it is optional, depending on how many years of FH & XBRL data displayed in the report. + example: |+ + + 12.39 + 2.63 + 0.00 + 0.00 + 0.00 + 20.53 + 4.84 + 0.00 + 0.00 + 0.00 + -72.01 + -8.16 + -0.00 + -0.00 + -0.00 + 1.66 + 1.84 + 2.42 + 2.54 + 1.78 + 0.74 + 0.62 + 0.50 + 0.46 + 0.55 + -28.51 + -59.33 + -89.51 + -101.59 + -75.15 + 128.51 + 168.27 + 189.51 + 201.59 + 175.15 + + properties: + RATE_NET_PROFIT1 : + type: string + description: |+ + Rate of Net Profit On Sales (%) + Subsequent Years: + RATE_NET_PROFIT2 + RATE_NET_PROFIT3 + RATE_NET_PROFIT4 + RATE_NET_PROFIT5 + example: "12.39" + RET_INVESTMENT1 : + type: string + description: |+ + Return of Investment (%) + Subsequent Years: + RET_INVESTMENT2 + RET_INVESTMENT3 + RET_INVESTMENT4 + RET_INVESTMENT5 + example: "20.53" + RET_SH_FUNDS1 : + type: string + description: |+ + Return of Shareholder’s Funds (%) + Subsequent Years: + RET_SH_FUNDS2 + RET_SH_FUNDS3 + RET_SH_FUNDS4 + RET_SH_FUNDS4 + example: "-72.01" + TOT_ASSETS_TURNOVER1 : + type: string + description: |+ + Total Assets Turnover (%) + Subsequent Years: + TOT_ASSETS_TURNOVER2 + TOT_ASSETS_TURNOVER3 + TOT_ASSETS_TURNOVER4 + TOT_ASSETS_TURNOVER5 + example: "1.66" + CURR_CAPITAL_RATIO1: + type: string + description: |+ + Current / Working Capital Ratio (%) + Subsequent Years: + CURR_CAPITAL_RATIO2 + CURR_CAPITAL_RATIO3 + CURR_CAPITAL_RATIO4 + CURR_CAPITAL_RATIO5 + example: "0.74" + PROPRIETARY_RATIO1: + type: string + description: |+ + Proprietary Ratio (%) 1 + Subsequent Years: + PROPRIETARY_RATIO2 + PROPRIETARY_RATIO3 + PROPRIETARY_RATIO4 + PROPRIETARY_RATIO5 + example: "-28.51" + TOTAL_DEBT_RATIO1 : + type: string + description: |+ + Total Debt to Equity Ratio (%) 1 + Subsequent Years: + TOTAL_DEBT_RATIO2 + TOTAL_DEBT_RATIO3 + TOTAL_DEBT_RATIO4 + TOTAL_DEBT_RATIO5 + example: "128.51" + LIST_FH_CHART_INFO : + type: array + example: |+ + + + 1121483.0 + 10877254 + 2008 + + + description: |+ + List of chart info with following children: + [FH_CHART_INFO] + items: + properties: + FH_CHART_INFO: + type: object + description: |+ + Chart Info info with following children: + YEAR + REVENUE + PROFIT_LOSS + properties: + PROFIT_LOSS: + type: string + example: "1121483.0" + description: Profit / Loss Before Tax of the year + REVENUE: + type: string + example: "10877254" + description: Revenue Amount of the year + YEAR: + type: string + example: "2008" + description: Financial Year + unauthorized: + type: object + properties: + message: + type: string + example: Missing Authentication Token + status: + type: string + example: Failure + forbidden: + type: object + properties: + message: + type: string + example: Access Denied Unauthorized User + status: + type: string + example: Failure + paymentrequired: + type: object + properties: + message: + type: string + example: Insufficient Credits Kindly Top Up + status: + type: string + example: Failure + notfound: + type: object + properties: + message: + type: string + example: Invalid Request URL + status: + type: string + example: Failure + servererror: + type: object + properties: + message: + type: string + example: Internal Server Error + status: + type: string + example: Failure + gatewaytimeout: + type: object + properties: + message: + type: string + example: Request Timeout + status: + type: string + example: Failure + inputfieldmissing: + type: object + properties: + message: + type: string + example: Input Field Missing + status: + type: string + example: Failure + inputlimitexceeded: + type: object + properties: + message: + type: string + example: Input Limit Exceeded + status: + type: string + example: Failure + invalidinput: + type: object + properties: + message: + type: string + example: Invalid Input + status: + type: string + example: Failure + REQUEST: + type: object + properties: + TOT_ITEMS: + type: number + example: 1 + description: Number of subjects being enquired relating to the Run + default: false + ENQUIRY: + type: object + example: |+ + "197601887ETRANSTAR TRAVEL PTE LTD" + description: Contains information of each request details + default: true + properties: + SUBJECT_IDNO: + type: string + example: 199707714C + description: "Subject’s ID Number (individual) or Registration Number (company/business) as captured in DDP" + default: true + SUBJECT_NAME: + type: string + example: GPS INDUSTRIES PTE LTD + description: Subjects Name as captured in DDP + default: false + versions: + type: object + properties: + v0.1.0: + type: array + items: + oneOf: + - type: string + example: Published Date - Aug 15, 2019 + description: Initial version release + securitySchemes: + APIAuthorizer: + type: apiKey + name: x-api-key + in: header + x-amazon-apigateway-authtype: custom + description: Authentication is done using the x-api-key in the request header diff --git a/data/d&b_business_check_plus_sg.yaml b/data/d&b_business_check_plus_sg.yaml new file mode 100644 index 000000000..a96609776 --- /dev/null +++ b/data/d&b_business_check_plus_sg.yaml @@ -0,0 +1,1705 @@ +openapi: 3.0.1 +info: + title: D&B Business Check Plus (SG) + description: The Data microservice provides key business information, litigation information (High and Subordinate Courts) and Winding Up Trace of a company including the Business name, registration number, registered address and date of change, company status, registered activities, shareholders details (i.e. date of commencement, residing address) capital amount and shares allocated to each shareholder, litigation information. Updated daily. + x-additionalinfo: |+ + Suggested Use Cases: + - Software solutions targeted at corporate finance and legal domains, e.g. in cases of mergers, joint ventures or partnerships. + + - Aside from being able to protect your business via litigation checks to safeguard against reputational risk by avoiding companies potentially involved in financial crimes, the information from this microservice can serve as a quick solution for analysts or lawyers in a company whom are looking to draft documents related to cooperate finance or legal domains with one quick search. + version: '0.1.0' + x-subscribelink: d&b_business_check_plus_sg +servers: + - url: 'https://api.sentient.io' +tags: +- name: "v0.1.0" + description: "Published Date - Aug 15, 2019" +paths: + /dnb/prod/sbcp: + post: + tags: + - v0.1.0 + summary: Adds a new user + requestBody: + content: + application/xml: + schema: + $ref: '#/components/schemas/REQUEST' + responses: + '200': + description: success response + content: + application/xml: + schema: + $ref: '#/components/schemas/success' + example: |+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + 300 + + + + + + + + + + + + + + + + + + + + + + + ABUTHAHIR ABDUL GAFOOR S1676216D + Liquidator + EL TICI FINANCIAL ADVISORY SERVICES PTE. LTD. 1 RAFFLES PLACE #20-01 + OUB CENTRE SINGAPORE 048616 30/03/2009 + + ANGELA ANG + S1633336D + Liquidator + KING FINANCIAL ADVISORY SERVICES LEVEL 17 MLC CENTRE 19029 MARTIN PLACE SYDNEY NSW 2000 AUSTRALIA 18/02/2009 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + +
+ + + + + + +
+ + + + + + + + + 30000.00 + + 28000.00 + + 27,000.00 + + + '401': + description: Unauthorized + content: + application/json: + schema: + $ref: '#/components/schemas/unauthorized' + '402': + description: Payment Required + content: + application/json: + schema: + $ref: '#/components/schemas/paymentrequired' + '403': + description: Forbidden + content: + application/json: + schema: + $ref: '#/components/schemas/forbidden' + '404': + description: Not Found + content: + application/json: + schema: + $ref: '#/components/schemas/notfound' + '419': + description: Input Field Missing + content: + application/json: + schema: + $ref: '#/components/schemas/inputfieldmissing' + '413': + description: Input Limit Exceeded + content: + application/json: + schema: + $ref: '#/components/schemas/inputlimitexceeded' + '415': + description: Invalid Input + content: + application/json: + schema: + $ref: '#/components/schemas/invalidinput' + '500': + description: Internal Server Error + content: + application/json: + schema: + $ref: '#/components/schemas/servererror' + '504': + description: Gateway Timeout + content: + application/json: + schema: + $ref: '#/components/schemas/gatewaytimeout' + security: + - APIAuthorizer: [] +components: + schemas: + success: + type: object + properties: + REPORT: + type: object + example: + description: |+ + Report details with following children: + [META_INFO] + [REGISTRY_DETAIL] + [REQ_SEARCH_INFO] + [EMPLOYEE_SIZE] + [LIST_BIZ_BRANCH] + [LIST_REG_CHARGES] + [LIST_LIQUIDATOR] + [LIST_WINDING_UP] + [LIST_LITIGATION] + [LIST_SHARE_INTEREST_COMP] + [LIST_NAME_CHANGE] + [LIST_SHAREHOLDER] + [LIST_CAPITAL] + [LIST_OFFICER_OWNER] + [LIST_SALES_REVENUE_AMOUNT] + properties: + META_INFO: + type: object + example: |+ + + + + + + + description: |+ + Meta Information details with following children: + SERVICE + SYSTEM_ID + CREATION_DATE + USER_ID + CLASS + properties: + SERVICE: + type: string + description: Report requested + example: "BCP" + SYSTEM_ID : + type: string + description: System ID + example: "DDP" + CREATION_DATE: + type: datetime + description: Report request date + example: Wed Apr 08 11:37:51 MYT 2009 + USER_ID : + type: string + description: Valid user id in DDP system. It is for (For internal use) + example: N/A + CLASS: + type: string + description: Class location for metabean. It is for (For internal use) + example: N/A + REGISTRY_DETAIL : + type: object + example: |+ + + + + + + + + + + + + + + + + + + + + + + description: |+ + Registry Details with following children: + RENEWAL_DATE + ADDRESS1 + ADDRESS2 + ADDRESS3 + ADDRESS4 + COMP_TYPE_CODE + REG_DATE + REG_ACTIVITY1 + REG_ACTIVITY2 + ACC_DATE + STATUS_EFFECT_DATE + NAME_EFFECT_DATE + EXPIRY_DATE + COMP_TYPE + CHANGE_ADDR_DATE + COMP_STATUS + REG_ACTIVITY_DESC1 + REG_ACTIVITY_DESC2 + AUDITOR + AUDITOR_APPMT_DATE + LAST_AR_DATE + LAST_AGM_DATE + COUNTRY_INCORP + properties: + RENEWAL_DATE: + type: string + description: Renewal Date + example: "23/12/2008" + ADDRESS1: + type: string + description: Address Line 1 + example: "1 HARBOURFRONT AVENUE , 18 - 01" + ADDRESS2: + type: string + description: Address Line 2 + example: "KEPPEL BAY TOWER" + ADDRESS3: + type: string + description: Address Line 3 + example: "098632" + ADDRESS4: + type: string + description: Address Line 4 + example: "SINGAPORE" + COMP_TYPE_CODE: + type: string + example: CP + description: |+ + Report Code. Available values are: + 1. CP Corporate + 2. SP Sole Proprietor + REG_DATE: + type: string + description: Registration Date + example: "14/10/1974" + REG_ACTIVITY1: + type: string + description: Registered Activities 1 + example: "OTHER INVESTMENT HOLDING COMPANIES" + REG_ACTIVITY2: + type: string + description: Registered Activities 2 + example: "SHIP MANAGEMENT SERVICES" + ACC_DATE: + type: string + description: Account Date + example: "31/12/2007" + STATUS_EFFECT_DATE: + type: string + description: Status Effective Date + example: "14/10/1974" + NAME_EFFECT_DATE: + type: string + description: Name Effective Date + example: "14/10/1974" + EXPIRY_DATE: + type: string + description: Expiry Date + example: "25/10/2009" + COMP_TYPE: + type: string + description: Company Type + example: "LIMITED PRIVATE COMPANY" + CHANGE_ADDR_DATE: + type: string + description: Change Address Date + example: "09/05/2003" + COMP_STATUS: + type: string + description: Company Status + example: "Live Company" + REG_ACTIVITY_DESC1: + type: string + description: Registered Activities Description + example: + REG_ACTIVITY_DESC2: + type: string + description: Registered Activities Description + example: + AUDITOR: + type: string + description: Auditor Name + example: + AUDITOR_APPMT_DATE: + type: string + description: Auditor Appointment Date + example: "13/06/1990" + LAST_AR_DATE: + type: string + description: Date of Last AR + example: "30/06/2008" + LAST_AGM_DATE: + type: string + description: Date of Last AGM + example: "11/06/2008" + COUNTRY_INCORP: + type: string + description: Country Incorporated + example: "SINGAPORE" + REQ_SEARCH_INFO : + type: object + example: |+ + + + + + + + description: |+ + Request criteria & search record with following children: + COMP_NAME + REG_NO + REQ_DATE + REQ_REG_NO + REQ_NAME + REQ_DATE_STR + properties: + COMP_NAME: + type: string + description: Company Name + example: "KAPAL MANAGEMENT (PRIVATE) LIMITED" + REG_NO: + type: string + description: Subject’s ID Number (individual) or Registration Number (company/business) + example: "197401835M" + REQ_DATE: + type: datetime + description: Report Requested Date + example: 2009-04-08 11:36:03.611 + REQ_REG_NO: + type: string + description: Request Registration Number + example: "197401835M" + REQ_NAME: + type: string + description: Request Name + example: "KAPAL MANAGEMENT (PRIVATE) LIMITED" + REQ_DATE_STR: + type: string + description: Request Date String + example: "08/04/2009 11:36:03" + EMPLOYEE_SIZE : + type: object + description: |+ + Employee Size details with following children: + ELEMENTS + AMOUNT + example: |+ + + + 300 + + properties: + ELEMENTS: + type: string + description: Description + example: "Employee Size" + AMOUNT: + type: integer + description: Number of employee + example: 300 + LIST_BIZ_BRANCH : + type: array + description: |+ + List of Business Branches with following children: + [BIZ_BRANCH] + example: |+ + + + + + + + items: + properties: + BIZ_BRANCH : + type: object + description: |+ + Business Branches with following children: + ADDR_BUILDING + ADDR_POSTCODE + ADDR_ADDRESS1 + example: |+ + + + + + + properties: + ADDR_BUILDING: + type: string + description: Building Name + example: + ADDR_POSTCODE: + type: string + description: Postcode + example: 289848 + ADDR_ADDRESS1: + type: string + description: Address + example: 251A ARCADIA ROAD + LIST_REG_CHARGES: + type: array + description: |+ + List of Registered Charges with following children: + [REG_CHARGES] + example: |+ + + + + + + + + + + items: + properties: + REG_CHARGES : + type: object + description: |+ + Registered Charges details with following children: + CHARGE_NO + CHARGE_DATE + CHARGEE_COMP + CURRENCY + AMT_SECURED + STATUS_SATISFACTION + example: |+ + + + + + + + + + properties: + CHARGE_NO : + type: string + description: Charge No. + example: 8205117 + CHARGE_DATE: + type: string + description: Charge Date + example: 26/11/1982 + CHARGEE_COMP: + type: string + description: Charges Company + example: UNITED OVERSEAS BANK LIMITED + CURRENCY: + type: string + description: Currency + example: + AMT_SECURED: + type: string + description: Amount Secured + example: 1000.00 + STATUS_SATISFACTION: + type: string + description: Status of Satisfaction + example: + LIST_LIQUIDATOR: + type: array + description: |+ + List of Liquidator / Receiver / Judicial Manager with following children: + [LIQUIDATOR] + example: |+ + + + ABUTHAHIR ABDUL GAFOOR S1676216D + Liquidator + EL TICI FINANCIAL ADVISORY SERVICES PTE. LTD. 1 RAFFLES PLACE #20-01 + OUB CENTRE SINGAPORE 048616 30/03/2009 + + + items: + properties: + LIQUIDATOR : + type: object + description: |+ + Liquidator details with following children: + LIQ_POSITION + LIQ_ID + LIQ_NAME + LIQ_COMP + LIQ_ADDRESS1 + LIQ_ADDRESS2 + LIQ_ADDRESS3 + LIQ_ADDRESS4 + LIQ_APPOINTMENT_DATE + example: |+ + + ABUTHAHIR ABDUL GAFOOR + S1676216D + Liquidator + EL TICI FINANCIAL ADVISORY SERVICES PTE. LTD. + 1 RAFFLES PLACE + #20-01 + OUB CENTRE + SINGAPORE 048616 + 30/03/2009 + + properties: + LIQ_POSITION: + type: string + description: Liquidator / Receiver / Judicial Manager Position + example: Liquidator + LIQ_ID: + type: string + description: Liquidator / Receiver / Judicial Manager ID + example: S1676216D + LIQ_NAME : + type: string + description: Liquidator / Receiver / Judicial Manager Name + example: ABUTHAHIR ABDUL GAFOOR + LIQ_COMP: + type: string + description: Liquidator / Receiver / Judicial Manager Company Name + example: EL TICI FINANCIAL ADVISORY SERVICES PTE. LTD. + LIQ_ADDRESS1: + type: string + description: Liquidator / Receiver / Judicial Manager Address 1 + example: 1 RAFFLES PLACE + LIQ_ADDRESS2: + type: string + description: Liquidator / Receiver / Judicial Manager Address 2 + example: #20-01 + LIQ_ADDRESS3: + type: string + description: Liquidator / Receiver / Judicial Manager Address 3 + example: OUB CENTRE + LIQ_ADDRESS4: + type: string + description: Liquidator / Receiver / Judicial Manager Address 4 + example: SINGAPORE 048616 + LIQ_APPOINTMENT_DATE: + type: string + description: Liquidator / Receiver / Judicial Manager Appointment Date + example: 30/03/2009 + LIST_WINDING_UP : + type: array + description: |+ + List of Winding Up with following children: + [WINDING_UP] + example: |+ + + + + + + + + + + + + + + + + + + + + + items: + properties: + WINDING_UP : + type: object + description: |+ + Winding Up details with following children: + CASE_CODE + CASE_YEAR + PLAINTIFF + PLA_SOLICITOR_ID + PLA_FILE_REF + PLA_LAW_FIRM + SUBJECT_NAME + COURT_CODE + CASE_TYPE + CURRENCY1 + AMOUNT1 + CURRENCY2 + AMOUNT2 + CURRENCY3 + AMOUNT3 + ACTION_DATE + BANKRUPTCY_ACT + HEARING_DATE + PLA_SOLICITOR + example: |+ + + + + + + + + + + + + + + + + + + + + properties: + CASE_CODE : + type: string + description: Case Code + example: 40000 + CASE_YEAR : + type: string + description: Case Year + example: 1999 + PLAINTIFF : + type: string + description: Plaintiff Name + example: + PLA_SOLICITOR_ID : + type: string + description: Pla. Solicitor ID + example: + PLA_FILE_REF : + type: string + description: Pla. File Ref. + example: + PLA_LAW_FIRM : + type: string + description: Pla. Law Firm + example: NAME2 + SUBJECT_NAME : + type: string + description: Subject Name + example: PROACTIVE BUILDERS + COURT_CODE : + type: string + description: Court Code + example: CWU + CASE_TYPE : + type: string + description: Case Type + example: COMPANY WINDING UP PETITION + CURRENCY1 : + type: string + description: Currency 1 + example: SGD + AMOUNT1 : + type: string + description: Amount 1 + example: 41,424.52 + CURRENCY2 : + type: string + description: Currency 2 + example: MYR + AMOUNT2 : + type: string + description: Amount 2 + example: 0.00 + CURRENCY3 : + type: string + description: Currency 3 + example: + AMOUNT3 : + type: string + description: Amount 3 + example: 0.00 + ACTION_DATE : + type: string + description: Action Date + example: 11/05/2007 + BANKRUPTCY_ACT : + type: string + description: Act of Bankruptcy + example: Petition for Winding Up + HEARING_DATE : + type: string + description: Hearing Date + example: 15/12/2007 + PLA_SOLICITOR : + type: string + description: Pla. Solicitor + example: + LIST_LITIGATION : + type: array + description: |+ + List of Winding Up with following children: + [LITIGATION] + example: |+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + items: + properties: + LITIGATION : + type: object + description: |+ + List of Winding Up with following children: + SUBJECT_NAME + NATURE_OF_CLAIM + STATUS_DATE + CASE_NO + DOC_REMARK + CURRENCY1 + CURRENCY2 + CURRENCY3 + CURRENCY4 + CURRENCY5 + DEF_SOLICITOR + DEF_SOLICITOR_ID + DEF_LAW_FIRM + DEF_FILE_REF + DATE_OF_WRIT + STATUS + AMOUNT1 + AMOUNT2 + AMOUNT3 + AMOUNT4 + AMOUNT5 + PLAINTIFF + PLA_SOLICITOR + PLA_SOLICITOR_ID + PLA_LAW_FIRM + PLA_FILE_REF + PLA_ID + PLA_STATUS + PLA_STATUS_DATE + example: |+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + properties: + SUBJECT_NAME : + type: string + description: Subject Name + example: "SOON SOON SEAFOOD" + NATURE_OF_CLAIM : + type: string + example: "CONTRACT 3" + description: Nature of Claim + STATUS_DATE : + type: string + example: "01/05/2008" + description: Status Date + CASE_NO : + type: string + example: "MC 40001 / 1999" + description: Case No + DOC_REMARKS : + type: string + example: "NOTICE OF DISCONTINUANCE/WITHDRAWAL 3" + description: Document Remark + CURRENCY1 : + type: string + example: "SGD" + description: Currency 1 + CURRENCY2 : + type: string + example: "MYR" + description: Currency 2 + CURRENCY3 : + type: string + example: "USD" + description: Currency 3 + CURRENCY4 : + type: string + example: "-" + description: Currency 4 + CURRENCY5 : + type: string + example: "-" + description: Currency 5 + DEF_SOLICITOR : + type: string + example: "SOL2" + description: Def. Solicitor + DEF_SOLICITOR_ID : + type: string + example: "20000000" + description: Def. Solicitor ID + DEF_LAW_FIRM : + type: string + example: "NAME2" + description: Def. Law Firm + DEF_FILE_REF : + type: string + example: "FILE2" + description: Def. File Ref. + DATE_OF_WRIT : + type: string + example: "01/01/2008" + description: Date Writ + STATUS : + type: string + example: "CONCLUDED 3" + description: Status + AMOUNT1 : + type: string + example: "100.00" + description: Amount 1 + AMOUNT2 : + type: string + example: "200.00" + description: Amount 2 + AMOUNT3 : + type: string + example: "0.00" + description: Amount 3 + AMOUNT4 : + type: string + example: "400.00" + description: Amount 4 + AMOUNT5 : + type: string + example: "0.00" + description: Amount 5 + PLAINTIFF : + type: string + example: "MC 40001" + description: Plaintiff Name + PLA_SOLICITOR: + type: string + example: "SOL2" + description: plantiff Solicitor + PLA_SOLICITOR_ID: + type: string + example: "20000000" + description: plantiff Solicitor ID + PLA_LAW_FIRM : + type: string + example: "NAME2" + description: Pla. Law Firm + PLA_FILE_REF : + type: string + example: "FILE2" + description: Pla. File Ref. + PLA_ID: + type: string + example: "S0739038F" + description: Plaintiff ID + PLA_STATUS: + type: string + example: "SETTLED - BEFORE SET DOWN" + description: Plaintiff Status + PLA_STATUS_DATE : + type: string + example: "17/10/2016" + description: Plaintiff Status Date + LIST_SHARE_INTEREST_COMP : + type: array + description: |+ + List of Share Interest In Companies with following children: + [SHARE_INTEREST_COMP] + example: |+ + + + + + + + + + items: + properties: + SHARE_INTEREST_COMP : + type: object + description: |+ + Share Interest In Companies details with following children: + COMP_NAME + SHARE_OWNED_UNIT + SHARE_OWNED_PERCENT + STATUS + example: |+ + + + + + + + properties: + COMP_NAME : + type: string + description: Company Name + example: ORCHID (HOLDINGS) PTE. LTD. + SHARE_OWNED_UNIT : + type: string + description: Shares Owned Unit + example: 500000 + SHARE_OWNED_PERCENT : + type: string + description: Shares Owned Value (%) + example: 100.00 + STATUS : + type: string + description: Status + example: DISSOLVED - MEMBERS' VOLUNTARY WINDING UP + LIST_NAME_CHANGE : + type: array + description: |+ + List of Change of Company/Business Name(s) with following children: + [NAME_CHANGE] + example: |+ + + + + + + + items: + properties: + NAME_CHANGE : + type: object + description: |+ + Change of Company/Business Name(s) with following children: + PREV_NAME + EFFECT_DATE + example: |+ + + + + + properties: + PREV_NAME : + type: string + description: Previous Name + example: HUA XI EATING HOUSE + EFFECT_DATE : + type: string + description: Effective Date + example: 25/10/1997 00:00:00 + LIST_SHAREHOLDER : + type: array + description: |+ + List of Shareholders with following children: + [SHAREHOLDER] + example: |+ + + +
+ + + + + + + + + + items: + properties: + SHAREHOLDER : + type: object + description: |+ + Shareholders details with following children: + ADDRESS + COMP_ID + NO_OF_SHARE + CURRENCY + SHAREHOLDER_TYPE + SHARE_TYPE + SHAREHOLDER_NAME + CHANGE_ADDR_DATE + ADDR_TYPE + NATIONALITY + example: |+ + +
+ + + + + + + + + + + properties: + ADDRESS : + type: string + description: Address + example: 1 HARBOURFRONT AVENUE , 18 – 01; KEPPEL BAY TOWER; 098632, SINGAPORE + COMP_ID : + type: string + description: Company/ Identity No. + example: 198200406H + NO_OF_SHARE : + type: string + description: No. of Shares + example: 657 + CURRENCY : + type: string + description: Currency + example: UNITED STATES OF AMERICA, DOLLARS + SHAREHOLDER_TYPE : + type: string + description: |+ + Indicator for Shareholder type. + Possible values are: + 1 Individual + 2 Company + 3 Unregistered foreign company + 4 Unregistered local company + example: 2 + SHARE_TYPE : + type: string + description: Share Type + example: Preference + SHAREHOLDER_NAME : + type: string + description: Shareholder Name + example: KEPPEL COMMUNICATIONS PTE LTD + CHANGE_ADDR_DATE : + type: string + description: Change Address Date + example: 09/05/2003 + ADDR_TYPE : + type: string + description: |+ + Address Type, indicates if it is Singapore or foreign address. + Possible values are: + S Indicates Singapore address + - Indicates foreign address + example: S + NATIONALITY : + type: string + description: Nationality + example: SINGAPORE + LIST_CAPITAL : + type: array + description: |+ + List of Capital details with following children: + [CAPITAL] + example: |+ + + + + + + + + + + items: + properties: + CAPITAL : + type: object + description: |+ + Capital details with following children: + CAPITAL_CATEGORY + CAPITAL_TYPE + CURRENCY + CAPITAL_AMT + NO_OF_SHARES + example: |+ + + + + + + + + properties: + CAPITAL_CATEGORY : + type: string + description: Capital Category + example: Issued + CAPITAL_TYPE : + type: string + description: Capital Type + example: Ordinary + CURRENCY : + type: string + description: Currency + example: SINGAPORE, DOLLARS + CAPITAL_AMT : + type: string + description: Capital Amount + example: 100,000.00 + NO_OF_SHARES : + type: string + description: Nos. of Shares + example: 100,000 + LIST_OFFICER_OWNER : + type: array + description: |+ + List of Officer(s) / Owner(s) with following children: + [OFFICER_OWNER] + example: |+ + + +
+ + + + + + + + items: + properties: + OFFICER_OWNER : + type: object + description: |+ + Officer(s) / Owner(s) details with following children: + ADDRESS + IDENTITY_ID + PA_REG_NO + POSITION + ADDR_TYPE + CESSATION_DATE + OFFICER_NAME + CHANGE_ADDR_DATE + APPMT_DATE + NATIONALITY + example: |+ + +
+ + + + + + + + + + properties: + ADDRESS : + type: string + description: Address + example: 50A TOH TUCK ROAD, 04 - 08 ; SIGNATURE PARK; 596742, SINGAPORE + IDENTITY_ID : + type: string + description: Identity No. + example: S1674174D + PA_REG_NO : + type: string + description: Public Accountant Registration No. + example: 00091 + POSITION : + type: string + description: Position + example: DIRECTOR + ADDR_TYPE : + type: string + description: |+ + Address Type, indicates if it is Singapore or foreign address. + Possible values are: + S Indicates Singapore address + - Indicates foreign address + example: S + CESSATION_DATE : + type: string + description: Cessation Date + example: 30/10/2003 + OFFICER_NAME : + type: string + description: Officer Name + example: HENRY GOH + CHANGE_ADDR_DATE : + type: string + description: Change Address Date + example: 30/10/2003 + APPMT_DATE : + type: string + description: Appointment Date + example: 30/10/2003 + NATIONALITY : + type: string + description: Nationality + example: SINGAPORE P.R. + LIST_SALES_REVENUE_AMOUNT : + type: array + description: |+ + List of Sales Revenue Amount with following children: + [SALES_REVENUE_AMOUNT] + example: |+ + + + 30000.00 + + + items: + properties: + SALES_REVENUE_AMOUNT : + type: object + description: |+ + Sales Revenue Amount details with following children: + ELEMENTS + YEAR + CURRENCY + AMOUNT + example: |+ + + + + + 30000.00 + + properties: + ELEMENTS : + type: string + description: Description + example: Sales Revenue Amount + YEAR : + type: string + description: Year + example: 2008 + CURRENCY : + type: string + description: Currency + example: SGD + AMOUNT : + type: string + description: Amount. Amount values that higher than 1000 have a comma to delimit every 3 digits of the amount value. + example: 30000.00 + LIST_Ddrptcount : + type: array + description: |+ + List of Search By Financial Sectors and Search By Non- Financial Sectors with following children: + [Ddrptcount] + example: + items: + properties: + Ddrptcount : + type: object + description: |+ + 6 XML tags (open then close) displays + Search By Financial Sectors (counts for 3 recent years) + Search By Non- Financial Sectors (counts for 3 recent years) + Following children are: + Rcyear + RcFlag (only respond for the year exists) + Rcjan + Rcfeb + Rcmar + Rcapr + Rcmay + Rcjun + Rcjul + Rcaug + Rcsep + Rcoct + Rcnov + Rcdec + Rcid (only respond for the year exists) Rcreg (only respond for the year exists) Rcrptyid (only respond for the year exists) + Rcsecflag + LastUpdateDate (only respond for the year exists) + example: + properties: + Rcyear : + type: string + description: To show the year + example: 2017 + RcFlag : + type: string + description: Internal database value + example: N/A + Rcjan : + type: integer + description: Count for January + example: 1 + Rcfeb : + type: integer + description: Count for February + example: 1 + Rcmar : + type: integer + description: Count for March + example: 1 + Rcapr : + type: integer + description: Count for April + example: 1 + Rcmay : + type: integer + description: Count for May + example: 1 + Rcjun : + type: integer + description: Count for June + example: 1 + Rcjul : + type: integer + description: Count for July + example: 1 + Rcaug : + type: integer + description: Count for August + example: 1 + Rcsep : + type: integer + description: Count for September + example: 1 + Rcoct : + type: integer + description: Count for October + example: 1 + Rcnov : + type: integer + description: Count for November + example: 1 + Rcdec : + type: integer + description: Count for December + example: 1 + Rcid : + type: string + description: |+ + Internal database value, respond value from table Primary Key ID + It is for (For internal use) + example: N/A + Rcreg : + type: string + description: Company Registration Number + example: + Rcrptyid : + type: string + description: |+ + Product Type. Possible values are: + 1. Biz Check: 0001 + 2. Biz Check Plus: 0002 + example: 0001 + Rcsecflag : + type: integer + description: Differentiate Search By Financial Sectors and Search By Non- Financial Sectors + example: 1 + LastUpdateDate : + type: datetime + description: Last update date + example: YYYY-MM-DD 00:00:00.0 + unauthorized: + type: object + properties: + message: + type: string + example: Missing Authentication Token + status: + type: string + example: Failure + forbidden: + type: object + properties: + message: + type: string + example: Access Denied Unauthorized User + status: + type: string + example: Failure + paymentrequired: + type: object + properties: + message: + type: string + example: Insufficient Credits Kindly Top Up + status: + type: string + example: Failure + notfound: + type: object + properties: + message: + type: string + example: Invalid Request URL + status: + type: string + example: Failure + servererror: + type: object + properties: + message: + type: string + example: Internal Server Error + status: + type: string + example: Failure + gatewaytimeout: + type: object + properties: + message: + type: string + example: Request Timeout + status: + type: string + example: Failure + inputfieldmissing: + type: object + properties: + message: + type: string + example: Input Field Missing + status: + type: string + example: Failure + inputlimitexceeded: + type: object + properties: + message: + type: string + example: Input Limit Exceeded + status: + type: string + example: Failure + invalidinput: + type: object + properties: + message: + type: string + example: Invalid Input + status: + type: string + example: Failure + REQUEST: + type: object + properties: + TOT_ITEMS: + type: number + example: 1 + description: Number of subjects being enquired relating to the Run + default: false + ENQUIRY: + type: object + example: |+ + 197601887ETRANSTAR TRAVEL PTE LTD + description: Contains information of each request details + default: true + properties: + SUBJECT_IDNO: + type: string + example: 199707714C + description: "Subject’s ID Number (individual) or Registration Number (company/business) as captured in DDP" + default: true + SUBJECT_NAME: + type: string + example: GPS INDUSTRIES PTE LTD + description: Subjects Name as captured in DDP + default: false + versions: + type: object + properties: + v0.1.0: + type: array + items: + oneOf: + - type: string + example: Published Date - Aug 15, 2019 + description: Initial version release + securitySchemes: + APIAuthorizer: + type: apiKey + name: x-api-key + in: header + x-amazon-apigateway-authtype: custom + description: Authentication is done using the x-api-key in the request header diff --git a/data/d&b_business_check_sg.yaml b/data/d&b_business_check_sg.yaml new file mode 100644 index 000000000..3bcfe57af --- /dev/null +++ b/data/d&b_business_check_sg.yaml @@ -0,0 +1,1149 @@ +openapi: 3.0.1 +info: + title: D&B Business Check (SG) + description: |+ + This Data microservice provides key business information of a Singapore-registered company and includes the business name, registration number, registered address and date of change, company status, registered activities, shareholders details (i.e. date of commencement, residing address) capital amount and shares allocated to each shareholders. Updated daily. + x-additionalinfo: |+ + Suggested Use Cases: + - For software solutions that require general background checks of a company. This microservice can provide a high level of scrutiny of potential business associates, and throw light on the risks that cannot be detected by geopolitical analysis or batch screening levels. + + - For example, this microservice can be used to check if a Singapore-registered company meets regulations, such as if the company complies with anti-money laundering, anti-bribery, and corruption regulations by looking at registered activities, shareholders details, and more. + + - It can also be used to simplify the due diligence process, by identify risk issues using a range of reports that meet different compliance requirements. + + - It can also be used to protect your business – safeguard against reputational risk by avoiding those involved in financial crime. + + - It can also be used for finance-related domains such as vehicle leasing, loans, enterprise credit terms and so on. Updated daily. + version: '0.1.0' + x-subscribelink: d&b_business_check_sg +servers: + - url: 'https://api.sentient.io' +tags: +- name: "v0.1.0" + description: "Published Date - Aug 15, 2019" +paths: + /dnb/prod/sbc: + post: + tags: + - v0.1.0 + summary: Adds a new user + requestBody: + content: + application/xml: + schema: + $ref: '#/components/schemas/REQUEST' + responses: + '200': + description: success response + content: + application/xml: + schema: + $ref: '#/components/schemas/success' + example: |+ + string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string 0
string
+ + string string string string string string string string string string string string string
string
+ + string string string string string string string string string string string string string string string + '401': + description: Unauthorized + content: + application/json: + schema: + $ref: '#/components/schemas/unauthorized' + '402': + description: Payment Required + content: + application/json: + schema: + $ref: '#/components/schemas/paymentrequired' + '403': + description: Forbidden + content: + application/json: + schema: + $ref: '#/components/schemas/forbidden' + '404': + description: Not Found + content: + application/json: + schema: + $ref: '#/components/schemas/notfound' + '419': + description: Input Field Missing + content: + application/json: + schema: + $ref: '#/components/schemas/inputfieldmissing' + '413': + description: Input Limit Exceeded + content: + application/json: + schema: + $ref: '#/components/schemas/inputlimitexceeded' + '415': + description: Invalid Input + content: + application/json: + schema: + $ref: '#/components/schemas/invalidinput' + '500': + description: Internal Server Error + content: + application/json: + schema: + $ref: '#/components/schemas/servererror' + '504': + description: Gateway Timeout + content: + application/json: + schema: + $ref: '#/components/schemas/gatewaytimeout' + security: + - APIAuthorizer: [] +components: + schemas: + success: + type: object + properties: + REPORT: + type: object + example: + description: |+ + Report details with following children: + [META_INFO] + [REGISTRY_DETAIL] + [REQ_SEARCH_INFO] + [EMPLOYEE_SIZE] + [LIST_BIZ_BRANCH] + [LIST_REG_CHARGES] + [LIST_LIQUIDATOR] + [LIST_SHARE_INTEREST_COMP] + [LIST_NAME_CHANGE] + [LIST_SHAREHOLDER] + [LIST_CAPITAL] + [LIST_OFFICER_OWNER] + [LIST_SALES_REVENUE_AMOUNT] + properties: + META_INFO: + type: object + example: |+ + + + + + + + + description: |+ + Meta Information details with following children: + SERVICE + SYSTEM_ID + CREATION_DATE + USER_ID + CLASS + properties: + SERVICE: + type: string + description: Report requested + example: "BC" + SYSTEM_ID : + type: string + description: System ID + example: "DDP" + CREATION_DATE: + type: datetime + description: Report request date + example: "Wed Apr 08 11:37:51 MYT 2009" + USER_ID : + type: string + description: Valid user id in DDP system. It is for (For internal use) + example: "N/A" + CLASS: + type: string + description: Class location for metabean. It is for (For internal use) + example: "N/A" + REGISTRY_DETAIL : + type: object + example: |+ + + + + + + + + + + + + + + + + + + + + + + + + + + description: |+ + Registry Details with following children: + RENEWAL_DATE + ADDRESS1 + ADDRESS2 + ADDRESS3 + ADDRESS4 + COMP_TYPE_CODE + REG_DATE + REG_ACTIVITY1 + REG_ACTIVITY2 + ACC_DATE + STATUS_EFFECT_DATE + NAME_EFFECT_DATE + EXPIRY_DATE + COMP_TYPE + CHANGE_ADDR_DATE + COMP_STATUS + REG_ACTIVITY_DESC1 + REG_ACTIVITY_DESC2 + AUDITOR + AUDITOR_APPMT_DATE + LAST_AR_DATE + LAST_AGM_DATE + COUNTRY_INCORP + properties: + RENEWAL_DATE: + type: string + description: Renewal Date + example: "23/12/2008" + ADDRESS1: + type: string + description: Address Line 1 + example: "1 HARBOURFRONT AVENUE , 18 - 01" + ADDRESS2: + type: string + description: Address Line 2 + example: "KEPPEL BAY TOWER" + ADDRESS3: + type: string + description: Address Line 3 + example: "098632" + ADDRESS4: + type: string + description: Address Line 4 + example: "SINGAPORE" + COMP_TYPE_CODE: + type: string + example: CP + description: |+ + Report Code. Available values are: + 1. CP Corporate + 2. SP Sole Proprietor + REG_DATE: + type: string + description: Registration Date + example: "14/10/1974" + REG_ACTIVITY1: + type: string + description: Registered Activities 1 + example: "OTHER INVESTMENT HOLDING COMPANIES" + REG_ACTIVITY2: + type: string + description: Registered Activities 2 + example: "SHIP MANAGEMENT SERVICES" + ACC_DATE: + type: string + description: Account Date + example: "31/12/2007" + STATUS_EFFECT_DATE: + type: string + description: Status Effective Date + example: "14/10/1974" + NAME_EFFECT_DATE: + type: string + description: Name Effective Date + example: "14/10/1974" + EXPIRY_DATE: + type: string + description: Expiry Date + example: "25/10/2009" + COMP_TYPE: + type: string + description: Company Type + example: "LIMITED PRIVATE COMPANY" + CHANGE_ADDR_DATE: + type: string + description: Change Address Date + example: "09/05/2003" + COMP_STATUS: + type: string + description: Company Status + example: "Live Company" + REG_ACTIVITY_DESC1: + type: string + description: Registered Activities Description + example: + REG_ACTIVITY_DESC2: + type: string + description: Registered Activities Description + example: + AUDITOR: + type: string + description: Auditor Name + example: + AUDITOR_APPMT_DATE: + type: string + description: Auditor Appointment Date + example: "13/06/1990" + LAST_AR_DATE: + type: string + description: Date of Last AR + example: "30/06/2008" + LAST_AGM_DATE: + type: string + description: Date of Last AGM + example: "11/06/2008" + COUNTRY_INCORP: + type: string + description: Country Incorporated + example: "SINGAPORE" + REQ_SEARCH_INFO : + type: object + example: |+ + + + + + + + + + description: |+ + Request criteria & search record with following children: + COMP_NAME + REG_NO + REQ_DATE + REQ_REG_NO + REQ_NAME + REQ_DATE_STR + properties: + COMP_NAME: + type: string + description: Company Name + example: "KAPAL MANAGEMENT (PRIVATE) LIMITED" + REG_NO: + type: string + description: Subject’s ID Number (individual) or Registration Number (company/business) + example: "197401835M" + REQ_DATE: + type: string + description: Report Requested Date + example: "2009-04-08 11:36:03.611" + REQ_REG_NO: + type: string + description: Request Registration Number + example: "197401835M" + REQ_NAME: + type: string + description: Request Name + example: "KAPAL MANAGEMENT (PRIVATE) LIMITED" + REQ_DATE_STR: + type: string + description: Request Date String + example: "08/04/2009 11:36:03" + EMPLOYEE_SIZE : + type: object + description: |+ + Employee Size details with following children: + ELEMENTS + AMOUNT + example: |+ + + + 300 + + properties: + ELEMENTS: + type: string + description: Description + example: "Employee Size" + AMOUNT: + type: string + description: Number of employee + example: "300" + LIST_BIZ_BRANCH : + type: array + description: |+ + List of Business Branches with following children: + [BIZ_BRANCH] + example: |+ + + + + + + + properties: + BIZ_BRANCH : + type: object + description: |+ + Business Branches with following children: + ADDR_BUILDING + ADDR_POSTCODE + ADDR_ADDRESS1 + example: |+ + + + + + + properties: + ADDR_BUILDING: + type: string + description: Building Name + example: + ADDR_POSTCODE: + type: string + description: Postcode + example: 289848 + ADDR_ADDRESS1: + type: string + description: Address + example: 251A ARCADIA ROAD + LIST_REG_CHARGES: + type: array + description: |+ + List of Registered Charges with following children: + [REG_CHARGES] + example: |+ + + + + + + + + + + + items: + properties: + REG_CHARGES : + type: object + description: |+ + Registered Charges details with following children: + CHARGE_NO + CHARGE_DATE + CHARGEE_COMP + CURRENCY + AMT_SECURED + STATUS_SATISFACTION + example: |+ + + + + + + + + + properties: + CHARGE_NO : + type: string + description: Charge No. + example: 8205117 + CHARGE_DATE: + type: string + description: Charge Date + example: 26/11/1982 + CHARGEE_COMP: + type: string + description: Charges Company + example: UNITED OVERSEAS BANK LIMITED + CURRENCY: + type: string + description: Currency + example: + AMT_SECURED: + type: string + description: Amount Secured + example: 0.00 + STATUS_SATISFACTION: + type: string + description: Status of Satisfaction + example: + LIST_LIQUIDATOR: + type: array + description: |+ + List of Liquidator / Receiver / Judicial Manager with following children: + [LIQUIDATOR] + example: |+ + + + ABUTHAHIR ABDUL GAFOOR S1676216D + Liquidator + EL TICI FINANCIAL ADVISORY SERVICES PTE. LTD. 1 RAFFLES PLACE #20-01 + OUB CENTRE SINGAPORE 048616 30/03/2009 + + + items: + properties: + LIQUIDATOR : + type: object + description: |+ + Liquidator details with following children: + LIQ_POSITION + LIQ_ID + LIQ_NAME + LIQ_COMP + LIQ_ADDRESS1 + LIQ_ADDRESS2 + LIQ_ADDRESS3 + LIQ_ADDRESS4 + LIQ_APPOINTMENT_DATE + example: |+ + + ABUTHAHIR ABDUL GAFOOR + S1676216D + Liquidator + EL TICI FINANCIAL ADVISORY SERVICES PTE. LTD. + 1 RAFFLES PLACE + #20-01 + OUB CENTRE + SINGAPORE 048616 + 30/03/2009 + + properties: + LIQ_POSITION: + type: string + description: Liquidator / Receiver / Judicial Manager Position + example: Liquidator + LIQ_ID: + type: string + description: Liquidator / Receiver / Judicial Manager ID + example: S1676216D + LIQ_NAME : + type: string + description: Liquidator / Receiver / Judicial Manager Name + example: ABUTHAHIR ABDUL GAFOOR + LIQ_COMP: + type: string + description: Liquidator / Receiver / Judicial Manager Company Name + example: EL TICI FINANCIAL ADVISORY SERVICES PTE. LTD. + LIQ_ADDRESS1: + type: string + description: Liquidator / Receiver / Judicial Manager Address 1 + example: 1 RAFFLES PLACE + LIQ_ADDRESS2: + type: string + description: Liquidator / Receiver / Judicial Manager Address 2 + example: #20-01 + LIQ_ADDRESS3: + type: string + description: Liquidator / Receiver / Judicial Manager Address 3 + example: OUB CENTRE + LIQ_ADDRESS4: + type: string + description: Liquidator / Receiver / Judicial Manager Address 4 + example: SINGAPORE 048616 + LIQ_APPOINTMENT_DATE: + type: string + description: Liquidator / Receiver / Judicial Manager Appointment Date + example: 30/03/2009 + LIST_SHARE_INTEREST_COMP : + type: array + description: |+ + List of Share Interest In Companies with following children: + [SHARE_INTEREST_COMP] + example: |+ + + + + + + + + + items: + properties: + SHARE_INTEREST_COMP : + type: object + description: |+ + Share Interest In Companies details with following children: + COMP_NAME + SHARE_OWNED_UNIT + SHARE_OWNED_PERCENT + STATUS + example: |+ + + + + + + + properties: + COMP_NAME : + type: string + description: Company Name + example: ORCHID (HOLDINGS) PTE. LTD. + SHARE_OWNED_UNIT : + type: string + description: Shares Owned Unit + example: 500000 + SHARE_OWNED_PERCENT : + type: string + description: Shares Owned Value (%) + example: 100.00 + STATUS : + type: string + description: Status + example: DISSOLVED - MEMBERS' VOLUNTARY WINDING UP + LIST_NAME_CHANGE : + type: array + description: |+ + List of Change of Company/Business Name(s) with following children: + [NAME_CHANGE] + example: |+ + + + + + + + items: + properties: + NAME_CHANGE : + type: object + description: |+ + Change of Company/Business Name(s) with following children: + PREV_NAME + EFFECT_DATE + example: |+ + + + + + properties: + PREV_NAME : + type: string + description: Previous Name + example: HUA XI EATING HOUSE + EFFECT_DATE : + type: string + description: Effective Date + example: 25/10/1997 00:00:00 + LIST_SHAREHOLDER : + type: array + description: |+ + List of Shareholders with following children: + [SHAREHOLDER] + example: |+ + + +
+ + + + + + + + + + items: + properties: + SHAREHOLDER : + type: object + description: |+ + Shareholders details with following children: + ADDRESS + COMP_ID + NO_OF_SHARE + CURRENCY + SHAREHOLDER_TYPE + SHARE_TYPE + SHAREHOLDER_NAME + CHANGE_ADDR_DATE + ADDR_TYPE + NATIONALITY + example: |+ + +
+ + + + + + + + + + + properties: + ADDRESS : + type: string + description: Address + example: 1 HARBOURFRONT AVENUE , 18 – 01; KEPPEL BAY TOWER; 098632, SINGAPORE + COMP_ID : + type: string + description: Company/ Identity No. + example: 198200406H + NO_OF_SHARE : + type: string + description: No. of Shares + example: 657 + CURRENCY : + type: string + description: Currency + example: UNITED STATES OF AMERICA, DOLLARS + SHAREHOLDER_TYPE : + type: string + description: Indicator for Shareholder type + example: 2 + SHARE_TYPE : + type: string + description: Share Type + example: Preference + SHAREHOLDER_NAME : + type: string + description: Shareholder Name + example: KEPPEL COMMUNICATIONS PTE LTD + CHANGE_ADDR_DATE : + type: string + description: Change Address Date + example: 09/05/2003 + ADDR_TYPE : + type: string + description: Address Type, indicates if it is Singapore or foreign address. + example: + NATIONALITY : + type: string + description: Nationality + example: SINGAPORE + LIST_CAPITAL : + type: array + description: |+ + List of Capital details with following children: + [CAPITAL] + example: |+ + + + + + + + + + + items: + properties: + CAPITAL : + type: object + description: |+ + Capital details with following children: + CAPITAL_CATEGORY + CAPITAL_TYPE + CURRENCY + CAPITAL_AMT + NO_OF_SHARES + example: |+ + + + + + + + + properties: + CAPITAL_CATEGORY : + type: string + description: Capital Category + example: Issued + CAPITAL_TYPE : + type: string + description: Capital Type + example: Ordinary + CURRENCY : + type: string + description: Currency + example: SINGAPORE, DOLLARS + CAPITAL_AMT : + type: string + description: Capital Amount + example: 100,000.00 + NO_OF_SHARES : + type: string + description: Nos. of Shares + example: 100,000 + LIST_OFFICER_OWNER : + type: array + description: |+ + List of Officer(s) / Owner(s) with following children: + [OFFICER_OWNER] + example: |+ + + +
+ + + + + + + + items: + properties: + OFFICER_OWNER : + type: object + description: |+ + Officer(s) / Owner(s) details with following children: + ADDRESS + IDENTITY_ID + PA_REG_NO + POSITION + ADDR_TYPE + CESSATION_DATE + OFFICER_NAME + CHANGE_ADDR_DATE + APPMT_DATE + NATIONALITY + example: |+ + +
+ + + + + + + + + + properties: + ADDRESS : + type: string + description: Address + example: 50A TOH TUCK ROAD, 04 - 08 ; SIGNATURE PARK; 596742, SINGAPORE + IDENTITY_ID : + type: string + description: Identity No. + example: S1674174D + PA_REG_NO : + type: string + description: Public Accountant Registration No. + example: 00091 + POSITION : + type: string + description: Position + example: DIRECTOR + ADDR_TYPE : + type: string + description: Address Type, indicates if it is Singapore or foreign address. + example: S + CESSATION_DATE : + type: string + description: Cessation Date + example: 30/10/2003 + OFFICER_NAME : + type: string + description: Officer Name + example: HENRY GOH + CHANGE_ADDR_DATE : + type: string + description: Change Address Date + example: 30/10/2003 + APPMT_DATE : + type: string + description: Appointment Date + example: 30/10/2003 + NATIONALITY : + type: string + description: Nationality + example: SINGAPORE P.R. + LIST_SALES_REVENUE_AMOUNT : + type: array + description: |+ + List of Sales Revenue Amount with following children: + [SALES_REVENUE_AMOUNT] + example: |+ + + + 30000.00 + + + items: + properties: + SALES_REVENUE_AMOUNT : + type: object + description: |+ + Sales Revenue Amount details with following children: + ELEMENTS + YEAR + CURRENCY + AMOUNT + example: |+ + + + + + 30000.00 + + properties: + ELEMENTS : + type: string + description: Description + example: Sales Revenue Amount + YEAR : + type: integer + description: Year + example: 2008 + CURRENCY : + type: string + description: Currency + example: SGD + AMOUNT : + type: integer + description: Amount + example: 30000.00 + LIST_Ddrptcount : + type: array + description: |+ + List of Search By Financial Sectors and Search By Non- Financial Sectors with following children: + [Ddrptcount] + example: + items: + properties: + Ddrptcount : + type: object + description: |+ + 6 XML tags (open then close) displays + Search By Financial Sectors (counts for 3 recent years) + Search By Non- Financial Sectors (counts for 3 recent years) + Following children are: + Rcyear + RcFlag (only respond for the year exists) + Rcjan + Rcfeb + Rcmar + Rcapr + Rcmay + Rcjun + Rcjul + Rcaug + Rcsep + Rcoct + Rcnov + Rcdec + Rcid (only respond for the year exists) Rcreg (only respond for the year exists) Rcrptyid (only respond for the year exists) + Rcsecflag + LastUpdateDate (only respond for the year exists) + example: + properties: + Rcyear : + type: string + description: To show the year + example: 2017 + RcFlag : + type: string + description: Internal database value + example: N/A + Rcjan : + type: integer + description: Count for January + example: 1 + Rcfeb : + type: integer + description: Count for February + example: 1 + Rcmar : + type: integer + description: Count for March + example: 1 + Rcapr : + type: integer + description: Count for April + example: 1 + Rcmay : + type: integer + description: Count for May + example: 1 + Rcjun : + type: integer + description: Count for June + example: 1 + Rcjul : + type: integer + description: Count for July + example: 1 + Rcaug : + type: integer + description: Count for August + example: 1 + Rcsep : + type: integer + description: Count for September + example: 1 + Rcoct : + type: integer + description: Count for October + example: 1 + Rcnov : + type: integer + description: Count for November + example: 1 + Rcdec : + type: integer + description: Count for December + example: 1 + Rcid : + type: integer + description: Internal database value + example: + Rcreg : + type: string + description: Company Registration Number + example: + Rcrptyid : + type: string + description: Product Type + example: + Rcsecflag : + type: integer + description: Differentiate Search By Financial Sectors and Search By Non- Financial Sectors + example: 1 + LastUpdateDate : + type: string + description: Last update date + example: + unauthorized: + type: object + properties: + message: + type: string + example: Missing Authentication Token + status: + type: string + example: Failure + forbidden: + type: object + properties: + message: + type: string + example: Access Denied Unauthorized User + status: + type: string + example: Failure + paymentrequired: + type: object + properties: + message: + type: string + example: Insufficient Credits Kindly Top Up + status: + type: string + example: Failure + notfound: + type: object + properties: + message: + type: string + example: Invalid Request URL + status: + type: string + example: Failure + servererror: + type: object + properties: + message: + type: string + example: Internal Server Error + status: + type: string + example: Failure + gatewaytimeout: + type: object + properties: + message: + type: string + example: Request Timeout + status: + type: string + example: Failure + inputfieldmissing: + type: object + properties: + message: + type: string + example: Input Field Missing + status: + type: string + example: Failure + inputlimitexceeded: + type: object + properties: + message: + type: string + example: Input Limit Exceeded + status: + type: string + example: Failure + invalidinput: + type: object + properties: + message: + type: string + example: Invalid Input + status: + type: string + example: Failure + REQUEST: + type: object + properties: + TOT_ITEMS: + type: number + example: 1 + description: Number of subjects being enquired relating to the Run + default: false + ENQUIRY: + type: object + example: |+ + 197601887ETRANSTAR TRAVEL PTE LTD + description: Contains information of each request details + default: true + properties: + SUBJECT_IDNO: + type: string + example: 199707714C + description: "Subject’s ID Number (individual) or Registration Number (company/business) as captured in DDP" + default: true + SUBJECT_NAME: + type: string + example: GPS INDUSTRIES PTE LTD + description: Subjects Name as captured in DDP + default: false + versions: + type: object + properties: + v0.1.0: + type: array + items: + oneOf: + - type: string + example: Published Date - Aug 15, 2019 + description: Initial version release + securitySchemes: + APIAuthorizer: + type: apiKey + name: x-api-key + in: header + x-amazon-apigateway-authtype: custom + description: Authentication is done using the x-api-key in the request header diff --git a/data/demographics_classification.yaml b/data/demographics_classification.yaml new file mode 100644 index 000000000..6fa1083f6 --- /dev/null +++ b/data/demographics_classification.yaml @@ -0,0 +1,293 @@ +openapi: 3.0.1 +info: + title: Demographics Classification + description: |+ + This Computer Vision microservice detects for faces from an input image and predicts the demographics of each face (age, gender and race). The image is given as an input encoded using base64. The microservice will a face detector and subsequently models to predict age, gender and race. The results will then be returned back to the user as a JSON output together with bounding box coordinates for each face.Races include: Asian, Indian, White, Black, Middle Eastern and Latino Hispanic + The size of your image file should **not exceed 5 MB**, and the image dimension should be **at least 416x416 pixels**. + x-additionalinfo: |+ + Suggested Use Cases: + - This microservice can be used as a solution to help businesses better understand and connect with their customers, engage new prospects and increase revenue. For example, it can be used to improve visitor experience and optimize operations in retail, leisure, and other sectors by identifying the type of demogrpahic that frequents a certain place the most. It can also be used to create intelligent prospect lists that ensure one is always maximizing their marketing investment. + version: v0.1.0 + x-subscribelink: demographics_classification +servers: + - url: 'https://apis.sentient.io' +tags: +- name: "v0.1.0" + description: "Published Date - Dec 09, 2020" +paths: + /microservices/cv/democlass/v0/getpredictions: + post: + tags: + - v0.1.0 + responses: + '200': + description: success response + content: + application/json: + schema: + $ref: '#/components/schemas/success' + example: + results: + persons: + - age: 33.21062944528088 + bbox: + bottom: 459 + left: 82 + right: 393 + top: 0 + gender: Man + race: white + + message: Successfully Processed + status: Success + '401': + description: Unauthorized + content: + application/json: + schema: + $ref: '#/components/schemas/unauthorized' + '402': + description: Payment Required + content: + application/json: + schema: + $ref: '#/components/schemas/paymentrequired' + '403': + description: Forbidden + content: + application/json: + schema: + $ref: '#/components/schemas/forbidden' + '404': + description: Not Found + content: + application/json: + schema: + $ref: '#/components/schemas/notfound' + '419': + description: Input Field Missing + content: + application/json: + schema: + $ref: '#/components/schemas/inputfieldmissing' + '413': + description: Input Limit Exceeded + content: + application/json: + schema: + $ref: '#/components/schemas/inputlimitexceeded' + '415': + description: Invalid Input + content: + application/json: + schema: + $ref: '#/components/schemas/invalidinput' + '500': + description: Internal Server error + content: + application/json: + schema: + $ref: '#/components/schemas/servererror' + '504': + description: Gateway Timeout + content: + application/json: + schema: + $ref: '#/components/schemas/gatewaytimeout' + security: + - APIAuthorizer: [] + + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/input' + required: true + + +components: + schemas: + success: + type: object + properties: + results: + type: object + description: The result of the API call. + example: { "" } + properties: + persons: + description: Demographic details of the detected person + example: + age: 33.21062944528088 + bbox: + bottom: 459 + left: 82 + right: 393 + top: 0 + gender: Man + race: white + items: + properties: + description: Demographic details of the detected person + example: ' ' + properties: + age: + description: Age of the detected person in the input image + example: 33.21062944528088 + type: float + bbox: + description: Bounding box of the detected person in the input image + example: ' ' + properties: + bottom: + description: Bottom coordinate of the box + example: 459 + type: integer + left: + description: Left coordinate of the box + example: 82 + type: integer + right: + description: Right coordinate of the box + example: 393 + type: integer + top: + description: Top coordinate of the box + example: 0 + type: integer + type: object + gender: + description: Gender of the detected person in the input image + example: Man + type: string + race: + description: Race of the detected person in the input image + example: white + type: string + type: object + type: object + type: array + + message: + type: string + example: Successfully Processed + description: Detail description on the API status + status: + type: string + example: Success + description: The status of the API call success/failure + + unauthorized: + type: object + properties: + message: + type: string + example: Missing Authentication Token + status: + type: string + example: Failure + forbidden: + type: object + properties: + message: + type: string + example: Access Denied Unauthorized User + status: + type: string + example: Failure + paymentrequired: + type: object + properties: + message: + type: string + example: Insufficient Credits Kindly Top Up + status: + type: string + example: Failure + notfound: + type: object + properties: + message: + type: string + example: Invalid Request + status: + type: string + example: Failure + servererror: + type: object + properties: + message: + type: string + example: Internal Server error + status: + type: string + example: Failure + gatewaytimeout: + type: object + properties: + message: + type: string + example: Request Timeout + status: + type: string + example: Failure + inputfieldmissing: + type: object + properties: + message: + type: string + example: Input Field Missing + status: + type: string + example: Failure + inputlimitexceeded: + type: object + properties: + message: + type: string + example: Input Limit Exceeded + status: + type: string + example: Failure + invalidinput: + type: object + properties: + message: + type: string + example: Invalid Input + status: + type: string + example: Failure + versions: + type: object + properties: + v0.1.0: + type: array + items: + oneOf: + - type: string + example: Published Date - Dec 09, 2020 + description: Initial version release + input: + type: object + required: + + - image_base64 + + properties: + image_base64: + x-name: image_base64 + type: string + default: True + example: /9j/4AAQSkZJRgABAQEASABIAAD/2wBDAAMCAgMCAgMDAwMEAwMEBQgFBQQEBQoHBwYIDAoMDAsKCwsNDhIQDQ4RDgsLEBYQERMUFRUVDA8XGBYUG... + description: |+ + Input image file in base64 format. + + + securitySchemes: + APIAuthorizer: + type: apiKey + name: x-api-key + in: header + x-amazon-apigateway-authtype: custom + description: Authentication is done using the x-api-key in the request header diff --git a/data/demographics_hdb_sg.yaml b/data/demographics_hdb_sg.yaml new file mode 100644 index 000000000..bc9353022 --- /dev/null +++ b/data/demographics_hdb_sg.yaml @@ -0,0 +1,448 @@ +openapi: 3.0.1 +info: + title: HDB Demographics (SG) + x-subscribelink: demographics_hdb_sg + description: |+ + This Data microservice returns information on Housing Development Board of Singapore (HDB) estates and includes the location address, postal code, gender and age groups, down to block-level granularity.The HDB POTH programme makes selected public and non-public datasets available to developers and companies to improve their service offerings to benefit the lives of Singapore citizens. Sentient.io is proud to partner with HDB to manage and facilitate the sharing of data for the POTH Programme. + + **Note:** As this microservice uses the GET method, developers using this microservice must remember to have their app encode all the input values to be URL friendly (i.e. all spaces and special characters must be replaced). Here’s a reference on [URL encoding](https://www.w3schools.com/tags/ref_urlencode.ASP). + + x-additionalinfo : |+ + Suggested Use Cases: + - This microservice can be used as a solution to help businesses better understand and connect with their customers, engage new prospects and increase revenue. For example, it can be used to create intelligent prospect lists that ensure one is always maximizing their marketing investment. + + **Refining queries in the filterdata field using filter types and match types** + The filterdata fields use elasticsearch’s syntax (specifically filter types and match types) to help further refine search results and provide greater flexibility in structuring more sophisticated queries. + + **Filter Types:** + A filter type is a logic operator to which the search results must fulfill certain logical conditions to be returned. The supported match types are: + + * **must** - All of the stated conditions must match. Equivalent to an AND operator. + + > {"must":[{"match_phrase":{"street":"serangoon north avenue 4"}}]} + + * **must_not** - All of the stated conditions must not match. Equivalent to a NOT operator. + > {"must_not":[{"match":{"postalcode":"570251"}}]} + + * **should** - At least one of the stated conditions should match. Equivalent to an OR operator. + > {"should":[{"match_phrase":{"street":"serangoon north avenue 4"}}]} + + * **filter** - All of the stated conditions that must match. However, results are not scored unlike the other filter types which returns results based on how well the conditions are met. + > {"filter":[{"match":{"street":"serangoon"}}]} + + For a more detailed guide on filter types, [refer to this](https://www.elastic.co/guide/en/elasticsearch/reference/6.8/query-dsl-bool-query.html). + + Filter types cannot be used alone and must be used in conjunction with a match type to complete the query. + **Match Types:** + A match type is a match operator nested within a filter type that fine-tunes the matching condition of the text search. The supported match types are: + + * **match** - Search within a full text field for a single word + > {"match":{"street":"serangoon"}} + * **match_phrase** - Search within a full text field + > {"match_phrase":{"street":"serangoon central"}} + * **match_phrase_prefix** - Search within a full text field with prefix + > {"match_phrase_prefix":{"street":"serangoon central"}} + * **term** - Returns results that contain an exact term in a provided field + > {"term":{"postalcode":"560720"}} + * **terms** - Returns results that contain one or more exact terms in a provided field + > {"terms":{"postalcode":["560720","560721"]}} + + * **range** - Returns results that contain terms within a stipulated range + + > {"range":{"residents":{"gte":10}}} + > {"range":{"residents":{"lte":50}}} + > {"range":{"residents":{"gte":10,"lte":50}}} + + * **exists** - Returns results that contain any indexed value for a field + + > {"exists":{ "field":"postalcode"}} + For a more detailed guide to match types, [refer to this](https://www.elastic.co/guide/en/elasticsearch/reference/7.9/term-level-queries.html). + + **Forming sophisticated queries using combinations of filter types (in JSON)** + Multiple filter types can be combined together in one query (written in JSON format) to form a very sophisticated query. Here’s one example below: + + > { + > "must":[{"match_phrase":{"street":"serangoon+central"}}], + > "filter":[{"range":{"residents":{"gte":10}}}], + > "should":[{"match":{"gender":"male"}}], + > "must_not":[{"match":{"age_group_id":"2"}}] + > } + + **Sample Queries Based on Use Cases** + + 1. **Search for the number of elderly residents staying at Blk 423, Tampines Street 41 filter by age and gender.** + Using a filterdata only: + + > {"filter":[{"match":{"street":"tampines street 41"}},{"match":{"block":"423"}},{"terms":{"age_group_id":[6,7,8]}}]} + + 2. **Search for the number of female residents between age 50 to 59 staying in the postal code from 050034 to 050532.** + Using a filterdata only: + + > {"filter":[{"terms":{"postalcode":["050034","050532"]}},{"match":{"gender":"female"}},{"terms":{"age_group_id":[6]}}]} + version: '0.1.0' +servers: + - url: 'https://api.sentient.io' +tags: +- name: "v0.1.0" + description: "Published Date - May 15, 2020" +paths: + /DaaS/prod/hdb/demographics: + get: + tags: + - v0.1.0 + parameters: + - in: query + name: querystring + schema: + type: string + description: |+ + Simple keyword search for matches in all searchable fields. Keywords separated by spaces will return results containing any of those keywords. For exact phrase match, put entire phrase in double quotes (" "). + + If this field is set to null, by default the microservice will return all buildings (within the stated limit), which can be further refined through the filterdata field for more sophisticated queries. + + example: "tampines" + default: false + - in: query + name: offset + schema: + type: integer + description: The offset of the record list ie the starting index + example: "0" + default: false + - in: query + name: limit + schema: + type: integer + description: The max records to return for the request. Default - 10, Max - 10000 + example: "10" + default: false + - in: query + name: filterdata + schema: + type: string + description: |+ + Refine the search further on any of the possible through the 4 filter types : + * must + * must_not + * should + * filter + default: false + example: |+ + {"filter":[{"match":{"age_group_id":7}},{"match":{"gender":"male"}},{"match":{"postalcode":520423}}]} + responses: + '200': + description: success response + content: + application/json: + schema: + $ref: '#/components/schemas/success' + example: + results: + total: 986 + max_score: 17.995623 + hits: + - _index: sentient_demographics_hdb_index + _type: dir_doc + _id: K7scqWgBv3dNEHq2WvMo + _score: 17.995623 + _source: + postalcode: '560720' + gender: 'male' + age_group: '50 to 59' + age_group_id: 6 + residents: 54 + block: '34' + street: 'upper cross street' + xcoord: 29520.58 + ycoord: 39311.68 + address: '34 upper cross street' + createddate: '2020-04-23' + lastupdated: '2020-04-23' + location: + lat: 1.37179535 + lon: 103.8469821 + source: hdb + message: Successfully Processed + status: Success + '401': + description: Unauthorized + content: + application/json: + schema: + $ref: '#/components/schemas/unauthorized' + '402': + description: Payment Required + content: + application/json: + schema: + $ref: '#/components/schemas/paymentrequired' + '403': + description: Forbidden + content: + application/json: + schema: + $ref: '#/components/schemas/forbidden' + '404': + description: Not Found + content: + application/json: + schema: + $ref: '#/components/schemas/notfound' + '419': + description: Input Field Missing + content: + application/json: + schema: + $ref: '#/components/schemas/inputfieldmissing' + '413': + description: Input Limit Exceeded + content: + application/json: + schema: + $ref: '#/components/schemas/inputlimitexceeded' + '415': + description: Invalid Input + content: + application/json: + schema: + $ref: '#/components/schemas/invalidinput' + '500': + description: Internal Server Error + content: + application/json: + schema: + $ref: '#/components/schemas/servererror' + '504': + description: Gateway Timeout + content: + application/json: + schema: + $ref: '#/components/schemas/gatewaytimeout' + security: + - APIAuthorizer: [] +components: + schemas: + success: + type: object + properties: + results: + type: object + example: {} + description: Json Object of returned results + properties: + total: + type: number + example: 986 + description: Total number of records + max_score: + type: number + example: 17.995623 + description: The highest score value + hits: + type: array + example: [{} + description: Json Object of returned hits + properties: + postalcode: + type: string + description: Postal code of a block + example: "560720" + gender: + type: string + description: Gender details, values are male/female + example: "male" + age_group: + type: string + description: Range of age groups + example: "50 to 59" + age_group_id: + type: number + description: |+ + Age group ID represents a certain age range: + 1 (<10 years) + 2 (10-19 years) + 3 (20-29 years) + 4 (30-39 years) + 5 (40-49 years) + 6 (50-59 years) + 7 (60-69 years) + 8 (>70 years) + example: 6 + residents: + type: number + description: Number of residents + example: 54 + block: + type: string + description: Address block + example: "34" + street: + type: string + description: Street Address or building name + example: "upper cross street" + xcoord: + type: string + description: SVY21 X coordinates + example: 29520.58 + ycoord: + type: string + description: SVY21 Y coordinates + example: 39311.68 + address: + type: string + description: Building full address + example: "34 upper cross street" + createddate: + type: string + description: Record first release date on sentient + example: "2020-04-23" + lastupdated: + type: string + description: Record last updated date on sentient + example: "2020-04-23" + location: + type: object + description: WGS84 coordinates lat/long + example: {"lat":1.37179535,"lon":103.8469821} + properties: + lat: + type: string + description: WGS84 latitude + example: 1.37179535 + lon: + type: string + description: WGS84 longitude + example: 103.8469821 + source: + type: string + description: Dataset source + example: "hdb" + message: + type: string + example: Successfully Processed + description: The detail description on the status + status: + type: string + example: Success + description: The status of the API call Success/Failure + unauthorized: + type: object + properties: + message: + type: string + example: Missing Authentication Token + status: + type: string + example: Failure + forbidden: + type: object + properties: + message: + type: string + example: Access Denied Unauthorized User + status: + type: string + example: Failure + paymentrequired: + type: object + properties: + message: + type: string + example: Insufficient Credits Kindly Top Up + status: + type: string + example: Failure + notfound: + type: object + properties: + message: + type: string + example: Invalid Request URL + status: + type: string + example: Failure + servererror: + type: object + properties: + message: + type: string + example: Internal Server Error + status: + type: string + example: Failure + gatewaytimeout: + type: object + properties: + message: + type: string + example: Request Timeout + status: + type: string + example: Failure + inputfieldmissing: + type: object + properties: + message: + type: string + example: Input Field Missing + status: + type: string + example: Failure + inputlimitexceeded: + type: object + properties: + message: + type: string + example: Input Limit Exceeded + status: + type: string + example: Failure + invalidinput: + type: object + properties: + message: + type: string + example: Invalid Input + status: + type: string + example: Failure + versions: + type: object + properties: + v0.1.0: + type: array + items: + oneOf: + - type: string + example: Published Date - May 15,2020 + description: Initial version release + securitySchemes: + APIAuthorizer: + type: apiKey + name: x-api-key + in: header + x-amazon-apigateway-authtype: custom + description: Authentication is done using the x-api-key in the request header. diff --git a/data/directory_of_singapore_startups.yaml b/data/directory_of_singapore_startups.yaml new file mode 100644 index 000000000..87562de87 --- /dev/null +++ b/data/directory_of_singapore_startups.yaml @@ -0,0 +1,548 @@ +openapi: 3.0.1 +info: + title: Directory of Singapore Startups + x-subscribelink: directory_of_singapore_startups + description: |+ + This Data microservice retrieves the list of all Singapore startup companies found on the internet through web scraping. Updated quarterly. + x-additionalinfo: |+ + Suggested Use Cases: + - Build solutions related to startups in Singapore. For example, investors interested in industry analysis can use this microservice to identify the trends and patterns in Singapore's startup scene. + + **Refining queries in the filterdata field using filter types and match types** + + The filterdata fields use elasticsearch’s syntax (specifically filter types and match types) to help further refine search results and provide greater flexibility in structuring more sophisticated queries. + + **Filter Types:** + + A filter type is a logic operator to which the search results must fulfill certain logical conditions to be returned. The supported match types are: + + * **must** - All of the stated conditions must match. Equivalent to an AND operator. + + > {"must":[{"match":{"name":"technology"}}]} + + * **must_not** - All of the stated conditions must not match. Equivalent to a NOT operator. + + > {"must_not":[{"match":{"yearestablished.e27":"2016"}}]} + + * **should** - At least one of the stated conditions should match. Equivalent to an OR operator. + + > {"should":[{"match":{"status.e27":"active"}}]} + + * **filter** - All of the stated conditions that must match. However, results are not scored unlike the other filter types which returns results based on how well the conditions are met. + + > {"filter":[{"exists":{"field":"company.e27"}}]} + + For a more detailed guide on filter types, [refer to this](https://www.elastic.co/guide/en/elasticsearch/reference/6.8/query-dsl-bool-query.html). + + Filter types cannot be used alone and must be used in conjunction with a match type to complete the query. + + **Match Types:** + + A match type is a match operator nested within a filter type that fine-tunes the matching condition of the text search. The supported match types are: + + * **match** - Search within a full text field for a single word + + > {"match":{"name":"technology"}} + + * **match_phrase** - Search within a full text field + + > {"match_phrase":{"name":"nextwave partners"}} + + * **match_phrase_prefix** - Search within a full text field with prefix + + > {"match_phrase_prefix":{"name":"nextwave partners"}} + + * **term** - Returns results that contain an exact term in a provided field + + > {"term":{"employeecount.techinasia":"11"}} + + * **terms** - Returns results that contain one or more exact terms in a provided field + + > {"terms":{"employeecount.techinasia":["11","15"]}} + + * **range** - Returns results that contain terms within a stipulated range + + > {"range":{"company.techinasia.funding.amount":{"gte":10000000}}} + > {"range":{"company.techinasia.funding.amount":{"lte":50000000}}} + > {"range":{"company.techinasia.funding.amount":{"gte":10000000,"lte":50000000}}} + + * **exists** - Returns results that contain any indexed value for a field + + > {"exists":{"field":"company.e27"}} + + **Sample filterdata JSON:** + > { + > "must":[{"match":{"name":"technology"}}], + > "filter":[{"exists":{"field":"company.e27"}}], + > "should":[{"match":{"status.e27":"active"}}], + > "must_not":[{"match":{"yearestablished.e27":"2016"}}] + > } + version: '0.1.0' +servers: + - url: 'https://api.sentient.io' +tags: +- name: "v0.1.0" + description: "Published Date - Dec 26, 2018" +paths: + /DaaS/prod/directories/searchdir: + get: + tags: + - v0.1.0 + parameters: + - in: query + name: querystring + schema: + type: string + description: |+ + Simple keyword search for matches in all searchable fields. Keywords separated by spaces will return results containing any of those keywords. For exact phrase match, put entire phrase in double quotes (" "). + + If this field is set to null, by default the microservice will return all start ups (within the stated limit), which can be further refined through the filterdata field for more sophisticated queries. + + example: "technology" + default: false + - in: query + name: offset + schema: + type: integer + description: The offset of the record list ie the starting index + example: "0" + default: false + - in: query + name: limit + schema: + type: integer + description: The max records to return for the request. Default - 10, Max - 10000 + example: "10" + default: false + - in: query + name: filterdata + schema: + type: string + description: |+ + Refine the search further on any of the possible through the 4 filter types : + * must + * must_not + * should + * filter + default: false + example: |+ + {"must":[{"match":{"name":"technology"}}],"filter":[{"exists":{"field":"company.e27"}}],"should":[{"match":{"status.e27":"active"}}],"must_not":[{"match":{"yearestablished.e27":"2016"}}]} + responses: + '200': + description: success response + content: + application/json: + schema: + $ref: '#/components/schemas/success' + example: + results: + total: 986 + max_score: 1 + hits: + - _index: sentient_directory_index + _type: dir_doc + _id: TrrmAWgBv3dNEHq24P-C + _score: 1 + _source: + type: company + source: sentient + address: singapore + createddate: '2018-12-31' + name: AAR Consultancy + logo: + e27: https://e27.co/img/startups/11448/logo.png + company: + e27: + sourceurl: https://e27.co/startup/aar-consultancy + type: startup + technology: + - Enterprise Solution + - Big Data + - E-commerce + - Education + - Internet of Things + socialmedia: + e27: + linkedin: https://sg.linkedin.com/in/soumikch + descshort: + e27: Google Certified Professionals. Providing with Consultation, Implementation + Strategy and Training of various online platforms, methods and campaigns, + including eComm launches. + desclong: + e27: 'My name is Soumik and I am founder of AAR Consultancy, a registered + business in Singapore. I provide online consultancy, implementation strategy + development and Training.I offer various online services, which you can + see from my attached company profile. I am an MBA with 11+ years experience + helping manage digital / online marketing for various industries. Been guest + speakers at seminars and conferences and provided corporate training to + SMEs and MNCs alike. I have worked with Streetdirectory, MDIS, Ogilvy and + Mather, American Express and Mothercare and has helped clients such as IBM, + Unilever, Nestle, SingTel, Guinness amongst others. SMEs, MNCs : B2B and + B2C.Have launched eCommerce Platforms, websites, strategies, technologies, + apps, and more.Trained and implemented, SEO, AdWords - ppc, media ads, social, + community management and more.' + website: + e27: http://ww.aaronline.sg + status: + e27: active + message: Successfully Processed + status: Success + '401': + description: Unauthorized + content: + application/json: + schema: + $ref: '#/components/schemas/unauthorized' + '402': + description: Payment Required + content: + application/json: + schema: + $ref: '#/components/schemas/paymentrequired' + '403': + description: Forbidden + content: + application/json: + schema: + $ref: '#/components/schemas/forbidden' + '404': + description: Not Found + content: + application/json: + schema: + $ref: '#/components/schemas/notfound' + '419': + description: Input Field Missing + content: + application/json: + schema: + $ref: '#/components/schemas/inputfieldmissing' + '413': + description: Input Limit Exceeded + content: + application/json: + schema: + $ref: '#/components/schemas/inputlimitexceeded' + '415': + description: Invalid Input + content: + application/json: + schema: + $ref: '#/components/schemas/invalidinput' + '500': + description: Internal Server Error + content: + application/json: + schema: + $ref: '#/components/schemas/servererror' + '504': + description: Gateway Timeout + content: + application/json: + schema: + $ref: '#/components/schemas/gatewaytimeout' + security: + - APIAuthorizer: [] +components: + schemas: + success: + type: object + properties: + results: + type: object + example: { "" } + description: Json Object of returned results + properties: + total: + type: number + example: 986 + description: Total number of records + max_score: + type: number + example: 1 + description: The highest score value + hits: + type: array + example: [ { "" } + description: Json Object of returned hits + properties: + type: + type: string + description: Directory type + example: company + source: + type: string + description: Dataset source + example: sentient + address: + type: string + description: Full address + example: singapore + createddate: + type: string + description: Record first release date on sentient + example: '2018-12-31' + name: + type: string + description: Business name + example: AAR Consultancy + logo: + type: object + example: { "" } + description: List of logo from various content providers like f6s, e27, techinasia + properties: + : + type: string + description: logo url + example: 'https://e27.co/img/startups/11448/logo.png' + company: + type: object + example: { "" } + description: Full details about the company from various content providers like f6s, e27, techinasia + properties: + : + type: object + example: { "" } + description: Directory details from the content provider like f6s, e27, techinasia + properties: + sourceurl: + type: string + description: Directory source url + example: 'https://e27.co/startup/tech-in-asia' + type: + type: string + description: Type of Directory + example: startup + technology: + type: array + items: + oneOf: + - type: string + format: list + example: Enterprise Solution + - type: string + format: list + example: Big Data + - type: string + format: list + example: E-commerce + - type: string + format: list + example: Education + - type: string + format: list + example: Internet of Things + funding: + type: array + example: [ { "" } + description: Various Social media details from various content providers like f6s, e27, techinasia + properties: + : + type: string + description: Social media information of the record + example: 'https://www.linkedin.com/company/tech-in-asia' + properties: + linkedin: + type: string + description: Social media - Linkedin url + example: 'https://www.linkedin.com/company/tech-in-asia' + facebook: + type: string + description: Social media - Facebook url + example: 'https://www.facebook.com/techinasia' + twitter: + type: string + description: Social media - twitter url + example: 'https://www.twitter.com/Techinasia' + descshort: + type: object + example: { "" } + description: Short description + properties: + : + type: string + description: Short description from various content providers like f6s, e27, techinasia + example: 'Tech in Asia (YC W15) is the go-to online platform for Asia’s tech community, with annual conferences hosted in Singapore, Tokyo, and Jakarta.' + desclong: + type: object + example: { "" } + description: Long description + properties: + : + type: string + description: Long description from various content providers like f6s, e27, techinasia + example: 'Tech in Asia (YC W15) is the go-to online platform for Asia’s tech community, with annual conferences hosted in Singapore, Tokyo, and Jakarta. Right here is where you can keep abreast of Asia’s tech industry, share your thoughts alongside ours, and connect with startups and investors alike.With an ever-growing team of close to 100 based all across Asia and the US, spanning editorial, events and database functions, they are fully dedicated to bringing Asia’s tech ecosystem closer together.Above all, they want to give you a voice with their platform and facilitate meaningful discussions that would otherwise only take place offline. Anyone willing to add value to Asia’s tech community and ecosystem is able and welcome to join in the conversation.Tech in Asia counts Softbank, Y Combinator, Walden International, East Ventures, Facebook co-founder Eduardo Saverin, and more amongst its list of investors. Their statement of ethics governs their principles regarding full disclosure and conflicts of interest.' + website: + type: object + example: { "" } + description: Website details from various content providers like f6s, e27, techinasia + properties: + : + type: string + description: Website address + example: 'https://www.techinasia.com' + status: + type: object + example: { "" } + description: Company status from various content providers like f6s, e27, techinasia + properties: + : + type: string + description: Company status + example: active + message: + type: string + example: Successfully Processed + description: The detail description on the status + status: + type: string + example: Success + description: The status of the API call Success/Failure + unauthorized: + type: object + properties: + message: + type: string + example: Missing Authentication Token + status: + type: string + example: Failure + forbidden: + type: object + properties: + message: + type: string + example: Access Denied Unauthorized User + status: + type: string + example: Failure + paymentrequired: + type: object + properties: + message: + type: string + example: Insufficient Credits Kindly Top Up + status: + type: string + example: Failure + notfound: + type: object + properties: + message: + type: string + example: Invalid Request URL + status: + type: string + example: Failure + servererror: + type: object + properties: + message: + type: string + example: Internal Server Error + status: + type: string + example: Failure + gatewaytimeout: + type: object + properties: + message: + type: string + example: Request Timeout + status: + type: string + example: Failure + inputfieldmissing: + type: object + properties: + message: + type: string + example: Input Field Missing + status: + type: string + example: Failure + inputlimitexceeded: + type: object + properties: + message: + type: string + example: Input Limit Exceeded + status: + type: string + example: Failure + invalidinput: + type: object + properties: + message: + type: string + example: Invalid Input + status: + type: string + example: Failure + versions: + type: object + properties: + v0.1.0: + type: array + items: + oneOf: + - type: string + example: Published Date - Dec 26, 2018 + description: Initial version release + securitySchemes: + APIAuthorizer: + type: apiKey + name: x-api-key + in: header + x-amazon-apigateway-authtype: custom + description: Authentication is done using the x-api-key in the request header. diff --git a/data/fitness_stations_and_playgrounds_hdb_sg.yaml b/data/fitness_stations_and_playgrounds_hdb_sg.yaml new file mode 100644 index 000000000..5dd69f4c5 --- /dev/null +++ b/data/fitness_stations_and_playgrounds_hdb_sg.yaml @@ -0,0 +1,237 @@ +openapi: 3.0.1 +info: + title: HDB Fitness Stations and Playgrounds (SG) + x-subscribelink: fitness_stations_and_playgrounds_hdb_sg + description: |+ + This Data microservice captures the indicative outline of fitness stations/playgrounds for all Housing Development Board of Singapore (HDB) Towns, HDB Estates and on HDB Land. The features were identified visually from high definition ortho-rectified aerial imagery (2014) and manually digitized. Objects largely obstructed by trees, structures and/or shadow are likely not captured in this dataset. The outlines of partially obstructed objects were extrapolated where possible and may not fully represent the actual shape of the actual object. + As this is a dataset download microservice, a successful call will return a pre-signed URL where the entire dataset can be downloaded as a CSV file. + The HDB POTH programme makes selected public and non-public datasets available to developers and companies to improve their service offerings to benefit the lives of Singapore citizens. Sentient.io is proud to partner with HDB to manage and facilitate the sharing of data for the POTH Programme. + x-additionalinfo: |+ + Suggested Use Cases: + - Real estate services - can be used as a background check solution to extract information related to the types and number of fitness stations/playgrounds present in an area for people buying or renting a HDB home. + + Download the complete dataset using a pre-signed URL. It's a two steps process. + + **Step 1:** Get the pre-signed URL + + Replace the correct x-api-key, and API endpoint + + > **curl -X GET -H "Content-Type: application/json" -H "x-api-key:XXXXX" ** + **Step 2:** Download file + + Using the results.url (i.e) the pre-signed URL to download the dataset + + > **curl --request GET "results.url" >> "FILE_NAME"** + + **Data schema** + + | Name | Type | Size | Description | + |---|---|---|---|---| + | FEATID | Integer | N/A | Feature ID. Unique running number. | + | TYPE | Char | N/A | Captures the type of object. | + | LVL | Char | N/A | Captures whether the object is located at Ground level or Above Ground level. | + | QUALITY | Char | N/A | Captures whether the section of the feature was Fully Visible or Partially Visible. | + | INC_CRC | Varchar | 50 | Sub Location Id | + | FMEL_UPD_D | Datetime | N/A | Date Updated | + | Shape__Area | Float | N/A | Area of the feature | + | Shape__Length | Float | N/A | Length of the feature | + + version: '0.1.0' +servers: + - url: 'https://api.sentient.io' +tags: +- name: "v0.1.0" + description: "Published Date - Mar 24, 2020" +paths: + /DaaS/prod/hdb/amenities/gs/csv/fitnessstationplaygrnd/hdb: + get: + tags: + - v0.1.0 + responses: + '200': + description: success response + content: + application/json: + schema: + $ref: '#/components/schemas/success' + example: + results: + url: "" + status: Success + message: Successfully Processed + '401': + description: Unauthorized + content: + application/json: + schema: + $ref: '#/components/schemas/unauthorized' + '402': + description: Payment Required + content: + application/json: + schema: + $ref: '#/components/schemas/paymentrequired' + '403': + description: Forbidden + content: + application/json: + schema: + $ref: '#/components/schemas/forbidden' + '404': + description: Not Found + content: + application/json: + schema: + $ref: '#/components/schemas/notfound' + '419': + description: Input Field Missing + content: + application/json: + schema: + $ref: '#/components/schemas/inputfieldmissing' + '413': + description: Input Limit Exceeded + content: + application/json: + schema: + $ref: '#/components/schemas/inputlimitexceeded' + '415': + description: Invalid Input + content: + application/json: + schema: + $ref: '#/components/schemas/invalidinput' + '500': + description: Internal Server Error + content: + application/json: + schema: + $ref: '#/components/schemas/servererror' + '504': + description: Gateway Timeout + content: + application/json: + schema: + $ref: '#/components/schemas/gatewaytimeout' + security: + - APIAuthorizer: [] +components: + schemas: + success: + type: object + properties: + results: + type: object + example: { "" } + description: Json Object of returned results + properties: + url: + type: string + description: pre-signed URL to download the file + example: "" + status: + type: string + example: Success + description: The status of the API call. success/failure + message: + type: string + example: Successfully Processed + description: Detail description on the api status + unauthorized: + type: object + properties: + message: + type: string + example: Missing Authentication Token + status: + type: string + example: Failure + forbidden: + type: object + properties: + message: + type: string + example: Access Denied Unauthorized User + status: + type: string + example: Failure + paymentrequired: + type: object + properties: + message: + type: string + example: Insufficient Credits Kindly Top Up + status: + type: string + example: Failure + notfound: + type: object + properties: + message: + type: string + example: Invalid Request URL + status: + type: string + example: Failure + servererror: + type: object + properties: + message: + type: string + example: Internal Server Error + status: + type: string + example: Failure + gatewaytimeout: + type: object + properties: + message: + type: string + example: Request Timeout + status: + type: string + example: Failure + inputfieldmissing: + type: object + properties: + message: + type: string + example: Input Field Missing + status: + type: string + example: Failure + inputlimitexceeded: + type: object + properties: + message: + type: string + example: Input Limit Exceeded + status: + type: string + example: Failure + invalidinput: + type: object + properties: + message: + type: string + example: Invalid Input + status: + type: string + example: Failure + versions: + type: object + properties: + v0.1.0: + type: array + items: + oneOf: + - type: string + example: Published Date - Mar 24, 2020 + description: Initial version release + securitySchemes: + APIAuthorizer: + type: apiKey + name: x-api-key + in: header + x-amazon-apigateway-authtype: custom + description: Authentication is done using the x-api-key in the request header. diff --git a/data/flat_ownership_hdb_sg.yaml b/data/flat_ownership_hdb_sg.yaml new file mode 100644 index 000000000..0961fd126 --- /dev/null +++ b/data/flat_ownership_hdb_sg.yaml @@ -0,0 +1,449 @@ +openapi: 3.0.1 +info: + title: HDB Flat Ownership Duration (SG) + x-subscribelink: flat_ownership_hdb_sg + description: |+ + This Data microservice returns information on flat ownership within Housing Development Board of Singapore (HDB) estates and includes the location address, postal code, length of ownership and their quantity in units.The HDB POTH programme makes selected public and non-public datasets available to developers and companies to improve their service offerings to benefit the lives of Singapore citizens. Sentient.io is proud to partner with HDB to manage and facilitate the sharing of data for the POTH Programme." + + **Note:** As this microservice uses the GET method, developers using this microservice must remember to have their app encode all the input values to be URL friendly (i.e. all spaces and special characters must be replaced). Here’s a reference on [URL encoding](https://www.w3schools.com/tags/ref_urlencode.ASP). + + x-additionalinfo : |+ + Suggested Use Cases: + - Real estate services - for example, this microservice can be used for services that are related to HDB ownership transfer (i.e. when one transfer, include, withdraw and/or substitute owners for a flat), such as when drafting up related legal documents. + + **Refining queries in the filterdata field using filter types and match types** + The filterdata fields use elasticsearch’s syntax (specifically filter types and match types) to help further refine search results and provide greater flexibility in structuring more sophisticated queries. + + **Filter Types:** + A filter type is a logic operator to which the search results must fulfill certain logical conditions to be returned. The supported match types are: + + * **must** - All of the stated conditions must match. Equivalent to an AND operator. + + > {"must":[{"match_phrase":{"street":"serangoon north avenue 4"}}]} + + * **must_not** - All of the stated conditions must not match. Equivalent to a NOT operator. + > {"must_not":[{"match":{"postalcode":"570251"}}]} + + * **should** - At least one of the stated conditions should match. Equivalent to an OR operator. + > {"should":[{"match_phrase":{"street":"serangoon north avenue 4"}}]} + + * **filter** - All of the stated conditions that must match. However, results are not scored unlike the other filter types which returns results based on how well the conditions are met. + > {"filter":[{"match":{"street":"serangoon"}}]} + + For a more detailed guide on filter types, [refer to this](https://www.elastic.co/guide/en/elasticsearch/reference/6.8/query-dsl-bool-query.html). + + Filter types cannot be used alone and must be used in conjunction with a match type to complete the query. + **Match Types:** + A match type is a match operator nested within a filter type that fine-tunes the matching condition of the text search. The supported match types are: + + * **match** - Search within a full text field for a single word + + > {"match":{"street":"serangoon"}} + + * **match_phrase** - Search within a full text field + + > {"match_phrase":{"street":"serangoon central"}} + + * **match_phrase_prefix** - Search within a full text field with prefix + + > {"match_phrase_prefix":{"street":"serangoon central"}} + + * **term** - Returns results that contain an exact term in a provided field + + > {"term":{"postalcode":"560720"}} + * **terms** - Returns results that contain one or more exact terms in a provided field + + > {"terms":{"postalcode":["560720","560721"]}} + + * **range** - Returns results that contain terms within a stipulated range + + > {"range":{"no_of_units":{"gte":10}}} + > {"range":{"no_of_units":{"lte":50}}} + > {"range":{"no_of_units":{"gte":10,"lte":50}}} + + * **exists** - Returns results that contain any indexed value for a field + + > {"exists":{ "field": "postalcode"}} + + For a more detailed guide to match types, [refer to this](https://www.elastic.co/guide/en/elasticsearch/reference/7.9/term-level-queries.html). + + **Forming sophisticated queries using combinations of filter types (in JSON)** + Multiple filter types can be combined together in one query (written in JSON format) to form a very sophisticated query. Here’s one example below: + + > { + > "must":[{"match_phrase":{"street":"serangoon+central"}}], + > "filter":[{"match":{"postalcode":"550209"}}], + > "should":[{"range":{"no_of_units":{"gte":10}}}], + > "must_not":[{"match":{"len_of_ownership_id":"5"}}] + > } + + **Sample Queries Based on Use Cases** + + 1. **Search for all blocks with duration of ownership equal to or exceeding 10 years in Ang Mo Kio.** + + Using a filterdata only: + + > filterdata = {"filter":[{"match":{"street":"ang mo kio"}},{"match":{"len_of_ownership_id":"1"}}]} + + version: '0.1.0' +servers: + - url: 'https://api.sentient.io' +tags: +- name: "v0.1.0" + description: "Published Date - May 15, 2020" +paths: + /DaaS/prod/hdb/ownership: + get: + tags: + - v0.1.0 + parameters: + - in: query + name: querystring + schema: + type: string + description: |+ + Simple keyword search for matches in all searchable fields. Keywords separated by spaces will return results containing any of those keywords. For exact phrase match, put entire phrase in double quotes (" "). + + If this field is set to null, by default the microservice will return all units (within the stated limit), which can be further refined through the filterdata field for more sophisticated queries. + + example: "serangoon" + default: false + - in: query + name: offset + schema: + type: integer + description: The offset of the record list ie the starting index + example: "0" + default: false + - in: query + name: limit + schema: + type: integer + description: The max records to return for the request. Default - 10, Max - 10000 + example: "10" + default: false + - in: query + name: filterdata + schema: + type: string + description: |+ + Refine the search further on any of the possible through the 4 filter types : + * must + * must_not + * should + * filter + default: false + example: |+ + {"must":[{"match_phrase":{"street":"serangoon+central"}}],"filter":[{"match":{"postalcode":"550209"}}],"should":[{"range":{"no_of_units":{"gte":10}}}],"must_not":[{"match":{"len_of_ownership_id":"5"}}]} + responses: + '200': + description: success response + content: + application/json: + schema: + $ref: '#/components/schemas/success' + example: + results: + total: 986 + max_score: 17.995623 + hits: + - _index: sentient_durationofownership_hdb_index + _type: dir_doc + _id: 050533/40} + description: Json Object of returned results + properties: + total: + type: number + example: 986 + description: Total number of records + max_score: + type: number + example: 17.995623 + description: The highest score value + hits: + type: array + example: [{} + description: Json Object of returned hits + properties: + postalcode: + type: string + description: Postal code of a block + example: "560720" + len_of_ownership: + type: string + description: Range of length + example: "40 < t <= 50" + len_of_ownership_id: + type: number + description: |+ + Length Types + 1 (t <= 10) + 2 (10 < t <= 20) + 3 (20 < t <= 30) + 4 (30 < t <= 40) + 5 (40 < t <= 50) + 6 (t > 50) + + example: "5" + no_of_units: + type: number + description: Ownership units + example: "29" + block: + type: string + description: Address block + example: "533" + street: + type: string + description: Street Address or building name + example: "upper cross street" + xcoord: + type: string + description: SVY21 X coordinates + example: 29520.58 + ycoord: + type: string + description: SVY21 Y coordinates + example: 39311.68 + address: + type: string + description: Building full address + example: "533 upper cross street" + createddate: + type: string + description: Record first release date on sentient + example: "2020-04-23" + lastupdated: + type: string + description: Record last updated date on sentient + example: "2020-04-23" + location: + type: object + description: WGS84 coordinates lat/long + example: {"lat":1.37179535,"lon":103.8469821} + properties: + lat: + type: string + description: WGS84 latitude + example: 1.37179535 + lon: + type: string + description: WGS84 longitude + example: 103.8469821 + source: + type: string + description: Dataset source + example: hdb + message: + type: string + example: Successfully Processed + description: The detail description on the status + status: + type: string + example: Success + description: The status of the API call Success/Failure + unauthorized: + type: object + properties: + message: + type: string + example: Missing Authentication Token + status: + type: string + example: Failure + forbidden: + type: object + properties: + message: + type: string + example: Access Denied Unauthorized User + status: + type: string + example: Failure + paymentrequired: + type: object + properties: + message: + type: string + example: Insufficient Credits Kindly Top Up + status: + type: string + example: Failure + notfound: + type: object + properties: + message: + type: string + example: Invalid Request URL + status: + type: string + example: Failure + servererror: + type: object + properties: + message: + type: string + example: Internal Server Error + status: + type: string + example: Failure + gatewaytimeout: + type: object + properties: + message: + type: string + example: Request Timeout + status: + type: string + example: Failure + inputfieldmissing: + type: object + properties: + message: + type: string + example: Input Field Missing + status: + type: string + example: Failure + inputlimitexceeded: + type: object + properties: + message: + type: string + example: Input Limit Exceeded + status: + type: string + example: Failure + invalidinput: + type: object + properties: + message: + type: string + example: Invalid Input + status: + type: string + example: Failure + versions: + type: object + properties: + v0.1.0: + type: array + items: + oneOf: + - type: string + example: Published Date - May 15,2020 + description: Initial version release + securitySchemes: + APIAuthorizer: + type: apiKey + name: x-api-key + in: header + x-amazon-apigateway-authtype: custom + description: Authentication is done using the x-api-key in the request header. + diff --git a/data/page_profiler_eng.yaml b/data/page_profiler_eng.yaml new file mode 100644 index 000000000..780eb4217 --- /dev/null +++ b/data/page_profiler_eng.yaml @@ -0,0 +1,255 @@ + openapi: 3.0.1 + info: + title: Page Profiler ENG + description: |+ + This NLP microservice retrieves web content in English from the input URL. + + From the web content, the microservice then applies natural language processing to extracts named-entities and returns the output. + + The named-entity classes extracted are persons, locations, organisations and miscellaneous.

This microservice automatically extracts structured information from unstructured text data such as chatlogs, emails, news articles, etc. + + Do ensure that your URL text is in the **ASCII format**. + x-additionalinfo: |+ + Suggested Use Cases: + - Gain insights from online customers - extract structured information from unstructured text data such as chatlogs, emails, news articles, etc. to find and label fields within a document and then apply sentiment analysis to understand customer opinions to find actionable product and UX insights. + + - Entity analysis - identify entities within documents, including receipts, invoices, and contracts; and label them by types such as date, person, contact information, organization, location, events, products, and media. + version: '1.0.0' + x-subscribelink: page_profiler_eng + x-depreciated: "Oct 15, 2020" + servers: + - url: 'https://apis.sentient.io' + tags: + - name: "v1.0.0" + description: "Published Date - May 15, 2020" + paths: + /microservices/nlp/pageprofiler/v1.0/getpredictions: + post: + tags: + - v1.0.0 + responses: + '200': + description: success response + content: + application/json: + schema: + $ref: '#/components/schemas/success' + example: {"LOC": ["Beijing","Atlanta","Indonesia"], "MISC": [Twiight,Singaporean],"ORG": [CNA,Singapore Parliament],"PER": [Skip Navigation,Bookmarks]} + '401': + description: Unauthorized + content: + application/json: + schema: + $ref: '#/components/schemas/unauthorized' + '402': + description: Payment Required + content: + application/json: + schema: + $ref: '#/components/schemas/paymentrequired' + '403': + description: Forbidden + content: + application/json: + schema: + $ref: '#/components/schemas/forbidden' + '404': + description: Not Found + content: + application/json: + schema: + $ref: '#/components/schemas/notfound' + '419': + description: Not Found + content: + application/json: + schema: + $ref: '#/components/schemas/inputfieldmissing' + '420': + description: Not Found + content: + application/json: + schema: + $ref: '#/components/schemas/inputlimitexceeded' + '422': + description: Invalid Input + content: + application/json: + schema: + $ref: '#/components/schemas/invalidinput' + '500': + description: Internal Server Error + content: + application/json: + schema: + $ref: '#/components/schemas/servererror' + '504': + description: Gateway Timeout + content: + application/json: + schema: + $ref: '#/components/schemas/gatewaytimeout' + security: + - APIAuthorizer: [] + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/input' + required: true + components: + schemas: + success: + type: object + properties: + LOC: + type: array + example: ["Beijing","Atlanta","Indonesia"] + description: "name of location found in the text string" + MISC: + type: array + example: [Twiight,Singaporean] + description: "name of miscellaneous names found in the text string" + ORG: + type: array + example: [CNA,Singapore Parliament] + description: "name of organizations found in the text string" + PER: + type: array + example: [Skip Navigation,Bookmarks] + description: "name of persons found in the text string" + + unauthorized: + type: object + properties: + message: + type: string + example: Missing Authentication Token + status: + type: string + example: Failure + forbidden: + type: object + properties: + message: + type: string + example: Access Denied Unauthorized User + status: + type: string + example: Failure + paymentrequired: + type: object + properties: + message: + type: string + example: Insufficient Credits Kindly Top Up + status: + type: string + example: Failure + notfound: + type: object + properties: + message: + type: string + example: Invalid Request URL + status: + type: string + example: Failure + servererror: + type: object + properties: + message: + type: string + example: Internal Server Error + status: + type: string + example: Failure + invalidinput: + type: object + properties: + message: + type: string + example: Invalid Input + status: + type: string + example: Failure + gatewaytimeout: + type: object + properties: + message: + type: string + example: Request Timeout + status: + type: string + example: Failure + inputfieldmissing: + type: object + properties: + message: + type: string + example: Input Field Missing + status: + type: string + example: Failure + inputlimitexceeded: + type: object + properties: + message: + type: string + example: Input Limit Exceeded + status: + type: string + example: Failure + versions: + type: object + properties: + v2.1.0: + type: array + items: + oneOf: + - type: string + example: Published Date - Oct 30, 2020 + description: Partial URL support + v2.0.0: + type: array + items: + oneOf: + - type: string + example: Published Date - Sep 30, 2020 + description: Standardizing Output JSON + v1.0.0: + type: array + items: + oneOf: + - type: string + example: Published Date - May 15, 2018 + description: Swaping the NLP with Named-Entity Recognition ENG + v0.1.0: + type: array + items: + oneOf: + - type: string + example: Published Date - Apr 16, 2018 + description: Initial version release + input: + type: object + required: + - url + properties: + url: + x-name: url + type: string + default: true + example: https://www.sentient.io/en/ + description: |+ + The URL of the page to be profiled. + + Note that the URL has to be spelt in full, including "https://www." + + securitySchemes: + APIAuthorizer: + type: apiKey + name: x-api-key + in: header + x-amazon-apigateway-authtype: custom + description: Authentication is done using the x-api-key in the request header diff --git a/data/residential_sales_and_rental_hdb_sg.yaml b/data/residential_sales_and_rental_hdb_sg.yaml new file mode 100644 index 000000000..3e298bc09 --- /dev/null +++ b/data/residential_sales_and_rental_hdb_sg.yaml @@ -0,0 +1,496 @@ +openapi: 3.0.1 +info: + title: HDB Residential Occupancy Status (SG) + x-subscribelink: residential_sales_and_rental_hdb_sg + description: |+ + This Data microservice retreives comprehensive details of each HDB block in Singapore including the number of units for each type of flats and whether they were sold or leased. Queries based on keywords and proximity to particular locations can be performed. Updated weekly. + + The HDB POTH programme makes selected public and non-public datasets available to developers and companies to improve their service offerings to benefit the lives of Singapore citizens. Sentient.io is proud to partner with HDB to manage and facilitate the sharing of data for the POTH Programme. + + **Note:** As this microservice uses the GET method, developers using this microservice must remember to have their app encode all the input values to be URL friendly (i.e. all spaces and special characters must be replaced). Here’s a reference on [URL encoding](https://www.w3schools.com/tags/ref_urlencode.ASP). + + x-additionalinfo : |+ + Suggested Use Cases: + - Information can be used to build a community app that benefits from geo-targeting family types and income groups by areas for non-profit charity/social organizations, real estate developers, property agencies, retail shops, marketing for educational sector, government agencies. + + **Refining queries in the filterdata field using filter types and match types** + + The filterdata fields use elasticsearch’s syntax (specifically filter types and match types) to help further refine search results and provide greater flexibility in structuring more sophisticated queries. + + **Filter Types:** + + A filter type is a logic operator to which the search results must fulfill certain logical conditions to be returned. The supported match types are: + + * **must** - All of the stated conditions must match. Equivalent to an AND operator. + + > {"must":[{"match_phrase":{"street":"serangoon north avenue 4"}}]} + + * **must_not** - All of the stated conditions must not match. Equivalent to a NOT operator. + > {"must_not":[{"match":{"postalcode":"570251"}}]} + + * **should** - At least one of the stated conditions should match. Equivalent to an OR operator. + > {"should":[{"match_phrase":{"street":"serangoon north avenue 4"}}]} + + * **filter** - All of the stated conditions that must match. However, results are not scored unlike the other filter types which returns results based on how well the conditions are met. + > {"filter":[{"range":{"year_completed":{"gte":1}}}]} + + For a more detailed guide on filter types, [refer to this](https://www.elastic.co/guide/en/elasticsearch/reference/6.8/query-dsl-bool-query.html). + + Filter types cannot be used alone and must be used in conjunction with a match type to complete the query. + + **Match Types:** + + A match type is a match operator nested within a filter type that fine-tunes the matching condition of the text search. The supported match types are: + + * **match** - Search within a full text field for a single word + > {"match":{"street":"serangoon"}} + * **match_phrase** - Search within a full text field + > {"match_phrase":{"street":"serangoon central"}} + * **match_phrase_prefix** - Search within a full text field with prefix + > {"match_phrase_prefix":{"street":"serangoon central"}} + * **term** - Returns results that contain an exact term in a provided field + > {"term":{"postalcode":"650634"}} + * **terms** - Returns results that contain one or more exact terms in a provided field + > {"terms":{"postalcode":["650634","650633"]}} + + * **range** - Returns results that contain terms within a stipulated range + + > {"range":{"4room_sold":{"gte":50}}} + > {"range":{"4room_sold":{"lte":50}}} + > {"range":{"4room_sold":{"gte":50,"lte":70}}} + + + * **exists** - Returns results that contain any indexed value for a field + + > {"exists":{ "field": "postalcode"}} + + For a more detailed guide to match types, [refer to this](https://www.elastic.co/guide/en/elasticsearch/reference/7.9/term-level-queries.html). + + **Forming sophisticated queries using combinations of filter types (in JSON)** + + Multiple filter types can be combined together in one query (written in JSON format) to form a very sophisticated query. Here’s one example below: + + > { + > "must":[{"match_phrase":{"street":"serangoon+central"}}], + > "filter":[{"range":{"year_completed":{"gte":1}}}], + > "should":[{"match":{"postalcode":"650633"}}], + > "must_not":[{"match":{"postalcode":"650634"}}] + > } + + + **Sample Queries Based on Use Cases** + + 1. **Search for all the four room units sold at Bishan Street 24.** + + Using a filterdata only: + + > filterdata = {"filter":[{"match_phrase": {"street":"bishan street 24"}},{"range": {"4room_sold":{"gte":1}}}]} + + version: '0.1.0' +servers: + - url: 'https://api.sentient.io' +tags: +- name: "v0.1.0" + description: "Published Date - Nov 25, 2019" +paths: + /DaaS/prod/hdb/buildinginfo: + get: + tags: + - v0.1.0 + parameters: + - in: query + name: querystring + schema: + type: string + description: |+ + Simple keyword search for matches in all searchable fields. Keywords separated by spaces will return results containing any of those keywords. For exact phrase match, put entire phrase in double quotes (" "). + + If this field is set to null, by default the microservice will return all buildings (within the stated limit), which can be further refined through the filterdata field for more sophisticated queries. + + example: "serangoon" + default: false + - in: query + name: offset + schema: + type: integer + description: The offset of the record list ie the starting index + example: "0" + default: false + - in: query + name: limit + schema: + type: integer + description: The max records to return for the request. Default - 10, Max - 10000 + example: "10" + default: false + - in: query + name: filterdata + schema: + type: string + description: |+ + Refine the search further on any of the possible through the 4 filter types : + * must + * must_not + * should + * filter + default: false + example: |+ + {"must":[{"match_phrase":{"street":"serangoon+central"}}],"filter":[{"range":{"year_completed":{"gte":1}}}],"should":[{"match":{"postalcode":"650633"}}],"must_not":[{"match":{"postalcode":"650634"}}]} + responses: + '200': + description: success response + content: + application/json: + schema: + $ref: '#/components/schemas/success' + example: + results: + total: 12150 + max_score: 1 + hits: + - _index: sentient_buildinginfo_hdb_index + _type: dir_doc + _id: '750405' + _score: 1 + _source: + postalcode: '750405' + year_completed: 1999 + total_dwelling_units: 112 + 1room_sold: 0 + 2room_sold: 0 + 3room_sold: 0 + 4room_sold: 112 + 5room_sold: 0 + exec_sold: 0 + multigen_sold: 0 + studio_apartment_sold: 0 + 1room_rental: 0 + 2room_rental: 0 + 3room_rental: 0 + other_room_rental: 0 + block: 405 + street: ADMIRALTY LINK + xcoord: 26086.0996 + ycoord: 48325.8008 + address: 405 ADMIRALTY LINK + createddate: '2019-10-17' + lastupdated: '2019-10-17' + location: + lat: 1.37179535 + lon: 103.8469821 + source: hdb + message: Successfully Processed + status: Success + '401': + description: Unauthorized + content: + application/json: + schema: + $ref: '#/components/schemas/unauthorized' + '402': + description: Payment Required + content: + application/json: + schema: + $ref: '#/components/schemas/paymentrequired' + '403': + description: Forbidden + content: + application/json: + schema: + $ref: '#/components/schemas/forbidden' + '404': + description: Not Found + content: + application/json: + schema: + $ref: '#/components/schemas/notfound' + '419': + description: Input Field Missing + content: + application/json: + schema: + $ref: '#/components/schemas/inputfieldmissing' + '413': + description: Input Limit Exceeded + content: + application/json: + schema: + $ref: '#/components/schemas/inputlimitexceeded' + '415': + description: Invalid Input + content: + application/json: + schema: + $ref: '#/components/schemas/invalidinput' + '500': + description: Internal Server Error + content: + application/json: + schema: + $ref: '#/components/schemas/servererror' + '504': + description: Gateway Timeout + content: + application/json: + schema: + $ref: '#/components/schemas/gatewaytimeout' + security: + - APIAuthorizer: [] +components: + schemas: + success: + type: object + properties: + results: + type: object + example: {} + description: Json Object of returned results + properties: + total: + type: number + example: 12150 + description: Total number of records + max_score: + type: number + example: 1 + description: The highest score value + hits: + type: array + example: [{} + description: Json Object of returned hits + properties: + postalcode: + type: string + description: Postal code + example: '750405' + year_completed: + type: number + description: Completed year of the Building + example: 1999 + total_dwelling_units: + type: number + description: Total Dwelling units + example: 112 + 1room_sold: + type: number + description: No. of one room units sold + example: 0 + 2room_sold: + type: number + description: No. of two room units sold + example: 0 + 3room_sold: + type: number + description: No. of three room units sold + example: 0 + 4room_sold: + type: number + description: No. of four room units sold + example: 112 + 5room_sold: + type: number + description: No. of five room units sold + example: 0 + exec_sold: + type: number + description: No. of executive units sold + example: 0 + multigen_sold: + type: number + description: No. of multi generation units sold + example: 0 + studio_apartment_sold: + type: number + description: No. of studio units sold + example: 0 + 1room_rental: + type: number + description: No. of one room units rented + example: 0 + 2room_rental: + type: number + description: No. of two room units rented + example: 0 + 3room_rental: + type: number + description: No. of three room units rented + example: 0 + other_room_rental: + type: number + description: No. of other units rented + example: 0 + block: + type: string + description: Block Number + example: 405 + street: + type: string + description: Street + example: ADMIRALTY LINK + xcoord: + type: string + description: SVY21 X coordinates + example: 26086.0996 + ycoord: + type: string + description: SVY21 Y coordinates + example: 48325.8008 + address: + type: string + description: Full address + example: 405 ADMIRALTY LINK + createddate: + type: string + description: Record first release date on sentient + example: '2019-10-17' + lastupdated: + type: string + description: Record last updated date on sentient + example: '2019-10-17' + location: + type: object + description: WGS84 coordinates lat/long + example: {"lat":1.350748,"lon":103.872798} + properties: + lat: + type: string + description: WGS84 latitude + example: 1.37179535 + lon: + type: string + description: WGS84 longitude + example: 103.8469821 + source: + type: string + description: Dataset source + example: hdb + message: + type: string + example: Successfully Processed + description: The detail description on the status + status: + type: string + example: Success + description: The status of the API call Success/Failure + unauthorized: + type: object + properties: + message: + type: string + example: Missing Authentication Token + status: + type: string + example: Failure + forbidden: + type: object + properties: + message: + type: string + example: Access Denied Unauthorized User + status: + type: string + example: Failure + paymentrequired: + type: object + properties: + message: + type: string + example: Insufficient Credits Kindly Top Up + status: + type: string + example: Failure + notfound: + type: object + properties: + message: + type: string + example: Invalid Request URL + status: + type: string + example: Failure + servererror: + type: object + properties: + message: + type: string + example: Internal Server Error + status: + type: string + example: Failure + invalidinput: + type: object + properties: + message: + type: string + example: Invalid Input + status: + type: string + example: Failure + gatewaytimeout: + type: object + properties: + message: + type: string + example: Request Timeout + status: + type: string + example: Failure + inputfieldmissing: + type: object + properties: + message: + type: string + example: Input Field Missing + status: + type: string + example: Failure + inputlimitexceeded: + type: object + properties: + message: + type: string + example: Input Limit Exceeded + status: + type: string + example: Failure + versions: + type: object + properties: + v0.1.0: + type: array + items: + oneOf: + - type: string + example: Published Date - Nov 25,2019 + description: Initial version release + securitySchemes: + APIAuthorizer: + type: apiKey + name: x-api-key + in: header + x-amazon-apigateway-authtype: custom + description: Authentication is done using the x-api-key in the request header. diff --git a/data/season_parking_availability_hdb_sg.yaml b/data/season_parking_availability_hdb_sg.yaml new file mode 100644 index 000000000..ffe3d2bd6 --- /dev/null +++ b/data/season_parking_availability_hdb_sg.yaml @@ -0,0 +1,440 @@ +openapi: 3.0.1 +info: + title: HDB Season Parking Availability (SG) + x-subscribelink: season_parking_availability_hdb_sg + description: |+ + This Data microservice returns information on season car park availability within Housing Development Board of Singapore (HDB) estates and includes the location address, postal code, branch office, vehicle type and parking lot availability for different types of vehicle by carpark location. + The HDB POTH programme makes selected public and non-public datasets available to developers and companies to improve their service offerings to benefit the lives of Singapore citizens. Sentient.io is proud to partner with HDB to manage and facilitate the sharing of data for the POTH Programme. + **Note:** As this microservice uses the GET method, developers using this microservice must remember to have their app encode all the input values to be URL friendly (i.e. all spaces and special characters must be replaced). Here’s a reference on [URL encoding](https://www.w3schools.com/tags/ref_urlencode.ASP). + + x-additionalinfo : |+ + Suggested Use Cases: + - Real estate services - can be used as a background check solution to extract information related to season car park availability in an area for people with certain preferences when buying or renting a HDB home. + - Can also be integrated into apps related to maps or parking for more detailed carpark information within Singapore HDB estates + + **Refining queries in the filterdata field using filter types and match types** + The filterdata fields use elasticsearch’s syntax (specifically filter types and match types) to help further refine search results and provide greater flexibility in structuring more sophisticated queries. + + **Filter Types:** + A filter type is a logic operator to which the search results must fulfill certain logical conditions to be returned. The supported match types are: + + * **must** - All of the stated conditions must match. Equivalent to an AND operator. + + > {"must":[{"match_phrase":{"street":"serangoon north avenue 4"}}]} + + * **must_not** - All of the stated conditions must not match. Equivalent to a NOT operator. + > {"must_not":[{"match":{"postalcode":"570251"}}]} + + * **should** - At least one of the stated conditions should match. Equivalent to an OR operator. + > {"should":[{"match_phrase":{"street":"serangoon north avenue 4"}}]} + + * **filter** - All of the stated conditions that must match. However, results are not scored unlike the other filter types which returns results based on how well the conditions are met. + > {"filter":[{"match":{"street":"serangoon"}}]} + + For a more detailed guide on filter types, [refer to this](https://www.elastic.co/guide/en/elasticsearch/reference/6.8/query-dsl-bool-query.html). + + Filter types cannot be used alone and must be used in conjunction with a match type to complete the query. + + **Match Types:** + + A match type is a match operator nested within a filter type that fine-tunes the matching condition of the text search. The supported match types are: + + * **match** - Search within a full text field for a single word + > {"match":{"street":"serangoon"}} + * **match_phrase** - Search within a full text field + > {"match_phrase":{"street":"bishan street 24"}} + * **match_phrase_prefix** - Search within a full text field with prefix + > {"match_phrase_prefix":{"street":"bishan street 24"}} + * **term** - Returns results that contain an exact term in a provided field + > {"term":{"car_park_group":"G15"}} + * **terms** - Returns results that contain one or more exact terms in a provided field + > {"terms":{"car_park_group":["G15","G39"]}} + + * **range** - Returns results that contain terms within a stipulated range + + > {"range":{"car_park_availability":{"gte":10}}} + > {"range":{"car_park_availability":{"lte":50}}} + > {"range":{"car_park_availability":{"gte":10,"lte":50}}} + + * **exists** - Returns results that contain any indexed value for a field + + > {"exists":{ "field": "postalcode"}} + For a more detailed guide to match types, [refer to this](https://www.elastic.co/guide/en/elasticsearch/reference/7.9/term-level-queries.html). + + **Forming sophisticated queries using combinations of filter types (in JSON)** + Multiple filter types can be combined together in one query (written in JSON format) to form a very sophisticated query. Here’s one example below: + + > { + > "must":[{"match_phrase":{"street":"serangoon north avenue 4"}}], + > "filter":[{"match":{"vehicle_type":"Y"}}], + > "should":[{"match":{"car_park_group":"G18"}}], + > "must_not":[{"match":{"postalcode":"550409"}}] + > } + **Sample Queries Based on Use Cases** + + 1. **Search for the parking lot availability for commercial vehicle at the carpark of 503 Serangoon North Avenue 4.** + + Using a filterdata only: + + > filterdata = {"filter":[{"match":{"street":"serangoon north avenue 4"}},{"match":{"block":"503"}},{"match":{"vehicle_type":"H"}}]} + + version: '0.1.0' +servers: + - url: 'https://api.sentient.io' +tags: +- name: "v0.1.0" + description: "Published Date - May 15, 2020" +paths: + /DaaS/prod/hdb/carparkavailability: + get: + tags: + - v0.1.0 + parameters: + - in: query + name: querystring + schema: + type: string + description: |+ + Simple keyword search for matches in all searchable fields. Keywords separated by spaces will return results containing any of those keywords. For exact phrase match, put entire phrase in double quotes (" "). + + If this field is set to null, by default the microservice will return all carparks (within the stated limit), which can be further refined through the filterdata field for more sophisticated queries. + + example: serangoon + default: false + - in: query + name: offset + schema: + type: integer + description: The offset of the record list ie the starting index + example: "0" + default: false + - in: query + name: limit + schema: + type: integer + description: The max records to return for the request. Default - 10, Max - 10000 + example: "10" + default: false + - in: query + name: filterdata + schema: + type: string + description: |+ + Refine the search further on any of the possible through the 4 filter types : + * must + * must_not + * should + * filter + default: false + example: |+ + {"must":[{"match_phrase":{"street":"serangoon north avenue 4"}}],"filter":[{"match":{"vehicle_type":"Y"}}],"should":[{"match":{"car_park_group":"G18"}}],"must_not":[{"match":{"postalcode":"550409"}}]} + responses: + '200': + description: success response + content: + application/json: + schema: + $ref: '#/components/schemas/success' + example: + results: + total: 1 + max_score: 13.663734 + hits: + - _index: sentient_carparklotsavailble_hdb_index + _type: dir_doc + _id: AM/G40/Y/552506 + _score: 13.663734 + _source: + branch_office: AM + car_park_group: G40 + vehicle_type: Y + car_park_availability: 15 + postalcode: '552506' + block: 506B + street: serangoon north avenue 4 + xcoord: 32714.002 + ycoord: 39399.7461 + address: 506B serangoon north avenue 4 + createddate: '2020-05-07' + lastupdated: '2020-05-07' + location: + lat: 1.37259145 + lon: 103.8756772 + source: hdb + message: Successfully Processed + status: Success + '401': + description: Unauthorized + content: + application/json: + schema: + $ref: '#/components/schemas/unauthorized' + '402': + description: Payment Required + content: + application/json: + schema: + $ref: '#/components/schemas/paymentrequired' + '403': + description: Forbidden + content: + application/json: + schema: + $ref: '#/components/schemas/forbidden' + '404': + description: Not Found + content: + application/json: + schema: + $ref: '#/components/schemas/notfound' + '419': + description: Input Field Missing + content: + application/json: + schema: + $ref: '#/components/schemas/inputfieldmissing' + '413': + description: Input Limit Exceeded + content: + application/json: + schema: + $ref: '#/components/schemas/inputlimitexceeded' + '415': + description: Invalid Input + content: + application/json: + schema: + $ref: '#/components/schemas/invalidinput' + '500': + description: Internal Server Error + content: + application/json: + schema: + $ref: '#/components/schemas/servererror' + '504': + description: Gateway Timeout + content: + application/json: + schema: + $ref: '#/components/schemas/gatewaytimeout' + security: + - APIAuthorizer: [] +components: + schemas: + success: + type: object + properties: + results: + type: object + example: {} + description: Json Object of returned results + properties: + total: + type: number + example: 1 + description: Total number of records + max_score: + type: number + example: 13.663734 + description: The highest score value + hits: + type: array + example: [{} + description: Json Object of returned hits + properties: + branch_office: + type: string + description: Branch Office + example: AM + car_park_group: + type: string + description: Car Park Group + example: "G40" + vehicle_type: + type: string + description: |+ + Vehicle Type: + + Y - Motorcycle + H - Commercial Vehicle (>1800kg) + C - Car + S - Season (Car) + example: "Y" + car_park_availability: + type: number + description: Car Park Availability + example: 15 + postalcode: + type: array + description: Postal code + example: "552506" + block: + type: array + description: Block + example: "506B" + street: + type: array + description: street + example: "serangoon north avenue 4" + xcoord: + type: string + description: SVY21 X coordinates + example: 32714.002 + ycoord: + type: string + description: SVY21 Y coordinates + example: 39399.7461 + address: + type: string + description: address + example: 506B serangoon north avenue 4 + source: + type: string + description: Dataset source + example: hdb + location: + type: object + description: WGS84 coordinates lat/long + example: {"lat":1.37259145,"lon":103.8756772} + properties: + lat: + type: string + description: WGS84 latitude + example: 1.37259145 + lon: + type: string + description: WGS84 longitude + example: 103.8756772 + createddate: + type: string + description: Record first release date on sentient + example: "2019-10-17" + lastupdated: + type: string + description: Record last updated date on sentient + example: "2019-10-17" + message: + type: string + example: Successfully Processed + description: The detail description on the status + status: + type: string + example: Success + description: The status of the API call Success/Failure + unauthorized: + type: object + properties: + message: + type: string + example: Missing Authentication Token + status: + type: string + example: Failure + forbidden: + type: object + properties: + message: + type: string + example: Access Denied Unauthorized User + status: + type: string + example: Failure + paymentrequired: + type: object + properties: + message: + type: string + example: Insufficient Credits Kindly Top Up + status: + type: string + example: Failure + invalidinput: + type: object + properties: + message: + type: string + example: Invalid Input + status: + type: string + example: Failure + notfound: + type: object + properties: + message: + type: string + example: Invalid Request URL + status: + type: string + example: Failure + servererror: + type: object + properties: + message: + type: string + example: Internal Server Error + status: + type: string + example: Failure + gatewaytimeout: + type: object + properties: + message: + type: string + example: Request Timeout + status: + type: string + example: Failure + inputfieldmissing: + type: object + properties: + message: + type: string + example: Input Field Missing + status: + type: string + example: Failure + inputlimitexceeded: + type: object + properties: + message: + type: string + example: Input Limit Exceeded + status: + type: string + example: Failure + versions: + type: object + properties: + v0.1.0: + type: array + items: + oneOf: + - type: string + example: Published Date - May 15,2020 + description: Initial version release + securitySchemes: + APIAuthorizer: + type: apiKey + name: x-api-key + in: header + x-amazon-apigateway-authtype: custom + description: Authentication is done using the x-api-key in the request header. diff --git a/data_alliance/download_dataset.yaml b/data_alliance/download_dataset.yaml new file mode 100644 index 000000000..34c1dc112 --- /dev/null +++ b/data_alliance/download_dataset.yaml @@ -0,0 +1,10 @@ +info: + title: Data Alliance - Download Dataset API + version: '0.1.0' +# tags must include in to the documentation, to read the description text for published date +tags: +- name: "v0.1.0" + description: " " +html: |+ + diff --git a/index.yaml b/index.yaml new file mode 100644 index 000000000..55d96b25e --- /dev/null +++ b/index.yaml @@ -0,0 +1,284 @@ +# This yaml file been updated for Sentient.io API Documentation v4.0.0 Beta +# Latest update : 2021-Feb-4 +# For adding new microservices, please follow the format below: + +#------------------------------------------------- +# +# /// - microservice category have to be lower case, +# ///the category name will be exactely same as the folder name +# Category (voice / computer vision / nlp / etc.): +# /// - microservice SHOULD be same as the file name, except, don't need the version number +# microservice_name: +# /// - This will be the title appeared in the side navigation +# /// - Use the same title from info.title inside the microservice yaml file +# title: "Some Title" +# /// - Versions will contain version number and file name for each version +# versions: +# v1.0: "yaml_file_name_goes_here_v1.0.yaml" +# 0.1.0: "yaml_file_name_goes_here_0.1.0.yaml" +# +#------------------------------------------------- + +# For Sentient.io API documentation maintenance: +# There is a yamlPath variable contains the path of where the yaml file is stored +# The final yaml link will be a combination of {{yamlPath + / + category + / + verions['v1.0']}} + +voice: + automatic_speech_recognition_eng_sg: + title: Automatic Speech Recognition ENG (SG) + versions: + 1.1.0: 'automatic_speech_recognition_eng_sg_v1.0.yaml' + 0.1.0: 'automatic_speech_recognition_eng_sg.yaml' + automatic_speech_recognition_chi_sg: + title: Automatic Speech Recognition CHI (SG) + versions: + 0.1.0: 'automatic_speech_recognition_chi_sg.yaml' + online_automatic_speech_recognition_eng_sg: + title: Online Automatic Speech Recognition ENG (SG) + versions: + 0.1.0: 'online_automatic_speech_recognition_eng_sg.yaml' + online_command_automatic_speech_recognition_eng_sg: + title: Online Command Automatic Speech Recognition ENG (SG) + versions: + 0.1.0: 'online_command_automatic_speech_recognition_eng_sg.yaml' + text-to-speech_eng: + title: Text-To-Speech ENG + versions: + 0.1.0: 'text-to-speech_eng.yaml' + text-to-speech_chi: + title: Text-To-Speech CHI + versions: + 0.1.0: 'text-to-speech_chi.yaml' + asr_with_voice_activity_detection_eng_sg: + title: ASR with Voice Activity Detection ENG (SG) + versions: + 1.1.0: 'asr_with_voice_activity_detection_eng_sg_v1.0.yaml' + 0.1.0: 'asr_with_voice_activity_detection_eng_sg.yaml' + voice_activity_detection_eng: + title: Voice Activity Detection ENG + versions: + 1.1.0: 'voice_activity_detection_eng_v1.0.yaml' + 0.1.0: 'voice_activity_detection_eng.yaml' +nlp: + inverse_text_normalisation_eng: + title: Inverse Text Normalisation ENG + versions: + 1.1.0: 'inverse_text_normalisation_eng_v1.0.yaml' + 0.1.0: 'inverse_text_normalisation_eng.yaml' + named-entity_recognition_eng: + title: Named-Entity Recognition ENG + versions: + 1.1.0: 'named-entity_recognition_eng_v1.0.yaml' + 0.1.0: 'named-entity_recognition_eng.yaml' + spacy_ner: + title: spaCy NER + versions: + 0.1.0: 'spacy_named-entity_recognition_eng.yaml' + page_profiler_eng: + title: Page Profiler ENG + versions: + 2.1.1: 'page_profiler_eng_v2.1.yaml' + page_profiler_jp: + title: Page Profiler JP + versions: + 1.1.0: 'page_profiler_jp.yaml' + page_profiler_thai: + title: Page Profiler THAI + versions: + 1.1.0: 'page_profiler_thai.yaml' + taxonomy_matcher_eng: + title: Taxonomy Matcher ENG + versions: + 1.0.0: 'taxonomy_matcher_eng_v1.0.yaml' + 0.1.0: 'taxonomy_matcher_eng.yaml' + word_sense_disambiguation_eng: + title: Word Sense Disambiguation ENG + versions: + 1.0.0: 'word_sense_disambiguation_eng_v1.0.yaml' + 0.1.0: 'word_sense_disambiguation_eng.yaml' + named-entity_recognition_jp: + title: Named-Entity Recognition JP + versions: + 1.0.0: 'named-entity_recognition_jp_v1.0.yaml' + 0.1.0: 'named-entity_recognition_jp.yaml' + named-entity_recognition_thai: + title: Named Entity Recognition THAI + versions: + 1.0.0: 'named-entity_recognition_thai_v1.0.yaml' + 0.1.0: 'named-entity_recognition_thai.yaml' + script_alignment: + title: Script Alignment + versions: + 1.0.0: 'script_alignment_v1.0.yaml' + 0.1.0: 'script_alignment.yaml' +computer vision: + object_detection: + title: Object Detection + versions: + 1.0.0: 'object_detection_v1.0.yaml' + 0.1.0: 'object_detection.yaml' + face_recognition: + title: Face Recognition + versions: + 1.0.1: 'face_recognition_v1.0.yaml' + 0.1.0: 'face_recognition_politicians_sg.yaml' + people_counting: + title: People Counting + versions: + 1.0.0: 'people_counting_v1.0.yaml' + 0.1.0: 'people_counting.yaml' + landmark_detection_sg: + title: Landmark Detection (SG) + versions: + 1.0.0: 'landmark_detection_sg_v1.0.yaml' + 0.1.0: 'landmark_detection_sg.yaml' + landmark_detection_jp: + title: Landmark Detection (JP) + versions: + 1.0.0: 'landmark_detection_jp_v1.0.yaml' + 0.1.0: 'landmark_detection_jp.yaml' + demographics_classification: + title: Demographics Classification + versions: + 0.1.0: 'demographics_classification.yaml' +utility: + youtube_video_downloader: + title: Youtube Video Downloader + versions: + 0.1.0: 'youtube_video_downloader.yaml' + video-to-audio_convertor: + title: Video-To-Audio Convertor + versions: + 0.1.0: 'video-to-audio_convertor.yaml' + web_scraper: + title: Web Scraper + versions: + 1.1.1: 'web_scraper.yaml' + document_convertor_eng: + title: Document Convertor ENG + versions: + 1.0.0: 'document_convertor_eng.yaml' + pdf_extractor: + title: PDF Extractor + versions: + 1.0.0: 'pdf_extractor.yaml' + pki_key_generator: + title: PKI Key Generator + versions: + 0.1.0: 'pki_key_generator.yaml' + encryption_using_pki_key: + title: Encryption using PKI Key + versions: + 0.1.0: 'encryption_using_pki_key.yaml' + decryption_using_pki_key: + title: Decryption using PKI Key + versions: + 0.1.0: 'decryption_using_pki_key.yaml' + wikipedia_retrieval: + title: Wikipedia Retrieval + versions: + 1.0.0: 'wikipedia_retrieval_v1.0.yaml' + 0.1.0: 'wikipedia_retrieval.yaml' + json-csv_convertor: + title: JSON-CSV Convertor + versions: + 1.0.0: 'json-csv_convertor.yaml' + csv-json_convertor: + title: CSV-JSON Convertor + versions: + 1.0.0: 'csv-json_convertor.yaml' + audio_format_convertor: + title: Audio Format Convertor + versions: + 0.1.0: 'audio_format_convertor.yaml' + video-to-image_convertor: + title: Video-to-Image Convertor + versions: + 0.1.0: 'video-to-image_convertor.yaml' + newspaper_article_scraper: + title: Newspaper Article Scraper + versions: + 0.1.0: 'newspaper_article_scraper.yaml' + urls_retrieval: + title: URLs Retrieval + versions: + 0.2.1: 'urls_retrieval.yaml' + base64_encoder: + title: Base64 Encoder + versions: + 0.1.0: 'base64-encoder.yaml' + base64_decoder: + title: Base64 Decoder + versions: + 0.1.0: 'base64-decoder.yaml' +data: + commercial_directories_hdb_sg: + title: HDB Commercial Directories (SG) + versions: + 0.1.0: 'commercial_directories_hdb_sg.yaml' + building_addresses_hdb_sg: + title: HDB Block Coordinates (SG) + versions: + 0.1.0: 'building_addresses_hdb_sg.yaml' + residential_sales_and_rental_hdb_sg: + title: HDB Residential Occupancy Status (SG) + versions: + 0.1.0: 'residential_sales_and_rental_hdb_sg.yaml' + carpark_hdb_sg: + title: HDB Carpark Locations (SG) + versions: + 0.2.0: 'carpark_hdb_sg.yaml' + demographics_hdb_sg: + title: HDB Demographics (SG) + versions: + 0.1.0: 'demographics_hdb_sg.yaml' + flat_ownership_hdb_sg: + title: HDB Flat Ownership Duration (SG) + versions: + 0.1.0: 'flat_ownership_hdb_sg.yaml' + season_parking_availability_hdb_sg: + title: HDB Season Parking Availability (SG) + versions: + 0.1.0: 'season_parking_availability_hdb_sg.yaml' + directory_of_singapore_startups: + title: Directory of Singapore Startups + versions: + 0.1.0: 'directory_of_singapore_startups.yaml' + fitness_stations_and_playgrounds_hdb_sg: + title: HDB Fitness Stations and Playgrounds (SG) + versions: + 0.1.0: 'fitness_stations_and_playgrounds_hdb_sg.yaml' + amenities_lamp_posts_hdb_sg: + title: HDB Lamp Posts Locations (SG) + versions: + 0.1.0: 'amenities_lamp_posts_hdb_sg.yaml' + amenities_hardcourts_hdb_sg: + title: HDB Hardcourts Locations (SG) + versions: + 0.1.0: 'amenities_hardcourts_hdb_sg.yaml' + amenities_shelters_hdb_sg: + title: HDB Shelters Locations (SG) + versions: + 0.1.0: 'amenities_shelters_hdb_sg.yaml' + d&b_business_check_plus_sg: + title: D&B Business Check Plus (SG) + versions: + 0.1.0: 'd&b_business_check_plus_sg.yaml' + d&b_basic_individual_search_sg: + title: D&B Basic Individual Search (SG) + versions: + 0.1.0: 'd&b_basic_individual_search_sg.yaml' + d&b_business_check_sg: + title: D&B Business Check (SG) + versions: + 0.1.0: 'd&b_business_check_sg.yaml' + d&b_brief_financial_information_sg: + title: D&B Brief Financial Information (SG) + versions: + 0.1.0: 'd&b_brief_financial_information_sg.yaml' +data alliance: + download_dataset_api: + title: Download Dataset API + urlkey: download_dataset_api + versions: + 0.1.0: 'download_dataset.yaml' diff --git a/nlp/inverse_text_normalisation_eng.yaml b/nlp/inverse_text_normalisation_eng.yaml new file mode 100644 index 000000000..10520a858 --- /dev/null +++ b/nlp/inverse_text_normalisation_eng.yaml @@ -0,0 +1,228 @@ +openapi: 3.0.1 +info: + title: Inverse Text Normalisation ENG + description: |+ + This NLP microservice recovers missing punctuations such as full stop, comma, exclamation mark, and question mark from the input text. + + This NLP microservice also converts pre-defined abbreviations from lower case to upper case. + + This NLP microservice also converts first letters of sentences to upper case. + x-additionalinfo: |+ + Suggested Use Cases: + - Can be integrated into services or apps that offer digital writing assistance to make writing clear and effective. + version: '0.1.0' + x-subscribelink: inverse_text_normalisation_eng +servers: + - url: 'https://apis.sentient.io' +tags: +- name: "v0.1.0" + description: "Published Date - Mar 24, 2020" +paths: + /microservices/nlp/inversenorm/v0.1/getpredictions: + post: + tags: + - v0.1.0 + responses: + '200': + description: success response + content: + application/json: + schema: + $ref: '#/components/schemas/success' + example: + '0': |+ + Apple said, the project-financing fund was the 1 of its kind, real estate developers, + often secure bonds for affordable housing development, but must service the debt + during construction, until the houses are built and start to generate revenue, apple + and state officials hope to provide bridge financing during construction at rates + below those from commercial lenders. + '1': |+ + The $2000000000 in funding will be deployable across NTU while the remaining + 5500000000 will go toward efforts specific to apple's home region in northern california, + where fast-growing tech companies have drawn protests from residents who blame them + for rising, housing costs. + '401': + description: Unauthorized + content: + application/json: + schema: + $ref: '#/components/schemas/unauthorized' + '402': + description: Payment Required + content: + application/json: + schema: + $ref: '#/components/schemas/paymentrequired' + '403': + description: Forbidden + content: + application/json: + schema: + $ref: '#/components/schemas/forbidden' + '404': + description: Not Found + content: + application/json: + schema: + $ref: '#/components/schemas/notfound' + '419': + description: Input Field Missing + content: + application/json: + schema: + $ref: '#/components/schemas/inputfieldmissing' + '413': + description: Input Limit Exceeded + content: + application/json: + schema: + $ref: '#/components/schemas/inputlimitexceeded' + '415': + description: Invalid Input + content: + application/json: + schema: + $ref: '#/components/schemas/invalidinput' + '500': + description: Internal Server Error + content: + application/json: + schema: + $ref: '#/components/schemas/servererror' + '504': + description: Gateway Timeout + content: + application/json: + schema: + $ref: '#/components/schemas/gatewaytimeout' + security: + - APIAuthorizer: [] + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/input' + required: true +components: + schemas: + success: + type: object + properties: + : + type: string + example: { 0: Apple said, the project-financing fund was the 1 of its kind, real estate developers, often secure bonds for affordable housing development, but must service the debt during construction, until the houses are built and start to generate revenue, apple and state officials hope to provide bridge financing during construction at rates below those from commercial lenders.} + description: Order sequence number + unauthorized: + type: object + properties: + message: + type: string + example: Missing Authentication Token + status: + type: string + example: Failure + forbidden: + type: object + properties: + message: + type: string + example: Access Denied Unauthorized User + status: + type: string + example: Failure + paymentrequired: + type: object + properties: + message: + type: string + example: Insufficient Credits Kindly Top Up + status: + type: string + example: Failure + notfound: + type: object + properties: + message: + type: string + example: Invalid Request URL + status: + type: string + example: Failure + servererror: + type: object + properties: + message: + type: string + example: Internal Server Error + status: + type: string + example: Failure + gatewaytimeout: + type: object + properties: + message: + type: string + example: Request Timeout + status: + type: string + example: Failure + inputfieldmissing: + type: object + properties: + message: + type: string + example: Input Field Missing + status: + type: string + example: Failure + inputlimitexceeded: + type: object + properties: + message: + type: string + example: Input Limit Exceeded + status: + type: string + example: Failure + invalidinput: + type: object + properties: + message: + type: string + example: Invalid Input + status: + type: string + example: Failure + versions: + type: object + properties: + v0.1.0: + type: array + items: + oneOf: + - type: string + example: Published Date - Mar 24, 2020 + description: Initial version release + input: + type: array + required: + - text + items: + type: object + properties: + text: + x-name: text + type: string + default: true + example: Apple said the project-financing fund was the first of its kind Real estate developers often secure bonds for affordable housing development but must service the debt during construction until the houses are built and start to generate revenue Apple and state officials hope to provide bridge financing during construction at rates below those from commercial lenders + description: |+ + Input text. + + Supported formats: ASCII only + securitySchemes: + APIAuthorizer: + type: apiKey + name: x-api-key + in: header + x-amazon-apigateway-authtype: custom + description: Authentication is done using the x-api-key in the request header diff --git a/nlp/inverse_text_normalisation_eng_v1.0.yaml b/nlp/inverse_text_normalisation_eng_v1.0.yaml new file mode 100644 index 000000000..63e1e1e8b --- /dev/null +++ b/nlp/inverse_text_normalisation_eng_v1.0.yaml @@ -0,0 +1,248 @@ +openapi: 3.0.1 +info: + title: Inverse Text Normalisation ENG + description: |+ + This NLP microservice recovers the missing punctuations such as full stop, comma, exclamation mark, and question mark from the input text. + + It converts pre-defined abbreviations from lower case to upper case and also first letters of sentences to upper case. + + Do ensure that your text is within **5000 characters**. + version: '1.0.0' + x-additionalinfo: |+ + Suggested Use Cases: + - Can be integrated into services or apps that offer digital writing assistance to make writing clear and effective. + x-subscribelink: inverse_text_normalisation_eng +servers: + - url: 'https://apis.sentient.io' +tags: +- name: "v1.0.0" + description: "Published Date - Oct 30, 2020" +paths: + /microservices/nlp/inversenorm/v1/getpredictions: + post: + tags: + - v1.0.0 + responses: + '200': + description: success response + content: + application/json: + schema: + $ref: '#/components/schemas/success' + example: + results: + '0': |+ + Apple said, the project-financing fund was the 1 of its kind, real estate developers, + often secure bonds for affordable housing development, but must service the debt + during construction, until the houses are built and start to generate revenue, apple + and state officials hope to provide bridge financing during construction at rates + below those from commercial lenders. + '1': |+ + The $2000000000 in funding will be deployable across NTU while the remaining + 5500000000 will go toward efforts specific to apple's home region in northern california, + where fast-growing tech companies have drawn protests from residents who blame them + for rising, housing costs. + message: Successfully Processed + status: Success + '401': + description: Unauthorized + content: + application/json: + schema: + $ref: '#/components/schemas/unauthorized' + '402': + description: Payment Required + content: + application/json: + schema: + $ref: '#/components/schemas/paymentrequired' + '403': + description: Forbidden + content: + application/json: + schema: + $ref: '#/components/schemas/forbidden' + '404': + description: Not Found + content: + application/json: + schema: + $ref: '#/components/schemas/notfound' + '419': + description: Input Field Missing + content: + application/json: + schema: + $ref: '#/components/schemas/inputfieldmissing' + '413': + description: Input Limit Exceeded + content: + application/json: + schema: + $ref: '#/components/schemas/inputlimitexceeded' + '415': + description: Invalid Input + content: + application/json: + schema: + $ref: '#/components/schemas/invalidinput' + '500': + description: Internal Server Error + content: + application/json: + schema: + $ref: '#/components/schemas/servererror' + '504': + description: Gateway Timeout + content: + application/json: + schema: + $ref: '#/components/schemas/gatewaytimeout' + security: + - APIAuthorizer: [] + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/input' + required: true +components: + schemas: + success: + type: object + properties: + results: + type: object + description: The result of the API call. + example: { "" } + properties: + : + x-name: + type: string + example: { 0: Apple said, the project-financing fund was the 1 of its kind, real estate developers, often secure bonds for affordable housing development, but must service the debt during construction, until the houses are built and start to generate revenue, apple and state officials hope to provide bridge financing during construction at rates below those from commercial lenders.} + description: Order sequence number + message: + type: string + example: Successfully Processed + description: Detail description on the API status + status: + type: string + example: Success + description: The status of the API call success/failure + unauthorized: + type: object + properties: + message: + type: string + example: Missing Authentication Token + status: + type: string + example: Failure + forbidden: + type: object + properties: + message: + type: string + example: Access Denied Unauthorized User + status: + type: string + example: Failure + paymentrequired: + type: object + properties: + message: + type: string + example: Insufficient Credits Kindly Top Up + status: + type: string + example: Failure + notfound: + type: object + properties: + message: + type: string + example: Invalid Request URL + status: + type: string + example: Failure + servererror: + type: object + properties: + message: + type: string + example: Internal Server Error + status: + type: string + example: Failure + gatewaytimeout: + type: object + properties: + message: + type: string + example: Request Timeout + status: + type: string + example: Failure + inputfieldmissing: + type: object + properties: + message: + type: string + example: Input Field Missing + status: + type: string + example: Failure + inputlimitexceeded: + type: object + properties: + message: + type: string + example: Input Limit Exceeded + status: + type: string + example: Failure + invalidinput: + type: object + properties: + message: + type: string + example: Invalid Input + status: + type: string + example: Failure + versions: + type: object + properties: + v1.0.0: + type: array + items: + oneOf: + - type: string + example: Published Date - Oct 30,2020 + description: Standardizing Output JSON + v0.1.0: + type: array + items: + oneOf: + - type: string + example: Published Date - Mar 24, 2020 + description: Initial version release + input: + type: object + required: + - text + properties: + text: + x-name: text + type: string + default: true + example: Apple said the project-financing fund was the first of its kind Real estate developers often secure bonds for affordable housing development but must service the debt during construction until the houses are built and start to generate revenue Apple and state officials hope to provide bridge financing during construction at rates below those from commercial lenders + description: |+ + Input text + securitySchemes: + APIAuthorizer: + type: apiKey + name: x-api-key + in: header + x-amazon-apigateway-authtype: custom + description: Authentication is done using the x-api-key in the request header diff --git a/nlp/named-entity_recognition_eng.yaml b/nlp/named-entity_recognition_eng.yaml new file mode 100644 index 000000000..1a81a8283 --- /dev/null +++ b/nlp/named-entity_recognition_eng.yaml @@ -0,0 +1,264 @@ +openapi: 3.0.1 +info: + title: Named-Entity Recognition ENG + description: |+ + This NLP microservice locates and classifies the named-entities classes from input unstructured English text. + + The named-entity classes extracted are persons, locations, organisations and miscellaneous. + + This microservice automatically extracts structured information from unstructured text data such as chatlogs, emails, news articles, etc. + + Do ensure that your text is within **5000 characters**. + x-additionalinfo: |+ + Suggested Use Cases: + - Extracting structured pre-defined information from text. + + - Gain insights from online customers - extract structured information from unstructured text data such as chatlogs, emails, news articles, etc. to find and label fields within a document and then apply sentiment analysis to understand customer opinions to find actionable product and UX insights. + + - Entity analysis - identify entities within documents, including receipts, invoices, and contracts; and label them by types such as date, person, contact information, organization, location, events, products, and media. + version: '0.1.0' + x-subscribelink: named-entity_recognition_eng +servers: + - url: 'https://apis.sentient.io' +tags: +- name: "v0.1.0" + description: "Published Date - Nov 25, 2019" +paths: + /microservices/nlp/namedentityrecognition/v0.1/getpredictions: + post: + tags: + - v0.1.0 + responses: + '200': + description: success response + content: + application/json: + schema: + $ref: '#/components/schemas/success' + example: + LOC: + - America + - Saudi Arabia + - Yemen + - Abqaiq + - Iraq + - Iran + - Khurais + MISC: + - Arabian + - American + - Saudi + - Iranian + - Shia + ORG: + - Houthi + PER: + - DONALD TRUMP + - Mike Pompeo + '401': + description: Unauthorized + content: + application/json: + schema: + $ref: '#/components/schemas/unauthorized' + '402': + description: Payment Required + content: + application/json: + schema: + $ref: '#/components/schemas/paymentrequired' + '403': + description: Forbidden + content: + application/json: + schema: + $ref: '#/components/schemas/forbidden' + '404': + description: Not Found + content: + application/json: + schema: + $ref: '#/components/schemas/notfound' + '419': + description: Input Field Missing + content: + application/json: + schema: + $ref: '#/components/schemas/inputfieldmissing' + '413': + description: Input Limit Exceeded + content: + application/json: + schema: + $ref: '#/components/schemas/inputlimitexceeded' + '415': + description: Invalid Input + content: + application/json: + schema: + $ref: '#/components/schemas/invalidinput' + '500': + description: Internal Server Error + content: + application/json: + schema: + $ref: '#/components/schemas/servererror' + '504': + description: Gateway Timeout + content: + application/json: + schema: + $ref: '#/components/schemas/gatewaytimeout' + security: + - APIAuthorizer: [] + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/input' + required: true +components: + schemas: + success: + type: object + properties: + LOC: + x-name: LOC + type: array + example: [ America,Saudi Arabia,Yemen,Abqaiq ] + description: "name of location found in the text string" + MISC: + x-name: MISC + type: array + example: [ Arabian,American,Saudi ] + description: "name of miscellaneous names found in the text string" + ORG: + x-name: ORG + type: array + example: [ Houthi ] + description: "name of organizations found in the text string" + PER: + x-name: PER + type: array + example: [ DONALD TRUMP,Mike Pompeo ] + description: "name of persons found in the text string" + + unauthorized: + type: object + properties: + message: + type: string + example: Missing Authentication Token + status: + type: string + example: Failure + forbidden: + type: object + properties: + message: + type: string + example: Access Denied Unauthorized User + status: + type: string + example: Failure + paymentrequired: + type: object + properties: + message: + type: string + example: Insufficient Credits Kindly Top Up + status: + type: string + example: Failure + notfound: + type: object + properties: + message: + type: string + example: Invalid Request URL + status: + type: string + example: Failure + servererror: + type: object + properties: + message: + type: string + example: Internal Server Error + status: + type: string + example: Failure + gatewaytimeout: + type: object + properties: + message: + type: string + example: Request Timeout + status: + type: string + example: Failure + inputfieldmissing: + type: object + properties: + message: + type: string + example: Input Field Missing + status: + type: string + example: Failure + inputlimitexceeded: + type: object + properties: + message: + type: string + example: Input Limit Exceeded + status: + type: string + example: Failure + invalidinput: + type: object + properties: + message: + type: string + example: Invalid Input + status: + type: string + example: Failure + versions: + type: object + properties: + v1.0.0: + type: array + items: + oneOf: + - type: string + example: Published Date - Nov 25,2019 + description: Updated version release v1.0 + v0.1.0: + type: array + items: + oneOf: + - type: string + example: Published Date - Nov 25,2019 + description: Initial version release + input: + type: object + required: + - text + properties: + text: + x-name: text + type: string + default: true + example: The Singaporean procedure of hanging condemned individuals is similar to the methods formerly used in the United Kingdom. + description: |+ + Input text. + + Supported formats: ASCII only + securitySchemes: + APIAuthorizer: + type: apiKey + name: x-api-key + in: header + x-amazon-apigateway-authtype: custom + description: Authentication is done using the x-api-key in the request header diff --git a/nlp/named-entity_recognition_eng_v1.0.yaml b/nlp/named-entity_recognition_eng_v1.0.yaml new file mode 100644 index 000000000..b5a977bcf --- /dev/null +++ b/nlp/named-entity_recognition_eng_v1.0.yaml @@ -0,0 +1,269 @@ +openapi: 3.0.1 +info: + title: Named-Entity Recognition ENG + description: |+ + This NLP microservice locates and classifies the named-entities classes from input unstructured English text. + + The named-entity classes extracted are persons, locations, organisations and miscellaneous. + + This microservice automatically extracts structured information from unstructured text data such as chatlogs, emails, news articles, etc. + + Do ensure that your text is within **5000 characters**. + version: '1.0.0' + x-additionalinfo: |+ + Suggested Use Cases: + - Extracting structured pre-defined information from text. + - Gain insights from online customers - extract structured information from unstructured text data such as chatlogs, emails, news articles, etc. to find and label fields within a document and then apply sentiment analysis to understand customer opinions to find actionable product and UX insights. + - Entity analysis - identify entities within documents, including receipts, invoices, and contracts; and label them by types such as date, person, contact information, organization, location, events, products, and media. + x-subscribelink: named-entity_recognition_eng +servers: + - url: 'https://apis.sentient.io' +tags: +- name: "v1.0.0" + description: "Published Date - Sep 30, 2020" +paths: + /microservices/nlp/namedentityrecognition/v1/getpredictions: + post: + tags: + - v1.0.0 + responses: + '200': + description: success response + content: + application/json: + schema: + $ref: '#/components/schemas/success' + example: {"message":"SuccessfullyProcessed","results":{"loc":["Hubei","Singapore","SINGAPORE","China","Immigration"],"misc":["ICA.They"],"org":["ImmigrationandCheckpointsAuthority","ICA","LOA"]},"status":"Success"} + '401': + description: Unauthorized + content: + application/json: + schema: + $ref: '#/components/schemas/unauthorized' + '402': + description: Payment Required + content: + application/json: + schema: + $ref: '#/components/schemas/paymentrequired' + '403': + description: Forbidden + content: + application/json: + schema: + $ref: '#/components/schemas/forbidden' + '404': + description: Not Found + content: + application/json: + schema: + $ref: '#/components/schemas/notfound' + '419': + description: Input Field Missing + content: + application/json: + schema: + $ref: '#/components/schemas/inputfieldmissing' + '413': + description: Input Limit Exceeded + content: + application/json: + schema: + $ref: '#/components/schemas/inputlimitexceeded' + '415': + description: Invalid Input + content: + application/json: + schema: + $ref: '#/components/schemas/invalidinput' + '500': + description: Internal Server Error + content: + application/json: + schema: + $ref: '#/components/schemas/servererror' + '504': + description: Gateway Timeout + content: + application/json: + schema: + $ref: '#/components/schemas/gatewaytimeout' + security: + - APIAuthorizer: [] + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/input' + required: true +components: + schemas: + success: + type: object + properties: + results: + type: object + example: { "" } + description: Json Object of returned results + properties: + loc: + type: array + items: + type: string + example: + - Hubei + - Singapore + - Hubei + - Hubei + - Immigration + description: "name of location found in the text string" + misc: + type: array + items: + type: string + example: + - ICA.They + description: "name of miscellaneous names found in the text string" + org: + type: array + items: + type: string + example: + - Immigration and Checkpoints Authority + - ICA + - LOA + description: "name of organizations names found in the text string" + per: + type: array + items: + type: string + example: + - Lee Hsien Loong + description: "person names found in the text string" + message: + type: string + example: Successfully Processed + description: Detail description on the API status + status: + type: string + example: Success + description: The status of the API call success/failure + unauthorized: + type: object + properties: + message: + type: string + example: Missing Authentication Token + status: + type: string + example: Failure + forbidden: + type: object + properties: + message: + type: string + example: Access Denied Unauthorized User + status: + type: string + example: Failure + paymentrequired: + type: object + properties: + message: + type: string + example: Insufficient Credits Kindly Top Up + status: + type: string + example: Failure + notfound: + type: object + properties: + message: + type: string + example: Invalid Request URL + status: + type: string + example: Failure + servererror: + type: object + properties: + message: + type: string + example: Internal Server Error + status: + type: string + example: Failure + gatewaytimeout: + type: object + properties: + message: + type: string + example: Request Timeout + status: + type: string + example: Failure + inputfieldmissing: + type: object + properties: + message: + type: string + example: Input Field Missing + status: + type: string + example: Failure + inputlimitexceeded: + type: object + properties: + message: + type: string + example: Input Limit Exceeded + status: + type: string + example: Failure + invalidinput: + type: object + properties: + message: + type: string + example: Invalid Input + status: + type: string + example: Failure + versions: + type: object + properties: + v1.0.0: + type: array + items: + oneOf: + - type: string + example: Published Date - Sep 30, 2020 + description: Updated version release v1.0 + v0.1.0: + type: array + items: + oneOf: + - type: string + example: Published Date - Nov 25,2019 + description: Initial version release + input: + type: object + required: + - text + properties: + text: + x-name: text + type: string + default: true + example: SINGAPORE - Immigration officers have issued 77 stay-home notices as of noon on Wednesday (Feb 19), 12 hours after the scheme kicked in.These notices were issued to Singapore residents, long-term pass holders and foreign workers who have travelled to mainland China in the last 14 days, said the Immigration and Checkpoints Authority (ICA) in response to queries on Thursday.Travellers from Hubei province are excluded from this scheme, as they are quarantined.Those who are issued the new notices, which took effect at 11.59pm on Tuesday, cannot leave their homes for 14 days./n This is stricter than the leave of absence (LOA), which allowed people to briefly leave their homes for necessities. LOA will no longer be issued.Those who do not observe the stay-home period can be prosecuted under the Infectious Diseases Act, warned the ICA.They could be fined up to $10,000 or jailed for up to six month, or both, for the first offence. For subsequent offences, this could go up to a maximum of $20,000 and up to a year. + description: |+ + Input text. + + Supported formats: ASCII only + securitySchemes: + APIAuthorizer: + type: apiKey + name: x-api-key + in: header + x-amazon-apigateway-authtype: custom + description: Authentication is done using the x-api-key in the request header diff --git a/nlp/named-entity_recognition_jp.yaml b/nlp/named-entity_recognition_jp.yaml new file mode 100644 index 000000000..c97d551bc --- /dev/null +++ b/nlp/named-entity_recognition_jp.yaml @@ -0,0 +1,255 @@ +openapi: 3.0.1 +info: + title: Named-Entity Recognition JP + description: |+ + This NLP microservice locates and classifies the named-entities classes from input unstructured Japanese text. + + The named-entity classes extracted are persons, locations, organisations and miscellaneous. + + This microservice automatically extracts structured information from unstructured text data such as chatlogs, emails, news articles, etc. + x-additionalinfo: |+ + Suggested Use Cases: + - Extract structured pre-defined information from text. + + - Insights from online customers - extract structured information from unstructured text data such as chatlogs, emails, news articles, etc. to find and label fields within a document and then apply sentiment analysis to understand customer opinions to find actionable product and UX insights. + + - Entity analysis - identify entities within documents, including receipts, invoices, and contracts; and label them by types such as date, person, contact information, organization, location, events, products, and media. + version: '0.1.0' + x-subscribelink: named-entity_recognition_jp +servers: + - url: 'https://apis.sentient.io' +tags: +- name: "v0.1.0" + description: "Published Date - May 15, 2020" +paths: + /microservices/nlp/japanesener/v0.1/getpredictions: + post: + tags: + - v0.1.0 + responses: + '200': + description: success response + content: + application/json: + schema: + $ref: '#/components/schemas/success' + example: + Company: + - 和歌山製鉄所 + Date: + - 7日,2023年9月 + - 22年9月 + Domestic_Region: + - 呉製鉄所 + Material: + - 鉄鋼最大手 + N_Product: + - 高炉2基 + - 2基","1基 + Province: + - 広島県呉市 + - 和歌山市 + '401': + description: Unauthorized + content: + application/json: + schema: + $ref: '#/components/schemas/unauthorized' + '402': + description: Payment Required + content: + application/json: + schema: + $ref: '#/components/schemas/paymentrequired' + '403': + description: Forbidden + content: + application/json: + schema: + $ref: '#/components/schemas/forbidden' + '404': + description: Not Found + content: + application/json: + schema: + $ref: '#/components/schemas/notfound' + '419': + description: Input Field Missing + content: + application/json: + schema: + $ref: '#/components/schemas/inputfieldmissing' + '413': + description: Input Limit Exceeded + content: + application/json: + schema: + $ref: '#/components/schemas/inputlimitexceeded' + '415': + description: Invalid Input + content: + application/json: + schema: + $ref: '#/components/schemas/invalidinput' + '500': + description: Internal Server Error + content: + application/json: + schema: + $ref: '#/components/schemas/servererror' + '504': + description: Gateway Timeout + content: + application/json: + schema: + $ref: '#/components/schemas/gatewaytimeout' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/input' + required: true + security: + - APIAuthorizer: [] +components: + schemas: + success: + type: object + properties: + Company: + x-name: Company + type: array + example: [ 和歌山製鉄所 ] + description: name of Company found in the text string + Date: + x-name: Date + type: array + example: [ 7日,2023年9月,22年9月 ] + description: name of Date found in the text string + Domestic_Region: + x-name: Domestic_Region + type: array + example: [ 呉製鉄所 ] + description: name of Domestic_Region found in the text string + Material: + x-name: Material + type: array + example: [ 鉄鋼最大手 ] + description: name of Material found in the text string + unauthorized: + type: object + properties: + message: + type: string + example: Missing Authentication Token + status: + type: string + example: Failure + forbidden: + type: object + properties: + message: + type: string + example: Access Denied Unauthorized User + status: + type: string + example: Failure + paymentrequired: + type: object + properties: + message: + type: string + example: Insufficient Credits Kindly Top Up + status: + type: string + example: Failure + notfound: + type: object + properties: + message: + type: string + example: Invalid Request URL + status: + type: string + example: Failure + servererror: + type: object + properties: + message: + type: string + example: Internal Server Error + status: + type: string + example: Failure + gatewaytimeout: + type: object + properties: + message: + type: string + example: Request Timeout + status: + type: string + example: Failure + inputfieldmissing: + type: object + properties: + message: + type: string + example: Input Field Missing + status: + type: string + example: Failure + inputlimitexceeded: + type: object + properties: + message: + type: string + example: Input Limit Exceeded + status: + type: string + example: Failure + invalidinput: + type: object + properties: + message: + type: string + example: Invalid Input + status: + type: string + example: Failure + versions: + type: object + properties: + v1.0.0: + type: array + items: + oneOf: + - type: string + example: Published Date - Sep 30,2020 + description: Updated version release v1.0 + v0.1.0: + type: array + items: + oneOf: + - type: string + example: Published Date - May 15,2020 + description: Initial version release + input: + type: object + required: + - text + properties: + text: + x-name: text + type: string + default: true + example: 鉄鋼最大手の日本製鉄は7日、高炉2基を備えた呉製鉄所（広島県呉市）を2023年9月までに全面休止すると発表した。閉鎖につながる可能性が高い。和歌山製鉄所（和歌山市）の高炉2基のうち1基を22年9月までに休止することも明らかにした。 + description: |+ + Input text + securitySchemes: + APIAuthorizer: + type: apiKey + name: x-api-key + in: header + x-amazon-apigateway-authtype: custom + description: Authentication is done using the x-api-key in the request header diff --git a/nlp/named-entity_recognition_jp_v1.0.yaml b/nlp/named-entity_recognition_jp_v1.0.yaml new file mode 100644 index 000000000..289adcfa0 --- /dev/null +++ b/nlp/named-entity_recognition_jp_v1.0.yaml @@ -0,0 +1,329 @@ +openapi: 3.0.1 +info: + title: Named-Entity Recognition JP + description: |+ + This NLP microservice locates and classifies the named-entities classes from input unstructured Japanese text. + + The named-entity classes extracted are persons, locations, organisations and miscellaneous. + + This microservice automatically extracts structured information from unstructured text data such as chatlogs, emails, news articles, etc. + + Do ensure that your text is within **5000 characters**. + version: '1.0.0' + x-additionalinfo: |+ + Suggested Use Cases: + - Extract structured pre-defined information from text. + - Insights from online customers - extract structured information from unstructured text data such as chatlogs, emails, news articles, etc. to find and label fields within a document and then apply sentiment analysis to understand customer opinions to find actionable product and UX insights. + - Entity analysis - identify entities within documents, including receipts, invoices, and contracts; and label them by types such as date, person, contact information, organization, location, events, products, and media. + x-subscribelink: named-entity_recognition_jp +servers: + - url: 'https://apis.sentient.io' +tags: +- name: "v1.0.0" + description: "Published Date - Sep 30, 2020" +paths: + /microservices/nlp/japanesener/v1/getpredictions: + post: + tags: + - v1.0.0 + responses: + '200': + description: success response + content: + application/json: + schema: + $ref: '#/components/schemas/success' + example: + message: Successfully Processed + results: + age: + - '56' + countx_other: + - 2稿 + - 8口 + doctrine_method_other: + - 険所コホ特室りょ + n_event: + - 受1 + numex_other: + - 百経 + ordinal_number: + - 30弾 + person: + - くぼ + - 壮 + - 琢紫 + - ナユ + product_other: + - 都合ヘラアニ限 + - 議帳 + show_organization: + - 左成相態 + status: Success + '401': + description: Unauthorized + content: + application/json: + schema: + $ref: '#/components/schemas/unauthorized' + '402': + description: Payment Required + content: + application/json: + schema: + $ref: '#/components/schemas/paymentrequired' + '403': + description: Forbidden + content: + application/json: + schema: + $ref: '#/components/schemas/forbidden' + '404': + description: Not Found + content: + application/json: + schema: + $ref: '#/components/schemas/notfound' + '419': + description: Input Field Missing + content: + application/json: + schema: + $ref: '#/components/schemas/inputfieldmissing' + '413': + description: Input Limit Exceeded + content: + application/json: + schema: + $ref: '#/components/schemas/inputlimitexceeded' + '415': + description: Invalid Input + content: + application/json: + schema: + $ref: '#/components/schemas/invalidinput' + '500': + description: Internal Server Error + content: + application/json: + schema: + $ref: '#/components/schemas/servererror' + '504': + description: Gateway Timeout + content: + application/json: + schema: + $ref: '#/components/schemas/gatewaytimeout' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/input' + required: true + security: + - APIAuthorizer: [] +components: + schemas: + success: + type: object + properties: + results: + type: object + example: { "" } + description: Json Object of returned results + properties: + age: + type: array + items: + type: string + example: + - 56 + description: "age details found in the text string" + countx_other: + type: array + items: + type: string + example: + - 2稿 + - 8口 + description: "countx other details found in the text string" + doctrine_method_other: + type: array + items: + type: string + example: + - 険所コホ特室りょ + description: "doctrine method in the text string" + n_event: + type: array + items: + type: string + example: + - 受1 + description: "n_event in the text string" + numex_other: + type: array + items: + type: string + example: + - 受1 + description: "numex_other details found in the text string" + ordinal_number: + type: array + items: + type: string + example: + -30弾 + description: "ordinal_number details in the text string" + person: + type: array + items: + type: string + example: + - person + - 壮 + - 琢紫 + - ナユ + description: "person details found in the text string" + product_other: + type: array + items: + type: string + example: + - 都合ヘラアニ限 + - 議帳 + description: "product found in the text string" + show_organization: + type: array + items: + type: string + example: + - 左成相態 + description: "organization details found in the text string" + message: + type: string + example: Successfully Processed + description: Detail description on the API status + status: + type: string + example: Success + description: The status of the API call success/failure + unauthorized: + type: object + properties: + message: + type: string + example: Missing Authentication Token + status: + type: string + example: Failure + forbidden: + type: object + properties: + message: + type: string + example: Access Denied Unauthorized User + status: + type: string + example: Failure + paymentrequired: + type: object + properties: + message: + type: string + example: Insufficient Credits Kindly Top Up + status: + type: string + example: Failure + notfound: + type: object + properties: + message: + type: string + example: Invalid Request URL + status: + type: string + example: Failure + servererror: + type: object + properties: + message: + type: string + example: Internal Server Error + status: + type: string + example: Failure + gatewaytimeout: + type: object + properties: + message: + type: string + example: Request Timeout + status: + type: string + example: Failure + inputfieldmissing: + type: object + properties: + message: + type: string + example: Input Field Missing + status: + type: string + example: Failure + inputlimitexceeded: + type: object + properties: + message: + type: string + example: Input Limit Exceeded + status: + type: string + example: Failure + invalidinput: + type: object + properties: + message: + type: string + example: Invalid Input + status: + type: string + example: Failure + versions: + type: object + properties: + v1.0.0: + type: array + items: + oneOf: + - type: string + example: Published Date - Sep 30,2020 + description: Updated version release v1.0 + v0.1.0: + type: array + items: + oneOf: + - type: string + example: Published Date - May 15,2020 + description: Initial version release + input: + type: object + required: + - text + properties: + text: + x-name: text + type: string + default: true + example: 30弾ソイキ昇機マ了映だ店原いひ険所コホ特室りょくぼ都合ヘラアニ限2稿タチケア迷芸歌セ利講ルねひ詳績めかをぶ観提メエ府木ホフタ分不写ひフ妹検らし器増壮憶クわ。8口アユ琢紫ヨ理特ゆほス見百経イス図退ナユ介精しぜ議帳モテ受1中コハ載北早ぎのりや載裁風力壌ひろふ。運56済ぞ下写報スや来際おっはの学要ヘ手米真社つみよや非央で野館き肉待づぜフ次睡ルをが左成相態万えやろ。 + description: |+ + Input text. + + Supported formats: ASCII only + securitySchemes: + APIAuthorizer: + type: apiKey + name: x-api-key + in: header + x-amazon-apigateway-authtype: custom + description: Authentication is done using the x-api-key in the request header diff --git a/nlp/named-entity_recognition_thai.yaml b/nlp/named-entity_recognition_thai.yaml new file mode 100644 index 000000000..46968c45a --- /dev/null +++ b/nlp/named-entity_recognition_thai.yaml @@ -0,0 +1,237 @@ +openapi: 3.0.1 +info: + title: Named-Entity Recognition THAI + description: |+ + This NLP microservice locates and classifies the named-entities classes from input unstructured Thai text. + + The named-entity classes extracted are persons, locations, organisations and miscellaneous. + + This microservice automatically extracts structured information from unstructured text data such as chatlogs, emails, news articles, etc. + x-additionalinfo: |+ + Suggested Use Cases: + - Extract structured pre-defined information from text. + + - Insights from online customers - extract structured information from unstructured text data such as chatlogs, emails, news articles, etc. to find and label fields within a document and then apply sentiment analysis to understand customer opinions to find actionable product and UX insights. + + - Entity analysis - identify entities within documents, including receipts, invoices, and contracts; and label them by types such as date, person, contact information, organization, location, events, products, and media. + version: '0.1.0' + x-subscribelink: named-entity_recognition_thai +servers: + - url: 'https://apis.sentient.io' +tags: +- name: "v0.1.0" + description: "Published Date - Aug 28, 2020" +paths: + /microservices/nlp/thainer/v0.1/getpredictions: + post: + tags: + - v0.1.0 + responses: + '200': + description: success response + content: + application/json: + schema: + $ref: '#/components/schemas/success' + example: + location: + - อินเดีย,สหรัฐอเมริกา + person: + - ประธานาธิบดีทรัมป์ + + '401': + description: Unauthorized + content: + application/json: + schema: + $ref: '#/components/schemas/unauthorized' + '402': + description: Payment Required + content: + application/json: + schema: + $ref: '#/components/schemas/paymentrequired' + '403': + description: Forbidden + content: + application/json: + schema: + $ref: '#/components/schemas/forbidden' + '404': + description: Not Found + content: + application/json: + schema: + $ref: '#/components/schemas/notfound' + '419': + description: Input Field Missing + content: + application/json: + schema: + $ref: '#/components/schemas/inputfieldmissing' + '413': + description: Input Limit Exceeded + content: + application/json: + schema: + $ref: '#/components/schemas/inputlimitexceeded' + '415': + description: Invalid Input + content: + application/json: + schema: + $ref: '#/components/schemas/invalidinput' + '500': + description: Internal Server Error + content: + application/json: + schema: + $ref: '#/components/schemas/servererror' + '504': + description: Gateway Timeout + content: + application/json: + schema: + $ref: '#/components/schemas/gatewaytimeout' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/input' + required: true + security: + - APIAuthorizer: [] +components: + schemas: + success: + type: object + properties: + location: + x-name: location + type: array + example: [ สหรัฐอเมริ ] + description: name of location found in the text string + + person: + x-name: person + type: array + example: [ ประธานาธิบดีทร ] + description: name of person found in the text string + + unauthorized: + type: object + properties: + message: + type: string + example: Missing Authentication Token + status: + type: string + example: Failure + forbidden: + type: object + properties: + message: + type: string + example: Access Denied Unauthorized User + status: + type: string + example: Failure + paymentrequired: + type: object + properties: + message: + type: string + example: Insufficient Credits Kindly Top Up + status: + type: string + example: Failure + notfound: + type: object + properties: + message: + type: string + example: Invalid Request URL + status: + type: string + example: Failure + servererror: + type: object + properties: + message: + type: string + example: Internal Server Error + status: + type: string + example: Failure + gatewaytimeout: + type: object + properties: + message: + type: string + example: Request Timeout + status: + type: string + example: Failure + inputfieldmissing: + type: object + properties: + message: + type: string + example: Input Field Missing + status: + type: string + example: Failure + invalidinput: + type: object + properties: + message: + type: string + example: Invalid Input + status: + type: string + example: Failure + inputlimitexceeded: + type: object + properties: + message: + type: string + example: Input Limit Exceeded + status: + type: string + example: Failure + versions: + type: object + properties: + v1.0.0: + type: array + items: + oneOf: + - type: string + example: Published Date - Aug 28,2020 + description: Updated version release v1.0 + v0.1.0: + type: array + items: + oneOf: + - type: string + example: Published Date - Aug 28,2020 + description: Initial version release + input: + type: object + required: + - text + properties: + text: + x-name: text + type: string + default: true + example: ประธานาธิบดีทรัมป์เป็นประธานาธิบดีแห่งสหรัฐอเมริกา เขาเคยเป็นส่วนหนึ่งของ Apple ในอินเดีย เวลา + description: |+ + Input text + securitySchemes: + APIAuthorizer: + type: apiKey + name: x-api-key + in: header + x-amazon-apigateway-authtype: custom + description: Authentication is done using the x-api-key in the request header diff --git a/nlp/named-entity_recognition_thai_v1.0.yaml b/nlp/named-entity_recognition_thai_v1.0.yaml new file mode 100644 index 000000000..0578e3883 --- /dev/null +++ b/nlp/named-entity_recognition_thai_v1.0.yaml @@ -0,0 +1,331 @@ +openapi: 3.0.1 +info: + title: Named-Entity Recognition THAI + description: |+ + This NLP microservice locates and classifies the named-entities classes from input unstructured Thai text. + + The named-entity classes extracted are persons, locations, organisations and miscellaneous. + + This microservice automatically extracts structured information from unstructured text data such as chatlogs, emails, news articles, etc. + + Do ensure that your text is **within 5000 characters**. + version: '1.0.0' + x-additionalinfo: |+ + Suggested Use Cases: + - Extract structured pre-defined information from text. + + - Insights from online customers - extract structured information from unstructured text data such as chatlogs, emails, news articles, etc. to find and label fields within a document and then apply sentiment analysis to understand customer opinions to find actionable product and UX insights. + + - Entity analysis - identify entities within documents, including receipts, invoices, and contracts; and label them by types such as date, person, contact information, organization, location, events, products, and media. + x-subscribelink: named-entity_recognition_thai +servers: + - url: 'https://apis.sentient.io' +tags: +- name: "v1.0.0" + description: "Published Date - Sep 30, 2020" +paths: + /microservices/nlp/thainer/v1/getpredictions: + post: + tags: + - v1.0.0 + responses: + '200': + description: success response + content: + application/json: + schema: + $ref: '#/components/schemas/success' + example: + message: Successfully Processed + results: + law: + - รัฐธรรมนูญ + location: + - ประเทศไทย + - มาเลเซีย + - ทะเลอันดามัน + - กรุงเทพมหานคร + - อินโดนีเซีย + - ราชอาณาจักรไทย + - อินเดียทางทะเลอันดามันทางตะวันตกเฉียงใต้ + - ลาวทางทิศตะวันออกติดกับลาว + - เอเชียตะวันออกเฉียงใต้ + - เวียดนาม + - ประเทศพม่า + - กัมพูชาทางทิศใต้ติดกับอ่าวไทย + organization: + - รัฐสภา + status: Success + '401': + description: Unauthorized + content: + application/json: + schema: + $ref: '#/components/schemas/unauthorized' + '402': + description: Payment Required + content: + application/json: + schema: + $ref: '#/components/schemas/paymentrequired' + '403': + description: Forbidden + content: + application/json: + schema: + $ref: '#/components/schemas/forbidden' + '404': + description: Not Found + content: + application/json: + schema: + $ref: '#/components/schemas/notfound' + '419': + description: Input Field Missing + content: + application/json: + schema: + $ref: '#/components/schemas/inputfieldmissing' + '413': + description: Input Limit Exceeded + content: + application/json: + schema: + $ref: '#/components/schemas/inputlimitexceeded' + '415': + description: Invalid Input + content: + application/json: + schema: + $ref: '#/components/schemas/invalidinput' + '500': + description: Internal Server Error + content: + application/json: + schema: + $ref: '#/components/schemas/servererror' + '504': + description: Gateway Timeout + content: + application/json: + schema: + $ref: '#/components/schemas/gatewaytimeout' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/input' + required: true + security: + - APIAuthorizer: [] +components: + schemas: + success: + type: object + properties: + results: + type: object + example: { "" } + description: Json Object of returned results + properties: + law: + x-name: law + type: array + example: [พ.ร.บ.โรคระบาด พ.ศ.2499, รัฐธรรมนูญ] + description: "law details found in the text string" + location: + x-name: location + type: array + example: + - ประเทศไทย + - มาเลเซีย + - ทะเลอันดามัน + - กรุงเทพมหานคร + - อินโดนีเซีย + - ราชอาณาจักรไทย + - อินเดียทางทะเลอันดามันทางตะวันตกเฉียงใต้ + - ลาวทางทิศตะวันออกติดกับลาว + - เอเชียตะวันออกเฉียงใต้ + - เวียดนาม + - ประเทศพม่า + - กัมพูชาทางทิศใต้ติดกับอ่าวไทย + description: "location found in the text string" + organization: + x-name: organization + type: array + example: + - รัฐสภา + description: "organization found in the text string" + date: + x-name: date + type: array + example: [2/21/2004, 16 ก.พ., จันทร์] + description: "date found in the text string" + money: + x-name: money + type: array + example: [2.7 ล้านบาท, 2,000 บาท] + description: "amount of currency found in the text string" + time: + x-name: time + type: array + example: [16.30 น., 5 วัน, 1-3 ปี] + description: "time found in the text string" + email: + x-name: email + type: array + example: [info@nrpsc.ac.th] + description: "email id found in the text string" + len: + x-name: len + type: array + example: [30 กิโลเมตร, 5 กม.] + description: "distance in km found in the text string" + person: + x-name: person + type: array + example: [น.พ.จรัล, นางประนอม ทองจันทร์] + description: "name of person found in the text string" + phone: + x-name: phone + type: array + example: [0 2670 8888] + description: "date found in the text string" + url: + x-name: url + type: array + example: [http://www.bangkokhealth.com/] + description: "url in the text string" + zip: + x-name: zip + type: array + example: [10400] + description: "zipcode found in the text string" + + message: + type: string + example: Successfully Processed + description: Detail description on the API status + status: + type: string + example: Success + description: The status of the API call success/failure + unauthorized: + type: object + properties: + message: + type: string + example: Missing Authentication Token + status: + type: string + example: Failure + forbidden: + type: object + properties: + message: + type: string + example: Access Denied Unauthorized User + status: + type: string + example: Failure + paymentrequired: + type: object + properties: + message: + type: string + example: Insufficient Credits Kindly Top Up + status: + type: string + example: Failure + notfound: + type: object + properties: + message: + type: string + example: Invalid Request URL + status: + type: string + example: Failure + invalidinput: + type: object + properties: + message: + type: string + example: Invalid Input + status: + type: string + example: Failure + servererror: + type: object + properties: + message: + type: string + example: Internal Server Error + status: + type: string + example: Failure + gatewaytimeout: + type: object + properties: + message: + type: string + example: Request Timeout + status: + type: string + example: Failure + inputfieldmissing: + type: object + properties: + message: + type: string + example: Input Field Missing + status: + type: string + example: Failure + inputlimitexceeded: + type: object + properties: + message: + type: string + example: Input Limit Exceeded + status: + type: string + example: Failure + versions: + type: object + properties: + v1.0.0: + type: array + items: + oneOf: + - type: string + example: Published Date - Sep 30,2020 + description: Updated version release v1.0 + v0.1.0: + type: array + items: + oneOf: + - type: string + example: Published Date - Aug 28,2020 + description: Initial version release + input: + type: object + required: + - text + properties: + text: + x-name: text + type: string + default: true + example: ประเทศไทย [a] ราชอาณาจักรไทยอย่างเป็นทางการและมีชื่อเดิมว่าสยาม [b] เป็นประเทศในเอเชียตะวันออกเฉียงใต้ ตั้งอยู่ที่ใจกลางคาบสมุทรอินโดจีนประกอบด้วย 76 จังหวัดและครอบคลุมพื้นที่ 513,120 ตารางกิโลเมตร (198,120 ตารางไมล์) และมีประชากรมากกว่า 66 ล้านคน [4] ประเทศไทยเป็นประเทศที่มีพื้นที่ทางบกมากเป็นอันดับที่ 50ของโลกและเป็นประเทศที่มีประชากรมากที่สุดเป็นอันดับที่ 22 ของโลก เมืองหลวงและเมืองที่ใหญ่ที่สุดคือกรุงเทพมหานครซึ่งเป็นเขตปกครองพิเศษ ประเทศไทยมีพรมแดนติดทางทิศเหนือติดกับเมียนมาร์และลาวทางทิศตะวันออกติดกับลาวและกัมพูชาทางทิศใต้ติดกับอ่าวไทยและมาเลเซียและทางทิศตะวันตกติดกับทะเลอันดามันและทางตอนใต้ของประเทศพม่า พรมแดนทางทะเล ได้แก่ เวียดนามในอ่าวไทยทางตะวันออกเฉียงใต้และอินโดนีเซียและอินเดียทางทะเลอันดามันทางตะวันตกเฉียงใต้ ประเทศไทยเป็นระบอบรัฐธรรมนูญและประชาธิปไตยแบบรัฐสภา อย่างไรก็ตามในประวัติศาสตร์ที่ผ่านมารัฐบาลของตนต้องเผชิญกับการรัฐประหารหลายครั้งและช่วงเวลาแห่งการปกครองแบบเผด็จการทหารย เวลา + description: |+ + Input text. + + Supported formats: ASCII only + securitySchemes: + APIAuthorizer: + type: apiKey + name: x-api-key + in: header + x-amazon-apigateway-authtype: custom + description: Authentication is done using the x-api-key in the request header diff --git a/nlp/page_profiler_eng.yaml b/nlp/page_profiler_eng.yaml new file mode 100644 index 000000000..780eb4217 --- /dev/null +++ b/nlp/page_profiler_eng.yaml @@ -0,0 +1,255 @@ + openapi: 3.0.1 + info: + title: Page Profiler ENG + description: |+ + This NLP microservice retrieves web content in English from the input URL. + + From the web content, the microservice then applies natural language processing to extracts named-entities and returns the output. + + The named-entity classes extracted are persons, locations, organisations and miscellaneous.

This microservice automatically extracts structured information from unstructured text data such as chatlogs, emails, news articles, etc. + + Do ensure that your URL text is in the **ASCII format**. + x-additionalinfo: |+ + Suggested Use Cases: + - Gain insights from online customers - extract structured information from unstructured text data such as chatlogs, emails, news articles, etc. to find and label fields within a document and then apply sentiment analysis to understand customer opinions to find actionable product and UX insights. + + - Entity analysis - identify entities within documents, including receipts, invoices, and contracts; and label them by types such as date, person, contact information, organization, location, events, products, and media. + version: '1.0.0' + x-subscribelink: page_profiler_eng + x-depreciated: "Oct 15, 2020" + servers: + - url: 'https://apis.sentient.io' + tags: + - name: "v1.0.0" + description: "Published Date - May 15, 2020" + paths: + /microservices/nlp/pageprofiler/v1.0/getpredictions: + post: + tags: + - v1.0.0 + responses: + '200': + description: success response + content: + application/json: + schema: + $ref: '#/components/schemas/success' + example: {"LOC": ["Beijing","Atlanta","Indonesia"], "MISC": [Twiight,Singaporean],"ORG": [CNA,Singapore Parliament],"PER": [Skip Navigation,Bookmarks]} + '401': + description: Unauthorized + content: + application/json: + schema: + $ref: '#/components/schemas/unauthorized' + '402': + description: Payment Required + content: + application/json: + schema: + $ref: '#/components/schemas/paymentrequired' + '403': + description: Forbidden + content: + application/json: + schema: + $ref: '#/components/schemas/forbidden' + '404': + description: Not Found + content: + application/json: + schema: + $ref: '#/components/schemas/notfound' + '419': + description: Not Found + content: + application/json: + schema: + $ref: '#/components/schemas/inputfieldmissing' + '420': + description: Not Found + content: + application/json: + schema: + $ref: '#/components/schemas/inputlimitexceeded' + '422': + description: Invalid Input + content: + application/json: + schema: + $ref: '#/components/schemas/invalidinput' + '500': + description: Internal Server Error + content: + application/json: + schema: + $ref: '#/components/schemas/servererror' + '504': + description: Gateway Timeout + content: + application/json: + schema: + $ref: '#/components/schemas/gatewaytimeout' + security: + - APIAuthorizer: [] + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/input' + required: true + components: + schemas: + success: + type: object + properties: + LOC: + type: array + example: ["Beijing","Atlanta","Indonesia"] + description: "name of location found in the text string" + MISC: + type: array + example: [Twiight,Singaporean] + description: "name of miscellaneous names found in the text string" + ORG: + type: array + example: [CNA,Singapore Parliament] + description: "name of organizations found in the text string" + PER: + type: array + example: [Skip Navigation,Bookmarks] + description: "name of persons found in the text string" + + unauthorized: + type: object + properties: + message: + type: string + example: Missing Authentication Token + status: + type: string + example: Failure + forbidden: + type: object + properties: + message: + type: string + example: Access Denied Unauthorized User + status: + type: string + example: Failure + paymentrequired: + type: object + properties: + message: + type: string + example: Insufficient Credits Kindly Top Up + status: + type: string + example: Failure + notfound: + type: object + properties: + message: + type: string + example: Invalid Request URL + status: + type: string + example: Failure + servererror: + type: object + properties: + message: + type: string + example: Internal Server Error + status: + type: string + example: Failure + invalidinput: + type: object + properties: + message: + type: string + example: Invalid Input + status: + type: string + example: Failure + gatewaytimeout: + type: object + properties: + message: + type: string + example: Request Timeout + status: + type: string + example: Failure + inputfieldmissing: + type: object + properties: + message: + type: string + example: Input Field Missing + status: + type: string + example: Failure + inputlimitexceeded: + type: object + properties: + message: + type: string + example: Input Limit Exceeded + status: + type: string + example: Failure + versions: + type: object + properties: + v2.1.0: + type: array + items: + oneOf: + - type: string + example: Published Date - Oct 30, 2020 + description: Partial URL support + v2.0.0: + type: array + items: + oneOf: + - type: string + example: Published Date - Sep 30, 2020 + description: Standardizing Output JSON + v1.0.0: + type: array + items: + oneOf: + - type: string + example: Published Date - May 15, 2018 + description: Swaping the NLP with Named-Entity Recognition ENG + v0.1.0: + type: array + items: + oneOf: + - type: string + example: Published Date - Apr 16, 2018 + description: Initial version release + input: + type: object + required: + - url + properties: + url: + x-name: url + type: string + default: true + example: https://www.sentient.io/en/ + description: |+ + The URL of the page to be profiled. + + Note that the URL has to be spelt in full, including "https://www." + + securitySchemes: + APIAuthorizer: + type: apiKey + name: x-api-key + in: header + x-amazon-apigateway-authtype: custom + description: Authentication is done using the x-api-key in the request header diff --git a/nlp/page_profiler_eng_v2.0.yaml b/nlp/page_profiler_eng_v2.0.yaml new file mode 100644 index 000000000..d36399d65 --- /dev/null +++ b/nlp/page_profiler_eng_v2.0.yaml @@ -0,0 +1,228 @@ + openapi: 3.0.1 + info: + title: Page Profiler ENG + description: |+ + This NLP microservice retrieves web content in English from the input URL. + + From the web content, the microservice then applies natural language processing to extracts named-entities and returns the output. + + The named-entity classes extracted are persons, locations, organisations and miscellaneous.

This microservice automatically extracts structured information from unstructured text data such as chatlogs, emails, news articles, etc. + x-subscribelink: page_profiler_eng + version: '2.0' + servers: + - url: 'https://apis.sentient.io' + tags: + - name: "v2.0" + description: "Published Date - Sep 30, 2020" + paths: + /microservices/nlp/pageprofiler/v2/getpredictions: + post: + tags: + - v2.0 + responses: + '200': + description: success response + content: + application/json: + schema: + $ref: '#/components/schemas/success' + example: {"message":"SuccessfullyProcessed","results":{"loc":["Hubei","Singapore","SINGAPORE","China","Immigration"],"misc":["ICA.They"],"org":["ImmigrationandCheckpointsAuthority","ICA","LOA"]},"status":"Success"} + '401': + description: Unauthorized + content: + application/json: + schema: + $ref: '#/components/schemas/unauthorized' + '402': + description: Payment Required + content: + application/json: + schema: + $ref: '#/components/schemas/paymentrequired' + '403': + description: Forbidden + content: + application/json: + schema: + $ref: '#/components/schemas/forbidden' + '404': + description: Not Found + content: + application/json: + schema: + $ref: '#/components/schemas/notfound' + '419': + description: Not Found + content: + application/json: + schema: + $ref: '#/components/schemas/inputfieldmissing' + '420': + description: Not Found + content: + application/json: + schema: + $ref: '#/components/schemas/inputlimitexceeded' + '500': + description: Internal Server Error + content: + application/json: + schema: + $ref: '#/components/schemas/servererror' + '504': + description: Gateway Timeout + content: + application/json: + schema: + $ref: '#/components/schemas/gatewaytimeout' + security: + - APIAuthorizer: [] + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/input' + required: true + components: + schemas: + success: + type: object + properties: + results: + type: object + example: { "" } + description: Json Object of returned results + properties: + loc: + type: array + example: ["Nat","Sentient.io","Home","Inte","CONTACT","Join"] + description: "name of location found in the text string" + misc: + type: array + example: ["Sentient.io","English"] + description: "name of misc found in the text string" + org: + type: array + example: ["Our Clients","AI","APIs","Sentient.io","Our Technology Partners","Named Entity Recognition","Our Investors"] + description: "name of org found in the text string" + per: + type: array + example: ["Sentient.io","Speech","LinkedIn"] + description: "name of persons found in the text string" + message: + type: string + example: Successfully Processed + description: Detail description on the API status + status: + type: string + example: Success + description: The status of the API call success/failure + unauthorized: + type: object + properties: + message: + type: string + example: Missing Authentication Token + status: + type: string + example: Failure + forbidden: + type: object + properties: + message: + type: string + example: Access Denied Unauthorized User + status: + type: string + example: Failure + paymentrequired: + type: object + properties: + message: + type: string + example: Insufficient Credits Kindly Top Up + status: + type: string + example: Failure + notfound: + type: object + properties: + message: + type: string + example: Invalid Request URL + status: + type: string + example: Failure + servererror: + type: object + properties: + message: + type: string + example: Internal Server Error + status: + type: string + example: Failure + gatewaytimeout: + type: object + properties: + message: + type: string + example: Request Timeout + status: + type: string + example: Failure + inputfieldmissing: + type: object + properties: + message: + type: string + example: Input Field Missing + status: + type: string + example: Failure + inputlimitexceeded: + type: object + properties: + message: + type: string + example: Input Limit Exceeded + status: + type: string + example: Failure + versions: + type: object + properties: + v2.0: + type: array + items: + oneOf: + - type: string + example: Published Date - Sep 30, 2020 + description: Updated version release + v1.0: + type: array + items: + oneOf: + - type: string + example: Published Date - Apr 11, 2018 + description: Initial version release + input: + type: object + required: + - url + properties: + url: + x-name: url + type: string + default: true + example: https://www.sentient.io/en/ + description: |+ + The URL of the page to be profile. Kindly note that the URL has to be spelt in full, including "https://www." + + securitySchemes: + APIAuthorizer: + type: apiKey + name: x-api-key + in: header + x-amazon-apigateway-authtype: custom + description: Authentication is done using the x-api-key in the request header diff --git a/nlp/page_profiler_eng_v2.1.yaml b/nlp/page_profiler_eng_v2.1.yaml new file mode 100644 index 000000000..5d3d6f532 --- /dev/null +++ b/nlp/page_profiler_eng_v2.1.yaml @@ -0,0 +1,269 @@ + openapi: 3.0.1 + info: + title: Page Profiler ENG + description: |+ + This NLP microservice retrieves web content in English from the input URL. + + From the web content, the microservice then applies natural language processing to extracts named-entities and returns the output. + + The named-entity classes extracted are persons, locations, organisations and miscellaneous.

This microservice automatically extracts structured information from unstructured text data such as chatlogs, emails, news articles, etc. + x-subscribelink: page_profiler_eng + x-additionalinfo: |+ + Suggested Use Cases: + - Gain insights from online customers - extract structured information from unstructured text data such as chatlogs, emails, news articles, etc. to find and label fields within a document and then apply sentiment analysis to understand customer opinions to find actionable product and UX insights. + - Entity analysis - identify entities within documents, including receipts, invoices, and contracts; and label them by types such as date, person, contact information, organization, location, events, products, and media. + version: '2.1.1' + servers: + - url: 'https://apis.sentient.io' + tags: + - name: "v2.1.1" + description: "Published Date - Dec 04, 2020" + paths: + /microservices/nlp/pageprofiler/v2/getpredictions: + post: + tags: + - v2.1.1 + responses: + '200': + description: success response + content: + application/json: + schema: + $ref: '#/components/schemas/success' + example: {"message":"SuccessfullyProcessed","results":{"loc":["Hubei","Singapore","SINGAPORE","China","Immigration"],"misc":["ICA.They"],"org":["ImmigrationandCheckpointsAuthority","ICA","LOA"]},"status":"Success"} + '401': + description: Unauthorized + content: + application/json: + schema: + $ref: '#/components/schemas/unauthorized' + '402': + description: Payment Required + content: + application/json: + schema: + $ref: '#/components/schemas/paymentrequired' + '403': + description: Forbidden + content: + application/json: + schema: + $ref: '#/components/schemas/forbidden' + '404': + description: Not Found + content: + application/json: + schema: + $ref: '#/components/schemas/notfound' + '419': + description: Not Found + content: + application/json: + schema: + $ref: '#/components/schemas/inputfieldmissing' + '413': + description: Not Found + content: + application/json: + schema: + $ref: '#/components/schemas/inputlimitexceeded' + '415': + description: Invalid Input + content: + application/json: + schema: + $ref: '#/components/schemas/invalidinput' + '500': + description: Internal Server Error + content: + application/json: + schema: + $ref: '#/components/schemas/servererror' + '504': + description: Gateway Timeout + content: + application/json: + schema: + $ref: '#/components/schemas/gatewaytimeout' + security: + - APIAuthorizer: [] + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/input' + required: true + components: + schemas: + success: + type: object + properties: + results: + type: object + example: { "" } + description: Json Object of returned results + properties: + loc: + type: array + example: ["Nat","Sentient.io","Home","Inte","CONTACT","Join"] + description: "name of location found in the text string" + misc: + type: array + example: ["Sentient.io","English"] + description: "name of misc found in the text string" + org: + type: array + example: ["Our Clients","AI","APIs","Sentient.io","Our Technology Partners","Named Entity Recognition","Our Investors"] + description: "name of org found in the text string" + per: + type: array + example: ["Sentient.io","Speech","LinkedIn"] + description: "name of persons found in the text string" + message: + type: string + example: Successfully Processed + description: Detail description on the API status + status: + type: string + example: Success + description: The status of the API call success/failure + unauthorized: + type: object + properties: + message: + type: string + example: Missing Authentication Token + status: + type: string + example: Failure + forbidden: + type: object + properties: + message: + type: string + example: Access Denied Unauthorized User + status: + type: string + example: Failure + paymentrequired: + type: object + properties: + message: + type: string + example: Insufficient Credits Kindly Top Up + status: + type: string + example: Failure + notfound: + type: object + properties: + message: + type: string + example: Invalid Request URL + status: + type: string + example: Failure + servererror: + type: object + properties: + message: + type: string + example: Internal Server Error + status: + type: string + example: Failure + gatewaytimeout: + type: object + properties: + message: + type: string + example: Request Timeout + status: + type: string + example: Failure + inputfieldmissing: + type: object + properties: + message: + type: string + example: Input Field Missing + status: + type: string + example: Failure + inputlimitexceeded: + type: object + properties: + message: + type: string + example: Input Limit Exceeded + status: + type: string + example: Failure + invalidinput: + type: object + properties: + message: + type: string + example: Invalid Input + status: + type: string + example: Failure + versions: + type: object + properties: + v2.1.1: + type: array + items: + oneOf: + - type: string + example: Published Date - Dec 04, 2020 + description: Patch Update + v2.1.0: + type: array + items: + oneOf: + - type: string + example: Published Date - Oct 30, 2020 + description: Partial URL support + v2.0.0: + type: array + items: + oneOf: + - type: string + example: Published Date - Sep 30, 2020 + description: Standardizing Output JSON + v1.0.0: + type: array + items: + oneOf: + - type: string + example: Published Date - May 15, 2018 + description: Swap the NLP with Named-Entity Recognition ENG + v0.1.0: + type: array + items: + oneOf: + - type: string + example: Published Date - Apr 16, 2018 + description: Initial version release + input: + type: object + required: + - url + properties: + url: + x-name: url + type: string + default: true + example: https://www.sentient.io/en/ + description: |+ + The URL of the page to be profiled. + + Supported formats: ASCII only + securitySchemes: + APIAuthorizer: + type: apiKey + name: x-api-key + in: header + x-amazon-apigateway-authtype: custom + description: Authentication is done using the x-api-key in the request header diff --git a/nlp/page_profiler_jp.yaml b/nlp/page_profiler_jp.yaml new file mode 100644 index 000000000..853994000 --- /dev/null +++ b/nlp/page_profiler_jp.yaml @@ -0,0 +1,335 @@ + openapi: 3.0.1 + info: + title: Page Profiler JP + description: |+ + This NLP microservice retrieves web content in Japanese from the input URL. From the web content, the microservice then applies natural language processing to extracts named-entities and returns the output. + + The named-entity classes extracted are persons, locations, organisations and miscellaneous. + + This microservice automatically extracts structured information from unstructured text data such as chatlogs, emails, news articles, etc. + x-additionalinfo: |+ + Suggested Use Cases: + - Insights from online customers - extract structured information from unstructured text data such as chatlogs, emails, news articles, etc. to find and label fields within a document and then apply sentiment analysis to understand customer opinions to find actionable product and UX insights. + + - Entity analysis - identify entities within documents, including receipts, invoices, and contracts; and label them by types such as date, person, contact information, organization, location, events, products, and media. + version: '1.1.0' + x-subscribelink: page_profiler_jp + servers: + - url: 'https://apis.sentient.io' + tags: + - name: "v1.1.0" + description: "Published Date - Dec 09, 2020" + paths: + /microservices/nlp/pageprofilerjp/v1/getpredictions: + post: + tags: + - v1.1.0 + responses: + '200': + description: success response + content: + application/json: + schema: + $ref: '#/components/schemas/success' + example: + message: Successfully Processed + results: + age: + - '56' + countx_other: + - 2稿 + - 8口 + doctrine_method_other: + - 険所コホ特室りょ + n_event: + - 受1 + numex_other: + - 百経 + ordinal_number: + - 30弾 + person: + - くぼ + - 壮 + - 琢紫 + - ナユ + product_other: + - 都合ヘラアニ限 + - 議帳 + show_organization: + - 左成相態 + status: Success + '401': + description: Unauthorized + content: + application/json: + schema: + $ref: '#/components/schemas/unauthorized' + '402': + description: Payment Required + content: + application/json: + schema: + $ref: '#/components/schemas/paymentrequired' + '403': + description: Forbidden + content: + application/json: + schema: + $ref: '#/components/schemas/forbidden' + '404': + description: Not Found + content: + application/json: + schema: + $ref: '#/components/schemas/notfound' + '419': + description: Not Found + content: + application/json: + schema: + $ref: '#/components/schemas/inputfieldmissing' + '413': + description: Not Found + content: + application/json: + schema: + $ref: '#/components/schemas/inputlimitexceeded' + '415': + description: Invalid Input + content: + application/json: + schema: + $ref: '#/components/schemas/invalidinput' + '500': + description: Internal Server Error + content: + application/json: + schema: + $ref: '#/components/schemas/servererror' + '504': + description: Gateway Timeout + content: + application/json: + schema: + $ref: '#/components/schemas/gatewaytimeout' + security: + - APIAuthorizer: [] + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/input' + required: true + components: + schemas: + success: + type: object + properties: + results: + type: object + example: { "" } + description: Json Object of returned results + properties: + age: + type: array + items: + type: string + example: + - 56 + description: "age details found in the text string" + countx_other: + type: array + items: + type: string + example: + - 2稿 + - 8口 + description: "countx other details found in the text string" + doctrine_method_other: + type: array + items: + type: string + example: + - 険所コホ特室りょ + description: "doctrine method in the text string" + n_event: + type: array + items: + type: string + example: + - 受1 + description: "n_event in the text string" + numex_other: + type: array + items: + type: string + example: + - 受1 + description: "numex_other details found in the text string" + ordinal_number: + type: array + items: + type: string + example: + -30弾 + description: "ordinal_number details in the text string" + person: + type: array + items: + type: string + example: + - person + - 壮 + - 琢紫 + - ナユ + description: "person details found in the text string" + product_other: + type: array + items: + type: string + example: + - 都合ヘラアニ限 + - 議帳 + description: "product found in the text string" + show_organization: + type: array + items: + type: string + example: + - 左成相態 + description: "organization details found in the text string" + message: + type: string + example: Successfully Processed + description: Detail description on the API status + status: + type: string + example: Success + description: The status of the API call success/failure + + unauthorized: + type: object + properties: + message: + type: string + example: Missing Authentication Token + status: + type: string + example: Failure + forbidden: + type: object + properties: + message: + type: string + example: Access Denied Unauthorized User + status: + type: string + example: Failure + paymentrequired: + type: object + properties: + message: + type: string + example: Insufficient Credits Kindly Top Up + status: + type: string + example: Failure + invalidinput: + type: object + properties: + message: + type: string + example: Invalid Input + status: + type: string + example: Failure + notfound: + type: object + properties: + message: + type: string + example: Invalid Request URL + status: + type: string + example: Failure + servererror: + type: object + properties: + message: + type: string + example: Internal Server Error + status: + type: string + example: Failure + gatewaytimeout: + type: object + properties: + message: + type: string + example: Request Timeout + status: + type: string + example: Failure + inputfieldmissing: + type: object + properties: + message: + type: string + example: Input Field Missing + status: + type: string + example: Failure + inputlimitexceeded: + type: object + properties: + message: + type: string + example: Input Limit Exceeded + status: + type: string + example: Failure + versions: + type: object + properties: + v1.1.0: + type: array + items: + oneOf: + - type: string + example: Published Date - Dec 09, 2020 + description: Patch Update + v1.0.0: + type: array + items: + oneOf: + - type: string + example: Published Date - Oct 30, 2020 + description: Partial URL support + v0.1.0: + type: array + items: + oneOf: + - type: string + example: Published Date - Sep 30, 2020 + description: Initial version release + input: + type: object + required: + - url + properties: + url: + x-name: url + type: string + default: true + example: https://www.bbc.com/japanese + description: |+ + The URL of the page to be profiled. + + Supported formats: ASCII only + securitySchemes: + APIAuthorizer: + type: apiKey + name: x-api-key + in: header + x-amazon-apigateway-authtype: custom + description: Authentication is done using the x-api-key in the request header diff --git a/nlp/page_profiler_thai.yaml b/nlp/page_profiler_thai.yaml new file mode 100644 index 000000000..396977e39 --- /dev/null +++ b/nlp/page_profiler_thai.yaml @@ -0,0 +1,346 @@ + openapi: 3.0.1 + info: + title: Page Profiler THAI + description: |+ + This NLP microservice retrieves web content in Thai from the input URL. From the web content, the microservice then applies natural language processing to extracts named-entities and returns the output. + + The named-entity classes extracted are persons, locations, organisations and miscellaneous. + + This microservice automatically extracts structured information from unstructured text data such as chatlogs, emails, news articles, etc. + x-additionalinfo: |+ + Suggested Use Cases: + - Insights from online customers - extract structured information from unstructured text data such as chatlogs, emails, news articles, etc. to find and label fields within a document and then apply sentiment analysis to understand customer opinions to find actionable product and UX insights. + + - Entity analysis - identify entities within documents, including receipts, invoices, and contracts; and label them by types such as date, person, contact information, organization, location, events, products, and media. + version: '1.1.0' + x-subscribelink: page_profiler_thai + servers: + - url: 'https://apis.sentient.io' + tags: + - name: "v1.1.0" + description: "Published Date - Dec 09, 2020" + paths: + /microservices/nlp/pageprofilerthai/v1/getpredictions: + post: + tags: + - v1.1.0 + responses: + '200': + description: success response + content: + application/json: + schema: + $ref: '#/components/schemas/success' + example: + message: Successfully Processed + results: + law: + - รุ้ง" จัดกิจกรรม"ตามหานาย" หน้ากองพันทหารม้าที่ 4 กองพล 1 รอ.ทวงถามความรับผิดชอบ + 28 กันยายน 2563 + ติดต่อโฆษณาออนไลน์ Worarak + location: + - กทม. + - เมียนมา + - อินเดีย + - ไทย + money: + - 7หมื่นชิ้น + - 33 ล้าน + organization: + - ทัพเพื่อไทย + - กรมอุตุฯ + - รฟม. + - มหาดไทย + - ปธ.อำนวยการ + person: + - น้องวีจิ + - สักงูเขียว รับผิดขอโทษ + - บิ๊กตู่ + - มาดามเดียร์"ติงนโยบายยกเว้นภาษี เปิดช่องรร.ทำกำไร + - ชูศักดิ์ + - รร.สารสาสน์ + - บิ๊กบราเธอร์" + - ครูจุ๋ม' + - ครูจุ๋ม" + status: Success + + '401': + description: Unauthorized + content: + application/json: + schema: + $ref: '#/components/schemas/unauthorized' + '402': + description: Payment Required + content: + application/json: + schema: + $ref: '#/components/schemas/paymentrequired' + '403': + description: Forbidden + content: + application/json: + schema: + $ref: '#/components/schemas/forbidden' + '404': + description: Not Found + content: + application/json: + schema: + $ref: '#/components/schemas/notfound' + '419': + description: Not Found + content: + application/json: + schema: + $ref: '#/components/schemas/inputfieldmissing' + '413': + description: Not Found + content: + application/json: + schema: + $ref: '#/components/schemas/inputlimitexceeded' + '415': + description: Invalid Input + content: + application/json: + schema: + $ref: '#/components/schemas/invalidinput' + '500': + description: Internal Server Error + content: + application/json: + schema: + $ref: '#/components/schemas/servererror' + '504': + description: Gateway Timeout + content: + application/json: + schema: + $ref: '#/components/schemas/gatewaytimeout' + security: + - APIAuthorizer: [] + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/input' + required: true + components: + schemas: + success: + type: object + properties: + results: + type: object + example: { "" } + description: Json Object of returned results + properties: + law: + x-name: law + type: array + example: [พ.ร.บ.โรคระบาด พ.ศ.2499, รัฐธรรมนูญ] + description: "law details found in the text string" + location: + x-name: location + type: array + example: + - ประเทศไทย + - มาเลเซีย + - ทะเลอันดามัน + - กรุงเทพมหานคร + - อินโดนีเซีย + - ราชอาณาจักรไทย + - อินเดียทางทะเลอันดามันทางตะวันตกเฉียงใต้ + - ลาวทางทิศตะวันออกติดกับลาว + - เอเชียตะวันออกเฉียงใต้ + - เวียดนาม + - ประเทศพม่า + - กัมพูชาทางทิศใต้ติดกับอ่าวไทย + description: "location found in the text string" + organization: + x-name: organization + type: array + example: + - รัฐสภา + description: "organization found in the text string" + date: + x-name: date + type: array + example: [2/21/2004, 16 ก.พ., จันทร์] + description: "date found in the text string" + money: + x-name: money + type: array + example: [2.7 ล้านบาท, 2,000 บาท] + description: "amount of currency found in the text string" + time: + x-name: time + type: array + example: [16.30 น., 5 วัน, 1-3 ปี] + description: "time found in the text string" + email: + x-name: email + type: array + example: [info@nrpsc.ac.th] + description: "email id found in the text string" + len: + x-name: len + type: array + example: [30 กิโลเมตร, 5 กม.] + description: "distance in km found in the text string" + person: + x-name: person + type: array + example: [น.พ.จรัล, นางประนอม ทองจันทร์] + description: "name of person found in the text string" + phone: + x-name: phone + type: array + example: [0 2670 8888] + description: "date found in the text string" + url: + x-name: url + type: array + example: [http://www.bangkokhealth.com/] + description: "url in the text string" + zip: + x-name: zip + type: array + example: [10400] + description: "zipcode found in the text string" + + message: + type: string + example: Successfully Processed + description: Detail description on the API status + status: + type: string + example: Success + description: The status of the API call success/failure + unauthorized: + type: object + properties: + message: + type: string + example: Missing Authentication Token + status: + type: string + example: Failure + forbidden: + type: object + properties: + message: + type: string + example: Access Denied Unauthorized User + status: + type: string + example: Failure + paymentrequired: + type: object + properties: + message: + type: string + example: Insufficient Credits Kindly Top Up + status: + type: string + example: Failure + notfound: + type: object + properties: + message: + type: string + example: Invalid Request URL + status: + type: string + example: Failure + invalidinput: + type: object + properties: + message: + type: string + example: Invalid Input + status: + type: string + example: Failure + servererror: + type: object + properties: + message: + type: string + example: Internal Server Error + status: + type: string + example: Failure + gatewaytimeout: + type: object + properties: + message: + type: string + example: Request Timeout + status: + type: string + example: Failure + inputfieldmissing: + type: object + properties: + message: + type: string + example: Input Field Missing + status: + type: string + example: Failure + inputlimitexceeded: + type: object + properties: + message: + type: string + example: Input Limit Exceeded + status: + type: string + example: Failure + versions: + type: object + properties: + v1.1.0: + type: array + items: + oneOf: + - type: string + example: Published Date - Dec 09, 2020 + description: Patch Update + v1.0.0: + type: array + items: + oneOf: + - type: string + example: Published Date - Oct 30, 2020 + description: Partial URL support + v0.1.0: + type: array + items: + oneOf: + - type: string + example: Published Date - Sep 30, 2020 + description: Initial version release + input: + type: object + required: + - url + properties: + url: + x-name: url + type: string + default: true + example: https://www.naewna.com/entertain/527527 + description: |+ + The URL of the page to be profiled. + + Supported formats: ASCII only + securitySchemes: + APIAuthorizer: + type: apiKey + name: x-api-key + in: header + x-amazon-apigateway-authtype: custom + description: Authentication is done using the x-api-key in the request header diff --git a/nlp/script_alignment.yaml b/nlp/script_alignment.yaml new file mode 100644 index 000000000..a01255526 --- /dev/null +++ b/nlp/script_alignment.yaml @@ -0,0 +1,277 @@ +openapi: 3.0.1 +info: + title: Script Alignment + description: |+ + This NLP microservice aligns the input time-coded transcript with high-quality script. + + The output is the time-coded high-quality script. + + Do ensure that your text is within **5000 characters**. + x-additionalinfo: |+ + Suggested Use Cases: + - Can be used to create time-coded high-quality script for services like radio broadcasting, television broadcasting and digital content creation. + version: '0.1.0' + x-subscribelink: script_alignment +servers: + - url: 'https://apis.sentient.io' +tags: +- name: "v0.1.0" + description: "Published Date - Jun 05, 2020" +paths: + /microservices/nlp/scriptalignment/v0.1/getpredictions: + post: + tags: + - v0.1.0 + responses: + '200': + description: success response + content: + application/json: + schema: + $ref: '#/components/schemas/success' + example: [{"end": 4,"seqNum": 1,"start": 1,"text": "Hello World"},{"end": 8.2,"seqNum": 2,"start": 4.92,"text": "This is a test"},{"end": 12.04,"seqNum": 3,"start": 8.88,"text": "This is another test"}] + '401': + description: Unauthorized + content: + application/json: + schema: + $ref: '#/components/schemas/unauthorized' + '402': + description: Payment Required + content: + application/json: + schema: + $ref: '#/components/schemas/paymentrequired' + '403': + description: Forbidden + content: + application/json: + schema: + $ref: '#/components/schemas/forbidden' + '404': + description: Not Found + content: + application/json: + schema: + $ref: '#/components/schemas/notfound' + '419': + description: Input Field Missing + content: + application/json: + schema: + $ref: '#/components/schemas/inputfieldmissing' + '413': + description: Input Limit Exceeded + content: + application/json: + schema: + $ref: '#/components/schemas/inputlimitexceeded' + '415': + description: Invalid Input + content: + application/json: + schema: + $ref: '#/components/schemas/invalidinput' + '500': + description: Internal Server Error + content: + application/json: + schema: + $ref: '#/components/schemas/servererror' + '504': + description: Gateway Timeout + content: + application/json: + schema: + $ref: '#/components/schemas/gatewaytimeout' + security: + - APIAuthorizer: [] + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/input' + required: true +components: + schemas: + success: + type: object + properties: + results: + type: array + example: [{"end": 4,"seqNum": 1,"start": 1,"text": "Hello World"},{"end": 8.2,"seqNum": 2,"start": 4.92,"text": "This is a test"},{"end": 12.04,"seqNum": 3,"start": 8.88,"text": "This is another test"}] + description: The time-coded high-quality script + items: + oneOf: + - type: object + properties: + end: + type: string + example: 4 + description: End time of word, in seconds. Offset from the start of stream. + seqNum: + type: integer + example: 1 + description: Running sequence. Start from 1. + start: + type: string + example: 1 + description: Start time of word, in seconds. Offset from the start of stream. + text: + type: string + example: Hello World + description: Content of the utterance. + unauthorized: + type: object + properties: + message: + type: string + example: Missing Authentication Token + status: + type: string + example: Failure + forbidden: + type: object + properties: + message: + type: string + example: Access Denied Unauthorized User + status: + type: string + example: Failure + paymentrequired: + type: object + properties: + message: + type: string + example: Insufficient Credits Kindly Top Up + status: + type: string + example: Failure + notfound: + type: object + properties: + message: + type: string + example: Invalid Request URL + status: + type: string + example: Failure + invalidinput: + type: object + properties: + message: + type: string + example: Invalid Input + status: + type: string + example: Failure + servererror: + type: object + properties: + message: + type: string + example: Internal Server Error + status: + type: string + example: Failure + gatewaytimeout: + type: object + properties: + message: + type: string + example: Request Timeout + status: + type: string + example: Failure + inputfieldmissing: + type: object + properties: + message: + type: string + example: Input Field Missing + status: + type: string + example: Failure + inputlimitexceeded: + type: object + properties: + message: + type: string + example: Input Limit Exceeded + status: + type: string + example: Failure + versions: + type: object + properties: + v0.1.0: + type: array + items: + oneOf: + - type: string + example: Published Date - Jun 05, 2020 + description: Initial version release + input: + type: object + required: + - script + - transcript + properties: + script: + x-name: script + type: array + default: true + example: ["Hello World, This is a test. This is another test."] + description: |+ + An ordered array of text. Each element contains a line of the script. + + Supported formats: ASCII only + transcript: + x-name: transcript + type: array + default: true + example: [{"seqNum":1,"start":1.0,"end":4.0,"text":"HELLO WORLD"}] + description: |+ + An ordered array of utterance struct. + items: + oneOf: + - type: object + properties: + seqNum: + x-name: seqNum + type: number + default: true + example: 1 + description: |+ + Running sequence. Start from 1. + start: + x-name: start + type: number + format: float + default: true + example: 1.0 + description: |+ + Start time of utterance, in seconds. Offset from the start of stream. + end: + x-name: end + type: number + format: float + default: true + example: 4.0 + description: |+ + End time of utterance, in seconds. Offset from the end of stream. + text: + x-name: text + type: string + default: true + example: HELLO WORLD + description: |+ + Content of the utterance. + securitySchemes: + APIAuthorizer: + type: apiKey + name: x-api-key + in: header + x-amazon-apigateway-authtype: custom + description: Authentication is done using the x-api-key in the request header diff --git a/nlp/script_alignment_v1.0.yaml b/nlp/script_alignment_v1.0.yaml new file mode 100644 index 000000000..c5df6824b --- /dev/null +++ b/nlp/script_alignment_v1.0.yaml @@ -0,0 +1,302 @@ +openapi: 3.0.1 +info: + title: Script Alignment + description: |+ + This NLP microservice aligns the input time-coded transcript with high-quality script. + + The output is the time-coded high-quality script. + + Do ensure that your text is within **5000 characters**. + version: '1.0.0' + x-additionalinfo: |+ + Suggested Use Cases: + - Can be used to create time-coded high-quality script for services like radio broadcasting, television broadcasting and digital content creation. + x-subscribelink: script_alignment +servers: + - url: 'https://apis.sentient.io' +tags: +- name: "v1.0.0" + description: "Published Date - Oct 30, 2020" +paths: + /microservices/nlp/scriptalignment/v1/getpredictions: + post: + tags: + - v1.0.0 + responses: + '200': + description: success response + content: + application/json: + schema: + $ref: '#/components/schemas/success' + example: + results: + output: + [{"end": 4,"seqNum": 1,"start": 1,"text": "Hello World"},{"end": 8.2,"seqNum": 2,"start": 4.92,"text": "This is a test"},{"end": 12.04,"seqNum": 3,"start": 8.88,"text": "This is another test"}] + message: Successfully Processed + status: Success + '401': + description: Unauthorized + content: + application/json: + schema: + $ref: '#/components/schemas/unauthorized' + '402': + description: Payment Required + content: + application/json: + schema: + $ref: '#/components/schemas/paymentrequired' + '403': + description: Forbidden + content: + application/json: + schema: + $ref: '#/components/schemas/forbidden' + '404': + description: Not Found + content: + application/json: + schema: + $ref: '#/components/schemas/notfound' + '419': + description: Input Field Missing + content: + application/json: + schema: + $ref: '#/components/schemas/inputfieldmissing' + '413': + description: Input Limit Exceeded + content: + application/json: + schema: + $ref: '#/components/schemas/inputlimitexceeded' + '415': + description: Invalid Input + content: + application/json: + schema: + $ref: '#/components/schemas/invalidinput' + '500': + description: Internal Server Error + content: + application/json: + schema: + $ref: '#/components/schemas/servererror' + '504': + description: Gateway Timeout + content: + application/json: + schema: + $ref: '#/components/schemas/gatewaytimeout' + security: + - APIAuthorizer: [] + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/input' + required: true +components: + schemas: + success: + type: object + properties: + results: + type: object + description: The result of the API call. + example: { "" } + properties: + output: + type: array + example: [{"end": 4,"seqNum": 1,"start": 1,"text": "Hello World"},{"end": 8.2,"seqNum": 2,"start": 4.92,"text": "This is a test"},{"end": 12.04,"seqNum": 3,"start": 8.88,"text": "This is another test"}] + description: The time-coded high-quality script + items: + oneOf: + - type: object + properties: + end: + type: string + example: 4 + description: End time of word, in seconds. Offset from the start of stream. + seqNum: + type: integer + example: 1 + description: Running sequence. Start from 1. + start: + type: string + example: 1 + description: Start time of word, in seconds. Offset from the start of stream. + text: + type: string + example: Hello World + description: Content of the utterance. + message: + type: string + example: Successfully Processed + description: Detail description on the API status + status: + type: string + example: Success + description: The status of the API call success/failure + unauthorized: + type: object + properties: + message: + type: string + example: Missing Authentication Token + status: + type: string + example: Failure + forbidden: + type: object + properties: + message: + type: string + example: Access Denied Unauthorized User + status: + type: string + example: Failure + paymentrequired: + type: object + properties: + message: + type: string + example: Insufficient Credits Kindly Top Up + status: + type: string + example: Failure + notfound: + type: object + properties: + message: + type: string + example: Invalid Request URL + status: + type: string + example: Failure + servererror: + type: object + properties: + message: + type: string + example: Internal Server Error + status: + type: string + example: Failure + gatewaytimeout: + type: object + properties: + message: + type: string + example: Request Timeout + status: + type: string + example: Failure + invalidinput: + type: object + properties: + message: + type: string + example: Invalid Input + status: + type: string + example: Failure + inputfieldmissing: + type: object + properties: + message: + type: string + example: Input Field Missing + status: + type: string + example: Failure + inputlimitexceeded: + type: object + properties: + message: + type: string + example: Input Limit Exceeded + status: + type: string + example: Failure + versions: + type: object + properties: + v1.0.0: + type: array + items: + oneOf: + - type: string + example: Published Date - Oct 30,2020 + description: Standardizing Output JSON + v0.1.0: + type: array + items: + oneOf: + - type: string + example: Published Date - Jun 05, 2020 + description: Initial version release + input: + type: object + required: + - script + - transcript + properties: + script: + x-name: script + type: array + default: true + example: ["Hello World, This is a test. This is another test."] + description: |+ + An ordered array of text. Each element contains a line of the script. + + Supported formats: ASCII only + transcript: + x-name: transcript + type: array + default: true + example: [{"seqNum":1,"start":1.0,"end":4.0,"text":"HELLO WORLD"}] + description: |+ + An ordered array of utterance struct. + items: + oneOf: + - type: object + properties: + seqNum: + x-name: seqNum + type: number + default: true + example: 1 + description: |+ + Running sequence. Start from 1. + start: + x-name: start + type: number + format: float + default: true + example: 1.0 + description: |+ + Start time of utterance, in seconds. Offset from the start of stream. + end: + x-name: end + type: number + format: float + default: true + example: 4.0 + description: |+ + End time of utterance, in seconds. Offset from the end of stream. + text: + x-name: text + type: string + default: true + example: HELLO WORLD + description: |+ + Content of the utterance. + securitySchemes: + APIAuthorizer: + type: apiKey + name: x-api-key + in: header + x-amazon-apigateway-authtype: custom + description: Authentication is done using the x-api-key in the request header diff --git a/nlp/spacy_named-entity_recognition_eng.yaml b/nlp/spacy_named-entity_recognition_eng.yaml new file mode 100644 index 000000000..e911077c7 --- /dev/null +++ b/nlp/spacy_named-entity_recognition_eng.yaml @@ -0,0 +1,317 @@ +openapi: 3.0.1 +info: + title: spaCy NER + description: |+ + This NLP microservice locates and classifies the named-entities classes from input unstructured English text, based on the spaCy model. + + The named-entity classes extracted include persons, nationalities, religious groups, political groups, buildings and facilities, organisations, geopolitical, locations, products, events, works of art, laws, languages, dates and time, percentages, monetary values, quantities, ordinals and cardinals. + + This microservice automatically extracts structured information from unstructured text data such as chatlogs, emails, news articles, etc. + + Do ensure that your text is **within 5000 characters**. + x-additionalinfo: |+ + Suggested Use Cases: + - Can be used to build information extraction or natural language understanding systems, or to pre-process text for deep learning -e.g. tokenization, Parts-of-Speech (PoS) Tagging, Text Classification and Named Entity Recognition. + version: '0.1.0' + x-subscribelink: spacy_ner +servers: + - url: 'https://apis.sentient.io' +tags: +- name: "v0.1.0" + description: "Published Date - Sep 30, 2020" +paths: + /microservices/nlp/spacyner/v1/getpredictions: + post: + tags: + - v0.1.0 + responses: + '200': + description: success response + content: + application/json: + schema: + $ref: '#/components/schemas/success' + example: {"message": "Successfully Processed","results": {"fac": ["Changi Airport","the first Airport"],"gpe": ["Changi","Singapore"],"loc": ["Marina Bay","Asia"],"org": ["WSSS","BOC Aviation","Jetstar Asia Airways","Changi Airport Group","FAA","Skytrax","ICAO","the World's Best Airport"],"quantity": ["5.0 sq mi","approximately 20 km"]},"status": "Success"} + '401': + description: Unauthorized + content: + application/json: + schema: + $ref: '#/components/schemas/unauthorized' + '402': + description: Payment Required + content: + application/json: + schema: + $ref: '#/components/schemas/paymentrequired' + '403': + description: Forbidden + content: + application/json: + schema: + $ref: '#/components/schemas/forbidden' + '404': + description: Not Found + content: + application/json: + schema: + $ref: '#/components/schemas/notfound' + '419': + description: Input Field Missing + content: + application/json: + schema: + $ref: '#/components/schemas/inputfieldmissing' + '413': + description: Input Limit Exceeded + content: + application/json: + schema: + $ref: '#/components/schemas/inputlimitexceeded' + '415': + description: Invalid Input + content: + application/json: + schema: + $ref: '#/components/schemas/invalidinput' + '500': + description: Internal Server Error + content: + application/json: + schema: + $ref: '#/components/schemas/servererror' + '504': + description: Gateway Timeout + content: + application/json: + schema: + $ref: '#/components/schemas/gatewaytimeout' + security: + - APIAuthorizer: [] + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/input' + required: true +components: + schemas: + success: + type: object + properties: + results: + type: object + example: { "" } + description: Json Object of returned results + properties: + person: + x-name: person + type: array + example: [DONALD TRUMP,Mike Pompeo] + description: People, including fictional. + norp: + x-name: norp + type: array + example: [Chinese,Singaporean,Malay] + description: Nationalities or religious or political groups. + fac: + x-name: fac + type: array + example: [Changi Airport, the first Airport] + description: Buildings, airports, highways, bridges, etc. + org: + x-name: org + type: array + example: [WSSS,BOC Aviation] + description: Companies, agencies, institutions, etc. + gpe: + x-name: gpe + type: array + example: [Changi,Singapore] + description: Countries, cities, states. + loc: + x-name: loc + type: array + example: [Marina Bay, Asia] + description: Non-GPE locations, mountain ranges, bodies of water. + product: + x-name: product + type: array + example: [Formula 1,Motorrad] + description: Objects, vehicles, foods, etc. (Not services.) + event: + x-name: event + type: array + example: [the Second World War] + description: Named hurricanes, battles, wars, sports events, etc. + work_of_art: + x-name: work_of_art + type: array + example: [Wizardry] + description: Titles of books, songs, etc. + law: + x-name: law + type: array + example: [the Penal Code,the Internal Security Act,the Constitution of the Republic of Singapore",the Evidence Act,the Societies Act] + description: Named documents made into laws. + language: + x-name: language + type: array + example: [English] + description: Any named language. + date: + x-name: date + type: array + example: [Tuesday] + description: Absolute or relative dates or periods. + time: + x-name: time + type: array + example: [twenty-four hours] + description: Times smaller than a day. + percent: + x-name: percent + type: array + example: [91%,25%,61%] + description: Percentage, including ”%“. + money: + x-name: money + type: array + example: [up to $1000] + description: Monetary values, including unit. + quantity: + x-name: quantity + type: array + example: [about one degree,85 miles,137 kilometres] + description: Measurements, as of weight or distance. + ordinal: + x-name: ordinal + type: array + example: [ninth,seventh,second] + description: “first”, “second”, etc. + cardinal: + x-name: cardinal + type: array + example: [four] + description: Numerals that do not fall under another type. + message: + x-name: message + type: string + example: Successfully Processed + description: Detail description on the API status + + status: + x-name: status + type: string + example: Success + description: The status of the API call success/failure + invalidinput: + type: object + properties: + message: + type: string + example: Invalid Input + status: + type: string + example: Failure + unauthorized: + type: object + properties: + message: + type: string + example: Missing Authentication Token + status: + type: string + example: Failure + forbidden: + type: object + properties: + message: + type: string + example: Access Denied Unauthorized User + status: + type: string + example: Failure + paymentrequired: + type: object + properties: + message: + type: string + example: Insufficient Credits Kindly Top Up + status: + type: string + example: Failure + notfound: + type: object + properties: + message: + type: string + example: Invalid Request URL + status: + type: string + example: Failure + servererror: + type: object + properties: + message: + type: string + example: Internal Server Error + status: + type: string + example: Failure + gatewaytimeout: + type: object + properties: + message: + type: string + example: Request Timeout + status: + type: string + example: Failure + inputfieldmissing: + type: object + properties: + message: + type: string + example: Input Field Missing + status: + type: string + example: Failure + inputlimitexceeded: + type: object + properties: + message: + type: string + example: Input Limit Exceeded + status: + type: string + example: Failure + versions: + type: object + properties: + v0.1.0: + type: array + items: + oneOf: + - type: string + example: Published Date - Sep 30, 2020 + description: Initial version release + input: + type: object + required: + - text + properties: + text: + x-name: text + type: string + default: true + example: "Singapore Changi Airport, commonly known as Changi Airport (IATA: SIN, ICAO: WSSS, FAA LID: SIN), is a major civilian airport that serves Singapore, and is one of the largest transportation hubs in Asia. As one of the world's busiest airports by international passenger and cargo traffic, it is currently rated the World's Best Airport by Skytrax, the first Airport in the world to do so for eight consecutive years.[10][11] It has also been rated as the one of the world's cleanest airports and highly rated international transit airports.[12][13]The airport is located in Changi, at the eastern end of Singapore, approximately 20 km (12 mi)[14] from Marina Bay (Singapore's Downtown Core), on a 13-square-kilometre (5.0 sq mi) site. The airport is operated by Changi Airport Group and it is the home base of Singapore Airlines,[15] Singapore Airlines Cargo,[15] SilkAir,[15] Scoot, Jetstar Asia Airways and BOC Aviation." + description: |+ + Input text + securitySchemes: + APIAuthorizer: + type: apiKey + name: x-api-key + in: header + x-amazon-apigateway-authtype: custom + description: Authentication is done using the x-api-key in the request header diff --git a/nlp/taxonomy_matcher_eng.yaml b/nlp/taxonomy_matcher_eng.yaml new file mode 100644 index 000000000..8d91029eb --- /dev/null +++ b/nlp/taxonomy_matcher_eng.yaml @@ -0,0 +1,235 @@ +openapi: 3.0.1 +info: + title: Taxonomy Matcher ENG + description: |+ + This NLP microservice matches the input word with the name of a leaf nodes in the predefined English taxonomy. The entire branch from the matched leaf node to the root of the corresponding taxonomy tree is returned. + + The full taxonomy consists of major categories (for e.g. retail, cars, etc.). Each category is stored as a separate taxonomy tree within the Taxonomy instance. Each node in a taxonomy tree is identified using a node_id. It has attributes: name (a human readable string), level (how far it is from the root node) and type (whether it is a root node, leaf node or body node). + + This microservice can help identify the types of concept that are frequently mentioned in an article. + + Do ensure that your text is within **5000 characters**. + x-additionalinfo: |+ + Suggested Use Cases: + - Categorise a particular word to pre-built taxonomy tree. + + - This microservice can be used to manage taxonomies, such as a hierarchy of product categories used for an eCommerce site. The information in a taxonomy is meta-information about the categories used to classify a set of things. For an eCommerce site, the set of things are items in the product catalog. Users can use this meta-information to enhance search. + version: '0.1.0' + x-subscribelink: taxonomy_matcher_eng +servers: + - url: 'https://apis.sentient.io' +tags: +- name: "v0.1.0" + description: "Published Date - Jan 24, 2020" +paths: + /microservices/nlp/taxonomy/v0.1/getpredictions: + post: + tags: + - v0.1.0 + responses: + '200': + description: success response + content: + application/json: + schema: + $ref: '#/components/schemas/success' + example: + bus: + - + - careers/job by industry/travel/bus + - 1 + - + - news/business news/travel/bus + - 1 + + '401': + description: Unauthorized + content: + application/json: + schema: + $ref: '#/components/schemas/unauthorized' + '402': + description: Payment Required + content: + application/json: + schema: + $ref: '#/components/schemas/paymentrequired' + '403': + description: Forbidden + content: + application/json: + schema: + $ref: '#/components/schemas/forbidden' + '404': + description: Not Found + content: + application/json: + schema: + $ref: '#/components/schemas/notfound' + '419': + description: Input Field Missing + content: + application/json: + schema: + $ref: '#/components/schemas/inputfieldmissing' + '413': + description: Input Limit Exceeded + content: + application/json: + schema: + $ref: '#/components/schemas/inputlimitexceeded' + '415': + description: Invalid Input + content: + application/json: + schema: + $ref: '#/components/schemas/invalidinput' + '500': + description: Internal Server Error + content: + application/json: + schema: + $ref: '#/components/schemas/servererror' + '504': + description: Gateway Timeout + content: + application/json: + schema: + $ref: '#/components/schemas/gatewaytimeout' + security: + - APIAuthorizer: [] + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/input' + required: true +components: + schemas: + success: + type: object + properties: + : + type: array + example: [["news/sport/swimming/bike",1]] + description: List of taxonomy for the requested object name + unauthorized: + type: object + properties: + message: + type: string + example: Missing Authentication Token + status: + type: string + example: Failure + forbidden: + type: object + properties: + message: + type: string + example: Access Denied Unauthorized User + status: + type: string + example: Failure + paymentrequired: + type: object + properties: + message: + type: string + example: Insufficient Credits Kindly Top Up + status: + type: string + example: Failure + notfound: + type: object + properties: + message: + type: string + example: Invalid Request URL + status: + type: string + example: Failure + invalidinput: + type: object + properties: + message: + type: string + example: Invalid Input + status: + type: string + example: Failure + servererror: + type: object + properties: + message: + type: string + example: Internal Server Error + status: + type: string + example: Failure + gatewaytimeout: + type: object + properties: + message: + type: string + example: Request Timeout + status: + type: string + example: Failure + inputfieldmissing: + type: object + properties: + message: + type: string + example: Input Field Missing + status: + type: string + example: Failure + inputlimitexceeded: + type: object + properties: + message: + type: string + example: Input Limit Exceeded + status: + type: string + example: Failure + + versions: + type: object + properties: + v0.1.0: + type: array + items: + oneOf: + - type: string + example: Published Date - Jan 24, 2020 + description: Initial version release + input: + type: object + required: + - text + properties: + text: + x-name: text + type: array + default: true + example: ["bus","cars","bike","train","buildings","Audi R8"] + description: |+ + A list of object names to be classified. Up to a maximum of 20 search terms can be processed each time. + + Supported formats: ASCII only + threshold: + x-name: threshold + type: number + default: true + example: 1 + description: |+ + The "threshold" specifies the level of similarity that the search term must match with terms in the taxonomy tree. Values range between 0.0 and 1.0 .It is optional. The default value is 1 (which means an exact match is required). Lowering the threshold will allow matches that are similar but not identical. + securitySchemes: + APIAuthorizer: + type: apiKey + name: x-api-key + in: header + x-amazon-apigateway-authtype: custom + description: Authentication is done using the x-api-key in the request header diff --git a/nlp/taxonomy_matcher_eng_v1.0.yaml b/nlp/taxonomy_matcher_eng_v1.0.yaml new file mode 100644 index 000000000..5ed626a30 --- /dev/null +++ b/nlp/taxonomy_matcher_eng_v1.0.yaml @@ -0,0 +1,257 @@ +openapi: 3.0.1 +info: + title: Taxonomy Matcher ENG + description: |+ + This NLP microservice matches the input word with the name of a leaf nodes in the predefined English taxonomy. The entire branch from the matched leaf node to the root of the corresponding taxonomy tree is returned. + + The full taxonomy consists of major categories (for e.g. retail, cars, etc.). Each category is stored as a separate taxonomy tree within the Taxonomy instance. Each node in a taxonomy tree is identified using a node_id. It has attributes: name (a human readable string), level (how far it is from the root node) and type (whether it is a root node, leaf node or body node). + + This microservice can help identify the types of concept that are frequently mentioned in an article. + + Do ensure that your text is within **5000 characters**. + version: '1.0.0' + x-additionalinfo: |+ + Suggested Use Cases: + - Categorise a particular word to pre-built taxonomy tree. + - This microservice can be used to manage taxonomies, such as a hierarchy of product categories used for an eCommerce site. The information in a taxonomy is meta-information about the categories used to classify a set of things. For an eCommerce site, the set of things are items in the product catalog. Users can use this meta-information to enhance search. + x-subscribelink: taxonomy_matcher_eng +servers: + - url: 'https://apis.sentient.io' +tags: +- name: "v1.0.0" + description: "Published Date - Oct 30, 2020" +paths: + /microservices/nlp/taxonomy/v1/getpredictions: + post: + tags: + - v1.0.0 + responses: + '200': + description: success response + content: + application/json: + schema: + $ref: '#/components/schemas/success' + example: + results: + bus: + - + - careers/job by industry/travel/bus + - 1 + - + - news/business news/travel/bus + - 1 + message: Successfully Processed + status: Success + + '401': + description: Unauthorized + content: + application/json: + schema: + $ref: '#/components/schemas/unauthorized' + '402': + description: Payment Required + content: + application/json: + schema: + $ref: '#/components/schemas/paymentrequired' + '403': + description: Forbidden + content: + application/json: + schema: + $ref: '#/components/schemas/forbidden' + '404': + description: Not Found + content: + application/json: + schema: + $ref: '#/components/schemas/notfound' + '419': + description: Input Field Missing + content: + application/json: + schema: + $ref: '#/components/schemas/inputfieldmissing' + '413': + description: Input Limit Exceeded + content: + application/json: + schema: + $ref: '#/components/schemas/inputlimitexceeded' + '415': + description: Invalid Input + content: + application/json: + schema: + $ref: '#/components/schemas/invalidinput' + '500': + description: Internal Server Error + content: + application/json: + schema: + $ref: '#/components/schemas/servererror' + '504': + description: Gateway Timeout + content: + application/json: + schema: + $ref: '#/components/schemas/gatewaytimeout' + security: + - APIAuthorizer: [] + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/input' + required: true +components: + schemas: + success: + type: object + properties: + results: + type: object + description: The result of the API call. + example: { "" } + properties: + : + type: array + example: [["news/sport/swimming/bike",1]] + description: List of taxonomy for the requested object name + message: + type: string + example: Successfully Processed + description: Detail description on the API status + status: + type: string + example: Success + description: The status of the API call success/failure + unauthorized: + type: object + properties: + message: + type: string + example: Missing Authentication Token + status: + type: string + example: Failure + invalidinput: + type: object + properties: + message: + type: string + example: Invalid Input + status: + type: string + example: Failure + forbidden: + type: object + properties: + message: + type: string + example: Access Denied Unauthorized User + status: + type: string + example: Failure + paymentrequired: + type: object + properties: + message: + type: string + example: Insufficient Credits Kindly Top Up + status: + type: string + example: Failure + notfound: + type: object + properties: + message: + type: string + example: Invalid Request URL + status: + type: string + example: Failure + servererror: + type: object + properties: + message: + type: string + example: Internal Server Error + status: + type: string + example: Failure + gatewaytimeout: + type: object + properties: + message: + type: string + example: Request Timeout + status: + type: string + example: Failure + inputfieldmissing: + type: object + properties: + message: + type: string + example: Input Field Missing + status: + type: string + example: Failure + inputlimitexceeded: + type: object + properties: + message: + type: string + example: Input Limit Exceeded + status: + type: string + example: Failure + + versions: + type: object + properties: + v1.0.0: + type: array + items: + oneOf: + - type: string + example: Published Date - Oct 30,2020 + description: Standardizing Output JSON + v0.1.0: + type: array + items: + oneOf: + - type: string + example: Published Date - Jan 24, 2020 + description: Initial version release + input: + type: object + required: + - text + properties: + text: + x-name: text + type: array + default: true + example: ["bus","cars","bike","train","buildings","Audi R8"] + description: |+ + A list of object names to be classified. Up to a maximum of 20 search terms can be processed each time. + + Supported formats: ASCII only + threshold: + x-name: threshold + type: number + default: true + example: 1 + description: |+ + The "threshold" specifies the level of similarity that the search term must match with terms in the taxonomy tree. Values range between 0.0 and 1.0 .It is optional. The default value is 1 (which means an exact match is required). Lowering the threshold will allow matches that are similar but not identical. + securitySchemes: + APIAuthorizer: + type: apiKey + name: x-api-key + in: header + x-amazon-apigateway-authtype: custom + description: Authentication is done using the x-api-key in the request header diff --git a/nlp/word_sense_disambiguation_eng.yaml b/nlp/word_sense_disambiguation_eng.yaml new file mode 100644 index 000000000..426f47c0a --- /dev/null +++ b/nlp/word_sense_disambiguation_eng.yaml @@ -0,0 +1,304 @@ +openapi: 3.0.1 +info: + title: Word Sense Disambiguation ENG + description: |+ + This NLP microservice takes in a text and a target word and identifies the target word's hypernym. Hypernym refers to the specific meaning of the word within the context of the sentence. For example, colour is a hypernym of red. + + If the word is determined to be a noun within the sentence context, the microservice returns the potential hypernym, definition, and score. Otherwise, no result will be returned for that context. + x-additionalinfo: |+ + Suggested Use Cases: + - Information Retrieval - this microservice can be used to build a system that assists users in finding the information they required but it does not explicitly return the answers of the questions. + + - Text Mining and Information Extraction - this microservice can be used to do accurate analysis of text. For example it can help to create an intelligent gathering system to do flagging of the correct words e.g. medical intelligent system might need flagging of “red balloon” rather than “led balloon”. + version: '0.1.0' + x-subscribelink: word_sense_disambiguation_eng +servers: + - url: 'https://apis.sentient.io' +tags: +- name: "v0.1.0" + description: "Published Date - Mar 06, 2020" +paths: + /microservices/nlp/wordsensedisambiguation/v0.1/getpredictions: + post: + tags: + - v0.1.0 + responses: + '200': + description: success response + content: + application/json: + schema: + $ref: '#/components/schemas/success' + example: + sentence_index: + '4': 'But our genius for creative storytelling , combined with our inability to + detect our own ignorance , can sometimes lead to situations that are embarrassing + , unfortunate , or downright dangerous – especially in a technologically advanced + , complex democratic societythat occasionally invests mistaken popular beliefs + with immense destructive power ( See : crisis , financial ; war , Iraq ) .' + tokens: + '4': + society: + - token_index: 40 + synset_name: society.n.01 + synset_definition: an extended social group having a distinctive cultural and + economic organization + synset_score: 0.9870249032974243 + hypernyms: + - hypernym_name: social_group.n.01 + hypernym_definition: people sharing some social relation + potential_candidate_score: 1 + '401': + description: Unauthorized + content: + application/json: + schema: + $ref: '#/components/schemas/unauthorized' + '402': + description: Payment Required + content: + application/json: + schema: + $ref: '#/components/schemas/paymentrequired' + '403': + description: Forbidden + content: + application/json: + schema: + $ref: '#/components/schemas/forbidden' + '404': + description: Not Found + content: + application/json: + schema: + $ref: '#/components/schemas/notfound' + '419': + description: Input Field Missing + content: + application/json: + schema: + $ref: '#/components/schemas/inputfieldmissing' + '413': + description: Input Limit Exceeded + content: + application/json: + schema: + $ref: '#/components/schemas/inputlimitexceeded' + '415': + description: Invalid Input + content: + application/json: + schema: + $ref: '#/components/schemas/invalidinput' + '500': + description: Internal Server Error + content: + application/json: + schema: + $ref: '#/components/schemas/servererror' + '504': + description: Gateway Timeout + content: + application/json: + schema: + $ref: '#/components/schemas/gatewaytimeout' + security: + - APIAuthorizer: [] + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/input' + required: true +components: + schemas: + success: + type: object + properties: + sentence_index: + type: object + example: {"4": "But our genius for creative storytelling , combined with our inability to detect our own ignorance , can sometimes lead to situations that are embarrassing , unfortunate , or downright dangerous \u2013 especially in a technologically advanced , complex democratic society that occasionally invests mistaken popular beliefs with immense destructive power ( See : crisis , financial ; war , Iraq ) .","7": "The society of extraordinary gentlemen has a natural way of overcoming difficulties in tough times to come out stronger , saving society from itself ."} + description: Is a mapping from an index of the sentence in the presented text (say, 0, 1, 2...) to the text of the sentence itself. + properties: + 4: + type: string + example: { 4:But our genius for creative storytelling , combined with our inability to detect our own ignorance , can sometimes lead to situations that are embarrassing , unfortunate , or downright dangerous \u2013 especially in a technologically advanced , complex democratic society that occasionally invests mistaken popular beliefs with immense destructive power} + description: mapping value + tokens: + type: object + example: {"4": {"society": [{"hypernyms": [{"hypernym_definition": "people sharing some social relation","hypernym_name": "social_group.n.01","potential_candidate_score": 1.0}],"synset_definition": "an extended social group having a distinctive cultural and economic organization","synset_name": "society.n.01","synset_score": 0.9870249032974243,"token_index": 40}]}} + description: Is a mapping from the sentence_index to the target word's potential synsets and hypernms. + properties: + 4: + type: object + example: {"society": [{"hypernyms": [{"hypernym_definition": "people sharing some social relation","hypernym_name": "social_group.n.01","potential_candidate_score": 1.0}],"synset_definition": "an extended social group having a distinctive cultural and economic organization","synset_name": "society.n.01","synset_score": 0.9870249032974243,"token_index": 40}]} + description: Mapping value + properties: + : + type: array + example: [{"hypernyms": [{"hypernym_definition": "people sharing some social relation","hypernym_name": "social_group.n.01","potential_candidate_score": 1.0}],"synset_definition": "an extended social group having a distinctive cultural and economic organization","synset_name": "society.n.01","synset_score": 0.9870249032974243,"token_index": 40}] + description: Details about the target word given as input + items: + properties: + hypernyms: + type: array + example: [{"hypernym_definition": "people sharing some social relation","hypernym_name": "social_group.n.01","potential_candidate_score": 1.0}] + description: A hypernym can be thought of as a parent class. For example, "colour" is a hypernym of "red". + items: + properties: + hypernym_definition: + type: string + example: people sharing some social relation + description: Definition of the hypernym + hypernym_name: + type: string + example: social_group.n.01 + description: Describes the category in which the target word belongs to. Eg:car is a transport. car is the target word and transport is the category(hypernym) + potential_candidate_score: + type: integer + example: 1 + description: Is the confidence score from the network + synset_definition: + type: string + example: An extended social group having a distinctive cultural and economic organization + description: A synset is a collection of synonyms, identified using the WordNet synset name. It connects a word to the synset it belongs via a definition. A word can belong to more than one synset. Basically definition of the target_word + synset_name: + type: string + example: society.n.01 + description: The target word name in wordnet library + synset_score: + type: number + format : float + example: 0.9870249032974243 + description: Is the confidence score from the network + token_index: + type: number + example: 40 + description: Is the target word position in the sentence + unauthorized: + type: object + properties: + message: + type: string + example: Missing Authentication Token + status: + type: string + example: Failure + forbidden: + type: object + properties: + message: + type: string + example: Access Denied Unauthorized User + status: + type: string + example: Failure + paymentrequired: + type: object + properties: + message: + type: string + example: Insufficient Credits Kindly Top Up + status: + type: string + example: Failure + notfound: + type: object + properties: + message: + type: string + example: Invalid Request URL + status: + type: string + example: Failure + invalidinput: + type: object + properties: + message: + type: string + example: Invalid Input + status: + type: string + example: Failure + servererror: + type: object + properties: + message: + type: string + example: Internal Server Error + status: + type: string + example: Failure + gatewaytimeout: + type: object + properties: + message: + type: string + example: Request Timeout + status: + type: string + example: Failure + inputfieldmissing: + type: object + properties: + message: + type: string + example: Input Field Missing + status: + type: string + example: Failure + inputlimitexceeded: + type: object + properties: + message: + type: string + example: Input Limit Exceeded + status: + type: string + example: Failure + input: + type: object + required: + - text + properties: + text: + x-name: text + type: string + default: true + example: An estimated 180,000 people were under mandatory evacuation orders, including parts of Santa Rosa and a large swath of Sonoma County all the way to the Pacific Ocean. + description: |+ + Input text can be a complete sentence or paragraph. + + Supported formats: ASCII only + target_word: + x-name: target_word + type: string + default: true + example: County + description: |+ + A noun token that can be found in text + repeat: + x-name: repeat + type: string + default: true + example: "True" + description: |+ + Indicates whether the target_word that was first identified in the input text is to be used alone or all the target_words identified in the text are to be used. + If False, then it uses the first target_word alone in text and ignores the rest. + versions: + type: object + properties: + v0.1.0: + type: array + items: + oneOf: + - type: string + example: Published Date - Mar 06, 2020 + description: Initial version release + securitySchemes: + APIAuthorizer: + type: apiKey + name: x-api-key + in: header + x-amazon-apigateway-authtype: custom + description: Authentication is done using the x-api-key in the request header diff --git a/nlp/word_sense_disambiguation_eng_v1.0.yaml b/nlp/word_sense_disambiguation_eng_v1.0.yaml new file mode 100644 index 000000000..d712762b6 --- /dev/null +++ b/nlp/word_sense_disambiguation_eng_v1.0.yaml @@ -0,0 +1,326 @@ +openapi: 3.0.1 +info: + title: Word Sense Disambiguation ENG + description: |+ + This NLP microservice takes in a text and a target word and identifies the target word's hypernym. Hypernym refers to the specific meaning of the word within the context of the sentence. + + If the word is determined to be a noun within the sentence context, the microservice returns the potential hypernym, definition, and score. Otherwise, no result will be returned for that context. + + Do ensure that your text is **within 5000 characters**. + version: '1.0.0' + x-additionalinfo: |+ + Suggested Use Cases: + - Information Retrieval - this microservice can be used to build a system that assists users in finding the information they required but it does not explicitly return the answers of the questions. + - Text Mining and Information Extraction - this microservice can be used to do accurate analysis of text. For example it can help to create an intelligent gathering system to do flagging of the correct words e.g. medical intelligent system might need flagging of “red balloon” rather than “led balloon”. + x-subscribelink: word_sense_disambiguation_eng +servers: + - url: 'https://apis.sentient.io' +tags: +- name: "v1.0.0" + description: "Published Date - Oct 30, 2020" +paths: + /microservices/nlp/wordsensedisambiguation/v1/getpredictions: + post: + tags: + - v1.0.0 + responses: + '200': + description: success response + content: + application/json: + schema: + $ref: '#/components/schemas/success' + example: + results: + sentence_index: + '4': 'But our genius for creative storytelling , combined with our inability to + detect our own ignorance , can sometimes lead to situations that are embarrassing + , unfortunate , or downright dangerous – especially in a technologically advanced + , complex democratic societythat occasionally invests mistaken popular beliefs + with immense destructive power ( See : crisis , financial ; war , Iraq ) .' + tokens: + '4': + society: + - token_index: 40 + synset_name: society.n.01 + synset_definition: an extended social group having a distinctive cultural and + economic organization + synset_score: 0.9870249032974243 + hypernyms: + - hypernym_name: social_group.n.01 + hypernym_definition: people sharing some social relation + potential_candidate_score: 1 + message: Successfully Processed + status: Success + '401': + description: Unauthorized + content: + application/json: + schema: + $ref: '#/components/schemas/unauthorized' + '402': + description: Payment Required + content: + application/json: + schema: + $ref: '#/components/schemas/paymentrequired' + '403': + description: Forbidden + content: + application/json: + schema: + $ref: '#/components/schemas/forbidden' + '404': + description: Not Found + content: + application/json: + schema: + $ref: '#/components/schemas/notfound' + '419': + description: Input Field Missing + content: + application/json: + schema: + $ref: '#/components/schemas/inputfieldmissing' + '413': + description: Input Limit Exceeded + content: + application/json: + schema: + $ref: '#/components/schemas/inputlimitexceeded' + '415': + description: Invalid Input + content: + application/json: + schema: + $ref: '#/components/schemas/invalidinput' + '500': + description: Internal Server Error + content: + application/json: + schema: + $ref: '#/components/schemas/servererror' + '504': + description: Gateway Timeout + content: + application/json: + schema: + $ref: '#/components/schemas/gatewaytimeout' + security: + - APIAuthorizer: [] + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/input' + required: true +components: + schemas: + success: + type: object + properties: + results: + type: object + description: The result of the API call. + example: { "" } + properties: + sentence_index: + type: object + example: {"4": "But our genius for creative storytelling , combined with our inability to detect our own ignorance , can sometimes lead to situations that are embarrassing , unfortunate , or downright dangerous \u2013 especially in a technologically advanced , complex democratic society that occasionally invests mistaken popular beliefs with immense destructive power ( See : crisis , financial ; war , Iraq ) .","7": "The society of extraordinary gentlemen has a natural way of overcoming difficulties in tough times to come out stronger , saving society from itself ."} + description: Is a mapping from an index of the sentence in the presented text (say, 0, 1, 2...) to the text of the sentence itself. + properties: + 4: + type: string + example: { 4:But our genius for creative storytelling , combined with our inability to detect our own ignorance , can sometimes lead to situations that are embarrassing , unfortunate , or downright dangerous \u2013 especially in a technologically advanced , complex democratic society that occasionally invests mistaken popular beliefs with immense destructive power} + description: mapping value + tokens: + type: object + example: {"4": {"society": [{"hypernyms": [{"hypernym_definition": "people sharing some social relation","hypernym_name": "social_group.n.01","potential_candidate_score": 1.0}],"synset_definition": "an extended social group having a distinctive cultural and economic organization","synset_name": "society.n.01","synset_score": 0.9870249032974243,"token_index": 40}]}} + description: Is a mapping from the sentence_index to the target word's potential synsets and hypernms. + properties: + 4: + type: object + example: {"society": [{"hypernyms": [{"hypernym_definition": "people sharing some social relation","hypernym_name": "social_group.n.01","potential_candidate_score": 1.0}],"synset_definition": "an extended social group having a distinctive cultural and economic organization","synset_name": "society.n.01","synset_score": 0.9870249032974243,"token_index": 40}]} + description: Mapping value + properties: + : + type: array + example: [{"hypernyms": [{"hypernym_definition": "people sharing some social relation","hypernym_name": "social_group.n.01","potential_candidate_score": 1.0}],"synset_definition": "an extended social group having a distinctive cultural and economic organization","synset_name": "society.n.01","synset_score": 0.9870249032974243,"token_index": 40}] + description: Details about the target word given as input + items: + properties: + hypernyms: + type: array + example: [{"hypernym_definition": "people sharing some social relation","hypernym_name": "social_group.n.01","potential_candidate_score": 1.0}] + description: A hypernym can be thought of as a parent class. For example, "colour" is a hypernym of "red". + items: + properties: + hypernym_definition: + type: string + example: people sharing some social relation + description: Definition of the hypernym + hypernym_name: + type: string + example: social_group.n.01 + description: Describes the category in which the target word belongs to. Eg:car is a transport. car is the target word and transport is the category(hypernym) + potential_candidate_score: + type: integer + example: 1 + description: Is the confidence score from the network + synset_definition: + type: string + example: An extended social group having a distinctive cultural and economic organization + description: A synset is a collection of synonyms, identified using the WordNet synset name. It connects a word to the synset it belongs via a definition. A word can belong to more than one synset. Basically definition of the target_word + synset_name: + type: string + example: society.n.01 + description: The target word name in wordnet library + synset_score: + type: number + format : float + example: 0.9870249032974243 + description: Is the confidence score from the network + token_index: + type: number + example: 40 + description: Is the target word position in the sentence + message: + type: string + example: Successfully Processed + description: Detail description on the API status + status: + type: string + example: Success + description: The status of the API call success/failure + unauthorized: + type: object + properties: + message: + type: string + example: Missing Authentication Token + status: + type: string + example: Failure + forbidden: + type: object + properties: + message: + type: string + example: Access Denied Unauthorized User + status: + type: string + example: Failure + invalidinput: + type: object + properties: + message: + type: string + example: Invalid Input + status: + type: string + example: Failure + paymentrequired: + type: object + properties: + message: + type: string + example: Insufficient Credits Kindly Top Up + status: + type: string + example: Failure + notfound: + type: object + properties: + message: + type: string + example: Invalid Request URL + status: + type: string + example: Failure + servererror: + type: object + properties: + message: + type: string + example: Internal Server Error + status: + type: string + example: Failure + gatewaytimeout: + type: object + properties: + message: + type: string + example: Request Timeout + status: + type: string + example: Failure + inputfieldmissing: + type: object + properties: + message: + type: string + example: Input Field Missing + status: + type: string + example: Failure + inputlimitexceeded: + type: object + properties: + message: + type: string + example: Input Limit Exceeded + status: + type: string + example: Failure + input: + type: object + required: + - text + properties: + text: + x-name: text + type: string + default: true + example: An estimated 180,000 people were under mandatory evacuation orders, including parts of Santa Rosa and a large swath of Sonoma County all the way to the Pacific Ocean. + description: |+ + Input text. A complete sentence or paragraph + target_word: + x-name: target_word + type: string + default: true + example: County + description: |+ + A noun token that can be found in text + repeat: + x-name: repeat + type: string + default: true + example: "True" + description: |+ + Indicates whether the target_word that was first identified in the input text is to be used alone or all the target_words identified in the text are to be used. + If False, then it uses the first target_word alone in text and ignores the rest. + versions: + type: object + properties: + v1.0.0: + type: array + items: + oneOf: + - type: string + example: Published Date - Oct 30,2020 + description: Standardizing Output JSON + v0.1.0: + type: array + items: + oneOf: + - type: string + example: Published Date - Mar 06, 2020 + description: Initial version release + securitySchemes: + APIAuthorizer: + type: apiKey + name: x-api-key + in: header + x-amazon-apigateway-authtype: custom + description: Authentication is done using the x-api-key in the request header diff --git a/utility/audio_format_convertor.yaml b/utility/audio_format_convertor.yaml new file mode 100644 index 000000000..5fb6e071e --- /dev/null +++ b/utility/audio_format_convertor.yaml @@ -0,0 +1,253 @@ +openapi: 3.0.1 +info: + title: Audio Format Convertor + description: >- + This API is used to convert your audio like music(any format) to the WAV format. + + The size of your audio file should **not exceed 10 MB**. + x-additionalinfo: |+ + Suggested Use Cases: + - Build services related to sound engineering or audio editing as WAV is the format of choice for video and audio editors. WAV files are lossless compared to the lossy MP3 file format, meaning that WAV audio is a high-quality uncompressed file that is excellent for studio recordings and audio mastering. + version: '0.1.0' + x-subscribelink: audio_format_convertor +servers: + - url: 'https://apis.sentient.io' +tags: +- name: "v0.1.0" + description: "Published Date - Mar 24, 2020" +paths: + /microservices/utility/audioprocessing/v0.1/getresults: + post: + tags: + - v0.1.0 + responses: + '200': + description: success response + content: + application/json: + schema: + $ref: '#/components/schemas/success' + example: + results: + AudioContent: actual base64 string of input wav + message: Successfully Processed + status: Success + '401': + description: Unauthorized + content: + application/json: + schema: + $ref: '#/components/schemas/unauthorized' + '402': + description: Payment Required + content: + application/json: + schema: + $ref: '#/components/schemas/paymentrequired' + '403': + description: Forbidden + content: + application/json: + schema: + $ref: '#/components/schemas/forbidden' + '404': + description: Not Found + content: + application/json: + schema: + $ref: '#/components/schemas/notfound' + '419': + description: Input Field Missing + content: + application/json: + schema: + $ref: '#/components/schemas/inputfieldmissing' + '413': + description: Input Limit Exceeded + content: + application/json: + schema: + $ref: '#/components/schemas/inputlimitexceeded' + '415': + description: Invalid Input + content: + application/json: + schema: + $ref: '#/components/schemas/invalidinput' + '500': + description: Internal Server error + content: + application/json: + schema: + $ref: '#/components/schemas/servererror' + '504': + description: Gateway Timeout + content: + application/json: + schema: + $ref: '#/components/schemas/gatewaytimeout' + security: + - APIAuthorizer: [] + requestBody: + content: + multipart/form-data: + schema: + $ref: '#/components/schemas/input' + required: true +components: + schemas: + success: + type: object + properties: + results: + type: string + example: + AudioContent: UklGRgaAoQBXQVZFZm10IBAAAAABAAIARKwAABCxAgAEABAATElTVBoAAABJTkZPSVNGVA4AAABMYXZmNTguMjkuMTAwAGRhdGHAf6EAAAAAAAAAAAAAAAAAAAAAAAAAAAAA................. + description: Audio wav file convert to base64 encode string + message: + type: string + example: Successfully Processed + description: Detail description on the API status + status: + type: string + example: Success + description: The status of the API call success/failure + unauthorized: + type: object + properties: + message: + type: string + example: Missing Authentication Token + status: + type: string + example: Failure + forbidden: + type: object + properties: + message: + type: string + example: Access Denied Unauthorized User + status: + type: string + example: Failure + paymentrequired: + type: object + properties: + message: + type: string + example: Insufficient Credits Kindly Top Up + status: + type: string + example: Failure + notfound: + type: object + properties: + message: + type: string + example: Invalid Request URL + status: + type: string + example: Failure + servererror: + type: object + properties: + message: + type: string + example: Internal Server Error + status: + type: string + example: Failure + gatewaytimeout: + type: object + properties: + message: + type: string + example: Request Timeout + status: + type: string + example: Failure + inputfieldmissing: + type: object + properties: + message: + type: string + example: Input Field Missing + status: + type: string + example: Failure + inputlimitexceeded: + type: object + properties: + message: + type: string + example: Input Limit Exceeded + status: + type: string + example: Failure + invalidinput: + type: object + properties: + message: + type: string + example: Invalid Input + status: + type: string + example: Failure + versions: + type: object + properties: + v0.1.0: + type: array + items: + oneOf: + - type: string + example: Published Date - Mar 24, 2020 + description: Initial version release + input: + type: object + required: + - filePath + properties: + filePath: + type: string + format: binary + default: true + example: sample.wav + description: Maximum file size up to 10 MB. + samplerate: + type: string + default: false + example: '16000' + description: Sample rate of the audio file in Hz + channel: + type: string + default: false + example: '1' + description: Indicates the type of audio channel. Value must be 1 for mono or 2 for Stereo. Default is 2(Stereo) + bitrate: + type: string + default: false + example: '4' + description: Indicates the bit resolution. Value must be 1(8bit) or 2 (16 bit) or 4(32bit) + normalize: + type: string + default: false + example: yes or no + description: A boolean value that indicates whether to normalize the audio or not. Values must be either “yes” or “no” + trim_start_time: + type: string + default: false + example: '1' + description: Indicates the start in seconds between which the audio is extracted + trim_stop_time: + type: string + default: false + example: '5' + description: Indicates the end time in seconds between which the audio is extracted + securitySchemes: + APIAuthorizer: + type: apiKey + name: x-api-key + in: header + x-amazon-apigateway-authtype: custom + description: Authentication is done using the x-api-key in the request header diff --git a/utility/base64-decoder.yaml b/utility/base64-decoder.yaml new file mode 100644 index 000000000..88700c389 --- /dev/null +++ b/utility/base64-decoder.yaml @@ -0,0 +1,220 @@ +openapi: 3.0.1 +info: + title: Base64 Decoder + description: |+ + This Utility microservice converts a Base64 encoded text string to a binary file.

For the reverse process (convert binary file to Base64 encoded text string), check out the Base64 File Encode microservice. + x-additionalinfo: |+ + Suggested Use Cases: + - As a post-processor for microservices that only outputs Base64 encoded text + version: '0.0.1' + x-subscribelink: base64_decoder +servers: + - url: 'https://apis.sentient.io' +tags: +- name: "v0.0.1" + description: "Published Date - Oct 30, 2020" +paths: + /microservices/utility/base64decode/v0/getresults: + post: + tags: + - "0.0.1" + responses: + '200': + description: success response + content: + application/json: + schema: + $ref: '#/components/schemas/success' + example: + url: https://storage.googleapis.com/base64decode_dev/24f03729131e469181a2fc22eb3a627a.zip?X-Goog-Algorithm=GOOG4-RSA-SHA256&X-Goog-Credential=sentient-dev-bigquery%40sentient-207310.iam.gserviceaccount.com%2F20201015%2Fa... + message: Successfully Processed + status: Success + '401': + description: Unauthorized + content: + application/json: + schema: + $ref: '#/components/schemas/unauthorized' + '402': + description: Payment Required + content: + application/json: + schema: + $ref: '#/components/schemas/paymentrequired' + '403': + description: Forbidden + content: + application/json: + schema: + $ref: '#/components/schemas/forbidden' + '404': + description: Not Found + content: + application/json: + schema: + $ref: '#/components/schemas/notfound' + '419': + description: Input Field Missing + content: + application/json: + schema: + $ref: '#/components/schemas/inputfieldmissing' + '413': + description: Input Limit Exceeded + content: + application/json: + schema: + $ref: '#/components/schemas/inputlimitexceeded' + '415': + description: Invalid Input + content: + application/json: + schema: + $ref: '#/components/schemas/invalidinput' + '500': + description: Internal Server Error + content: + application/json: + schema: + $ref: '#/components/schemas/servererror' + '504': + description: Gateway Timeout + content: + application/json: + schema: + $ref: '#/components/schemas/gatewaytimeout' + security: + - APIAuthorizer: [] + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/input' + required: true +components: + schemas: + success: + type: object + properties: + message: + type: string + example: Successfully Processed + description: Detail description on the api status + status: + type: string + example: Success + description: The status of the API call success/failure + url: + type: string + example: https://storage.googleapis.com/base64decode/24f03729131e469181a2fc22eb3a627a.zip?X-Goog-Algorithm=GOOG4-RSA-SHA256&X-Goog-Credential=sentient-dev-bigquery%40sentient-207310.iam.gserviceaccount.com%2F20201015%2Fauto%2Fstora... + description: Pre-signed URL to download the file + unauthorized: + type: object + properties: + message: + type: string + example: Missing Authentication Token + status: + type: string + example: Failure + forbidden: + type: object + properties: + message: + type: string + example: Access Denied Unauthorized User + status: + type: string + example: Failure + paymentrequired: + type: object + properties: + message: + type: string + example: Insufficient Credits Kindly Top Up + status: + type: string + example: Failure + notfound: + type: object + properties: + message: + type: string + example: Invalid Request URL + status: + type: string + example: Failure + servererror: + type: object + properties: + message: + type: string + example: Internal Server Error + status: + type: string + example: Failure + gatewaytimeout: + type: object + properties: + message: + type: string + example: Request Timeout + status: + type: string + example: Failure + inputfieldmissing: + type: object + properties: + message: + type: string + example: Input Field Missing + status: + type: string + example: Failure + inputlimitexceeded: + type: object + properties: + message: + type: string + example: Input Limit Exceeded + status: + type: string + example: Failure + invalidinput: + type: object + properties: + message: + type: string + example: Invalid Input + status: + type: string + example: Failure + versions: + type: object + properties: + v0.0.1: + type: array + items: + oneOf: + - type: string + example: Published Date - Oct 30,2020 + description: Initial version release + input: + type: object + required: + - base64 + properties: + base64: + x-name: base64 + type: string + default: true + example: UklGRoboDgBXQVZFZm10IBAAAAABAAEAgD4AAAB9AAACABAATElTVBoAAABJTkZPSVNGVA4AAABMYXZmNTguMjAuMTAwAGRhdGFA6A4AAAAAAAAAAAAAAAAAAAAAAAAA... + description: |+ + Input base64 encoded string + securitySchemes: + APIAuthorizer: + type: apiKey + name: x-api-key + in: header + x-amazon-apigateway-authtype: custom + description: Authentication is done using the x-api-key in the request header diff --git a/utility/base64-encoder.yaml b/utility/base64-encoder.yaml new file mode 100644 index 000000000..7bf6b5c92 --- /dev/null +++ b/utility/base64-encoder.yaml @@ -0,0 +1,237 @@ +openapi: 3.0.1 +info: + title: Base64 Encoder + description: |+ + This Utility microservice converts an uploaded file to Base64 encoded text (also known as a binary file to text converter). This microservice supports most documents, images, audio, video, archive and font files. See documentation for the detailed list of supported file formats.

User can choose the output base64 text string in 5 different formats (plain text, JSON, hyperlink, datauri, XML).

For the reverse process (converting Base64 string back to binary file), check out the Base 64 File Decode microservice. + x-additionalinfo: |+ + Suggested Use Cases: + - As a pre-processor for microservices that only takes in Base64 inputs + version: '0.0.1' + x-subscribelink: base64_encoder +servers: + - url: 'https://apis.sentient.io' +tags: +- name: "v0.0.1" + description: "Published Date - Oct 30, 2020" +paths: + /microservices/utility/base64encode/v0/getresults: + post: + tags: + - v0.0.1 + responses: + '200': + description: success response + content: + application/json: + schema: + $ref: '#/components/schemas/success' + example: + results: + base64: /9j/4AAQSkZJRgABAQAAAQABAAD/2wCEAAMCAggIBQUICAUGBQUGBgYGBgUFBQYGBgYGBgYGBgYGBgYGBQYGBgYGBgYGBgoGBgcICQkJBgYLDgoIDQYICQgBAwQEBgUGCAYGCAgHBwcICAgICAgBAABAgMFBgcECP.... + message: Successfully Processed + status: Success + '401': + description: Unauthorized + content: + application/json: + schema: + $ref: '#/components/schemas/unauthorized' + '402': + description: Payment Required + content: + application/json: + schema: + $ref: '#/components/schemas/paymentrequired' + '403': + description: Forbidden + content: + application/json: + schema: + $ref: '#/components/schemas/forbidden' + '404': + description: Not Found + content: + application/json: + schema: + $ref: '#/components/schemas/notfound' + '419': + description: Input Field Missing + content: + application/json: + schema: + $ref: '#/components/schemas/inputfieldmissing' + '413': + description: Input Limit Exceeded + content: + application/json: + schema: + $ref: '#/components/schemas/inputlimitexceeded' + '415': + description: Invalid Input + content: + application/json: + schema: + $ref: '#/components/schemas/invalidinput' + '500': + description: Internal Server Error + content: + application/json: + schema: + $ref: '#/components/schemas/servererror' + '504': + description: Gateway Timeout + content: + application/json: + schema: + $ref: '#/components/schemas/gatewaytimeout' + security: + - APIAuthorizer: [] + requestBody: + description: Input parameters

FieldType Description
filePathFileRequired. The file object
typeStringOptional. type of return data as xml/hyperlink/json/datauri/plaintext. plaintext is default if none selected


+ content: + multipart/form-data: + schema: + $ref: '#/components/schemas/input' + # required: true +components: + schemas: + success: + type: object + properties: + results: + type: object + example: { "" } + description: Json Object of returned results + properties: + base64: + type: string + description: Converted base64 encoded text in the requested output format + example: /9j/4AAQSkZJRgABAQAAAQABAAD/2wCEAAMCAggIBQUICAUGBQUGBgYGBgUFBQYGBgYGBgYGBgYGBgYGBQYGBgYGBgYGBgoGBgcICQkJBgYLDgoIDQYICQgBAwQEBgUGCAYGCAgHBwcICAgICAgBAABAgMFBgcECP.... + message: + type: string + example: Successfully Processed + description: Detail description on the API status + status: + type: string + example: Success + description: The status of the API call success/failure + unauthorized: + type: object + properties: + message: + type: string + example: Missing Authentication Token + status: + type: string + example: Failure + forbidden: + type: object + properties: + message: + type: string + example: Access Denied Unauthorized User + status: + type: string + example: Failure + paymentrequired: + type: object + properties: + message: + type: string + example: Insufficient Credits Kindly Top Up + status: + type: string + example: Failure + notfound: + type: object + properties: + message: + type: string + example: Invalid Request URL + status: + type: string + example: Failure + servererror: + type: object + properties: + message: + type: string + example: Internal Server Error + status: + type: string + example: Failure + gatewaytimeout: + type: object + properties: + message: + type: string + example: Request Timeout + status: + type: string + example: Failure + inputfieldmissing: + type: object + properties: + message: + type: string + example: Input Field Missing + status: + type: string + example: Failure + inputlimitexceeded: + type: object + properties: + message: + type: string + example: Input Limit Exceeded + status: + type: string + example: Failure + invalidinput: + type: object + properties: + message: + type: string + example: Invalid Input + status: + type: string + example: Failure + input: + type: object + required: + - filePath + properties: + filePath: + type: string + format: binary + example: sample.txt + default: true + description: The file object. + format: + type: string + example: "xml" + default: false + description: |+ + The output format. Possible values are: + 1. plaintext (default) + 2. json + 3. hyperlink + 4. datauri + 5. xml + versions: + type: object + properties: + v0.0.1: + type: array + items: + oneOf: + - type: string + example: Published Date - Oct 30, 2020 + description: Initial version release + securitySchemes: + APIAuthorizer: + type: apiKey + name: x-api-key + in: header + x-amazon-apigateway-authtype: custom + description: Authentication is done using the x-api-key in the request header diff --git a/utility/base64-file-decode.yaml b/utility/base64-file-decode.yaml new file mode 100644 index 000000000..92842bbc8 --- /dev/null +++ b/utility/base64-file-decode.yaml @@ -0,0 +1,220 @@ +openapi: 3.0.1 +info: + title: Base64 Decoder + description: |+ + This Utility microservice converts a Base64 encoded text string to a binary file.

For the reverse process (convert binary file to Base64 encoded text string), check out the Base64 File Encode microservice. + x-additionalinfo: |+ + Suggested Use Cases: + - As a post-processor for microservices that only outputs Base64 encoded text + version: '0.0.1' + x-subscribelink: base64_decoder +servers: + - url: 'https://apis.sentient.io' +tags: +- name: "v0.0.1" + description: "Published Date - Oct 30, 2020" +paths: + /microservices/utility/base64decode/v0/getresults: + post: + tags: + - "0.0.1" + responses: + '200': + description: success response + content: + application/json: + schema: + $ref: '#/components/schemas/success' + example: + url: https://storage.googleapis.com/base64decode_dev/24f03729131e469181a2fc22eb3a627a.zip?X-Goog-Algorithm=GOOG4-RSA-SHA256&X-Goog-Credential=sentient-dev-bigquery%40sentient-207310.iam.gserviceaccount.com%2F20201015%2Fa... + message: Successfully Processed + status: Success + '401': + description: Unauthorized + content: + application/json: + schema: + $ref: '#/components/schemas/unauthorized' + '402': + description: Payment Required + content: + application/json: + schema: + $ref: '#/components/schemas/paymentrequired' + '403': + description: Forbidden + content: + application/json: + schema: + $ref: '#/components/schemas/forbidden' + '404': + description: Not Found + content: + application/json: + schema: + $ref: '#/components/schemas/notfound' + '419': + description: Input Field Missing + content: + application/json: + schema: + $ref: '#/components/schemas/inputfieldmissing' + '420': + description: Input Limit Exceeded + content: + application/json: + schema: + $ref: '#/components/schemas/inputlimitexceeded' + '422': + description: Invalid Input + content: + application/json: + schema: + $ref: '#/components/schemas/invalidinput' + '500': + description: Internal Server Error + content: + application/json: + schema: + $ref: '#/components/schemas/servererror' + '504': + description: Gateway Timeout + content: + application/json: + schema: + $ref: '#/components/schemas/gatewaytimeout' + security: + - APIAuthorizer: [] + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/input' + required: true +components: + schemas: + success: + type: object + properties: + message: + type: string + example: Successfully Processed + description: Detail description on the api status + status: + type: string + example: Success + description: The status of the API call success/failure + url: + type: string + example: https://storage.googleapis.com/base64decode/24f03729131e469181a2fc22eb3a627a.zip?X-Goog-Algorithm=GOOG4-RSA-SHA256&X-Goog-Credential=sentient-dev-bigquery%40sentient-207310.iam.gserviceaccount.com%2F20201015%2Fauto%2Fstora... + description: Pre-signed URL to download the file + unauthorized: + type: object + properties: + message: + type: string + example: Missing Authentication Token + status: + type: string + example: Failure + forbidden: + type: object + properties: + message: + type: string + example: Access Denied Unauthorized User + status: + type: string + example: Failure + paymentrequired: + type: object + properties: + message: + type: string + example: Insufficient Credits Kindly Top Up + status: + type: string + example: Failure + notfound: + type: object + properties: + message: + type: string + example: Invalid Request URL + status: + type: string + example: Failure + servererror: + type: object + properties: + message: + type: string + example: Internal Server Error + status: + type: string + example: Failure + gatewaytimeout: + type: object + properties: + message: + type: string + example: Request Timeout + status: + type: string + example: Failure + inputfieldmissing: + type: object + properties: + message: + type: string + example: Input Field Missing + status: + type: string + example: Failure + inputlimitexceeded: + type: object + properties: + message: + type: string + example: Input Limit Exceeded + status: + type: string + example: Failure + invalidinput: + type: object + properties: + message: + type: string + example: Invalid Input + status: + type: string + example: Failure + versions: + type: object + properties: + v0.0.1: + type: array + items: + oneOf: + - type: string + example: Published Date - Oct 30,2020 + description: Initial version release + input: + type: object + required: + - base64 + properties: + base64: + x-name: base64 + type: string + default: true + example: UklGRoboDgBXQVZFZm10IBAAAAABAAEAgD4AAAB9AAACABAATElTVBoAAABJTkZPSVNGVA4AAABMYXZmNTguMjAuMTAwAGRhdGFA6A4AAAAAAAAAAAAAAAAAAAAAAAAA... + description: |+ + Input a base64 encoded string. + securitySchemes: + APIAuthorizer: + type: apiKey + name: x-api-key + in: header + x-amazon-apigateway-authtype: custom + description: Authentication is done using the x-api-key in the request header diff --git a/utility/base64-file-encode.yaml b/utility/base64-file-encode.yaml new file mode 100644 index 000000000..932e76d0b --- /dev/null +++ b/utility/base64-file-encode.yaml @@ -0,0 +1,237 @@ +openapi: 3.0.1 +info: + title: Base64 Encoder + description: |+ + This Utility microservice converts an uploaded file to Base64 encoded text (also known as a binary file to text converter). This microservice supports most documents, images, audio, video, archive and font files. See documentation for the detailed list of supported file formats.

User can choose the output base64 text string in 5 different formats (plain text, JSON, hyperlink, datauri, XML).

For the reverse process (converting Base64 string back to binary file), check out the Base 64 File Decode microservice. + x-additionalinfo: |+ + Suggested Use Cases: + - As a pre-processor for microservices that only takes in Base64 inputs + version: '0.0.1' + x-subscribelink: base64_encoder +servers: + - url: 'https://apis.sentient.io' +tags: +- name: "v0.0.1" + description: "Published Date - Oct 30, 2020" +paths: + /microservices/utility/base64encode/v0/getresults: + post: + tags: + - v0.0.1 + responses: + '200': + description: success response + content: + application/json: + schema: + $ref: '#/components/schemas/success' + example: + results: + base64: /9j/4AAQSkZJRgABAQAAAQABAAD/2wCEAAMCAggIBQUICAUGBQUGBgYGBgUFBQYGBgYGBgYGBgYGBgYGBQYGBgYGBgYGBgoGBgcICQkJBgYLDgoIDQYICQgBAwQEBgUGCAYGCAgHBwcICAgICAgBAABAgMFBgcECP.... + message: Successfully Processed + status: Success + '401': + description: Unauthorized + content: + application/json: + schema: + $ref: '#/components/schemas/unauthorized' + '402': + description: Payment Required + content: + application/json: + schema: + $ref: '#/components/schemas/paymentrequired' + '403': + description: Forbidden + content: + application/json: + schema: + $ref: '#/components/schemas/forbidden' + '404': + description: Not Found + content: + application/json: + schema: + $ref: '#/components/schemas/notfound' + '419': + description: Input Field Missing + content: + application/json: + schema: + $ref: '#/components/schemas/inputfieldmissing' + '420': + description: Input Limit Exceeded + content: + application/json: + schema: + $ref: '#/components/schemas/inputlimitexceeded' + '422': + description: Invalid Input + content: + application/json: + schema: + $ref: '#/components/schemas/invalidinput' + '500': + description: Internal Server Error + content: + application/json: + schema: + $ref: '#/components/schemas/servererror' + '504': + description: Gateway Timeout + content: + application/json: + schema: + $ref: '#/components/schemas/gatewaytimeout' + security: + - APIAuthorizer: [] + requestBody: + description: Input parameters

FieldType Description
filePathFileRequired. The file object
typeStringOptional. type of return data as xml/hyperlink/json/datauri/plaintext. plaintext is default if none selected


+ content: + multipart/form-data: + schema: + $ref: '#/components/schemas/input' + # required: true +components: + schemas: + success: + type: object + properties: + results: + type: object + example: { "" } + description: Json Object of returned results + properties: + base64: + type: string + description: Base64 encoded text converted to the requested output format. + example: /9j/4AAQSkZJRgABAQAAAQABAAD/2wCEAAMCAggIBQUICAUGBQUGBgYGBgUFBQYGBgYGBgYGBgYGBgYGBQYGBgYGBgYGBgoGBgcICQkJBgYLDgoIDQYICQgBAwQEBgUGCAYGCAgHBwcICAgICAgBAABAgMFBgcECP.... + message: + type: string + example: Successfully Processed + description: Detail description on the API status + status: + type: string + example: Success + description: The status of the API call success/failure + unauthorized: + type: object + properties: + message: + type: string + example: Missing Authentication Token + status: + type: string + example: Failure + forbidden: + type: object + properties: + message: + type: string + example: Access Denied Unauthorized User + status: + type: string + example: Failure + paymentrequired: + type: object + properties: + message: + type: string + example: Insufficient Credits Kindly Top Up + status: + type: string + example: Failure + notfound: + type: object + properties: + message: + type: string + example: Invalid Request URL + status: + type: string + example: Failure + servererror: + type: object + properties: + message: + type: string + example: Internal Server Error + status: + type: string + example: Failure + gatewaytimeout: + type: object + properties: + message: + type: string + example: Request Timeout + status: + type: string + example: Failure + inputfieldmissing: + type: object + properties: + message: + type: string + example: Input Field Missing + status: + type: string + example: Failure + inputlimitexceeded: + type: object + properties: + message: + type: string + example: Input Limit Exceeded + status: + type: string + example: Failure + invalidinput: + type: object + properties: + message: + type: string + example: Invalid Input + status: + type: string + example: Failure + input: + type: object + required: + - filePath + properties: + filePath: + type: string + format: binary + example: sample.txt + default: true + description: The file object. + format: + type: string + example: "xml" + default: false + description: |+ + The output format. Possible values are: + 1. plaintext (default) + 2. json + 3. hyperlink + 4. datauri + 5. xml + versions: + type: object + properties: + v0.0.1: + type: array + items: + oneOf: + - type: string + example: Published Date - Oct 30, 2020 + description: Initial version release + securitySchemes: + APIAuthorizer: + type: apiKey + name: x-api-key + in: header + x-amazon-apigateway-authtype: custom + description: Authentication is done using the x-api-key in the request header diff --git a/utility/csv-json_convertor.yaml b/utility/csv-json_convertor.yaml new file mode 100644 index 000000000..fd4177318 --- /dev/null +++ b/utility/csv-json_convertor.yaml @@ -0,0 +1,232 @@ +openapi: 3.0.1 +info: + title: CSV-JSON Convertor + description: |+ + This Utility microservice converts the input CSV to JSON format. The headers should be the keywords and columns should be the value of proper keywords. + + The size of your file should **not exceed 3.5 MB**. + x-additionalinfo: |+ + Suggested Use Cases: + - For users who would like to combine data into useful spreadsheets for others to analyze, update, or refer to. This microservice can convert a collection of CSV spreadsheets like Google Sheets or Excel into JSON to analyze data without programming. + version: '1.0.0' + x-subscribelink: csv-json_convertor +servers: + - url: 'https://apis.sentient.io' +tags: +- name: "v1.0.0" + description: "Published Date - May 15, 2020" +paths: + /microservices/utility/csvtojson/v1.0/getresults: + post: + tags: + - v1.0.0 + responses: + '200': + description: success response + content: + application/json: + schema: + $ref: '#/components/schemas/success' + example: + message: Successfully Converted and stored in Google Cloud Storage + results: + jsondata: [] + url: https://storage.googleapis.com/json_csv/data.json?X-Goog-Algorithm=GOOG4-RSA-SHA256&X-Goog-Credential=sentient-bigquery%40sentient-231509.iam.gserviceaccount.com%2F20200617%2Fauto%2Fstorage%2Fgoog4_request&X-Goog-Date=20200617T125854Z&X-Goog-Expires=6000&X-Goog-SignedHeaders=host&X-Goog-Signature=b66fb7b978a78d702e099b44ce7575de8a29834c23a6d365368022d7b1ab815e154100aa1648650e8b9ff9c038f0a61ac7d6d22b04195f18dfbf365e2050a7cbb29d9f87eb860fbe36f10573c941856341fa3117bbfee92bbd7e189ceca0a62fa8b78cb62647c4fc47e60e972c7c107088698924a7217571fee1900888c987fd80bdc078d4d765f6a4a65f4ff792c42344e07caf39b73961bee0d4b83407fda54e0d6b90fe528f62908ea54e3b07d8fba8098859330d6e9cc698f6cede40bdc05f1ec4efb29f1afc93572de52fe531d3b67fbdd035844a97b310e16eec17a4edeabdabb076b29bee9b1d44e0b90951c070046534f660d2fb291a1e1bae98ddc3 + status: Success + '401': + description: Unauthorized + content: + application/json: + schema: + $ref: '#/components/schemas/unauthorized' + '402': + description: Payment Required + content: + application/json: + schema: + $ref: '#/components/schemas/paymentrequired' + '403': + description: Forbidden + content: + application/json: + schema: + $ref: '#/components/schemas/forbidden' + '404': + description: Not Found + content: + application/json: + schema: + $ref: '#/components/schemas/notfound' + '419': + description: Input Field Missing + content: + application/json: + schema: + $ref: '#/components/schemas/inputfieldmissing' + '413': + description: Input Limit Exceeded + content: + application/json: + schema: + $ref: '#/components/schemas/inputlimitexceeded' + '415': + description: Invalid Input + content: + application/json: + schema: + $ref: '#/components/schemas/invalidinput' + '500': + description: Internal Server Error + content: + application/json: + schema: + $ref: '#/components/schemas/servererror' + '504': + description: Gateway Timeout + content: + application/json: + schema: + $ref: '#/components/schemas/gatewaytimeout' + security: + - APIAuthorizer: [] + requestBody: + content: + multipart/form-data: + schema: + $ref: '#/components/schemas/input' + required: true +components: + schemas: + success: + type: object + properties: + message: + type: string + description: Successfully Converted and stored in Google Cloud Storage + example: Successfully Converted and stored in Google Cloud Storage + results: + type: object + example: { "" } + description: List of items + properties: + jsondata: + type: string + example: [{"emp_name":"xxxxx","email":"xxxxx@sentient.io","job":"developer"}] + description: converted json object + url: + type: string + description: converted json object + example: https://storage.googleapis.com/json_csv/data.json?X-Goog-Algorithm=GOOG4-RSA-SHA256&X-Goog-Credential=sentient-bigquery%40sentient-231509.iam.gserviceaccount.com%2F20200617%2Fauto%2Fstorage%2Fgoog4_request&X-Goog-Date=20200617T125854Z&X-Goog-Expires=6000&X-Goog-SignedHeaders=host&X-Goog-Signature=b66fb7b978a78d702e099b44ce7575de8a29834c23a6d365368022d7b1ab815e154100aa1648650e8b9ff9c038f0a61ac7d6d22b04195f18dfbf365e2050a7cbb29d9f87eb860fbe36f10573c941856341fa3117bbfee92bbd7e189ceca0a62fa8b78cb62647c4fc47e60e972c7c107088698924a7217571fee1900888c987fd80bdc078d4d765f6a4a65f4ff792c42344e07caf39b73961bee0d4b83407fda54e0d6b90fe528f62908ea54e3b07d8fba8098859330d6e9cc698f6cede40bdc05f1ec4efb29f1afc93572de52fe531d3b67fbdd035844a97b310e16eec17a4edeabdabb076b29bee9b1d44e0b90951c070046534f660d2fb291a1e1bae98ddc3 + status: + type: string + example: Success + description: The status of the API call. success/failure + unauthorized: + type: object + properties: + message: + type: string + example: Missing Authentication Token + status: + type: string + example: Failure + forbidden: + type: object + properties: + message: + type: string + example: Access Denied Unauthorized User + status: + type: string + example: Failure + paymentrequired: + type: object + properties: + message: + type: string + example: Insufficient Credits Kindly Top Up + status: + type: string + example: Failure + notfound: + type: object + properties: + message: + type: string + example: Invalid Request URL + status: + type: string + example: Failure + servererror: + type: object + properties: + message: + type: string + example: Internal Server Error + status: + type: string + example: Failure + gatewaytimeout: + type: object + properties: + message: + type: string + example: Request Timeout + status: + type: string + example: Failure + inputfieldmissing: + type: object + properties: + message: + type: string + example: Input Field Missing + status: + type: string + example: Failure + inputlimitexceeded: + type: object + properties: + message: + type: string + example: Input Limit Exceeded + status: + type: string + example: Failure + versions: + type: object + properties: + v1.0.0: + type: array + items: + oneOf: + - type: string + example: Published Date - May 15, 2020 + description: Initial version release + invalidinput: + type: object + properties: + message: + type: string + example: Invalid Input + status: + type: string + example: Failure + input: + type: object + required: + - csvfile + properties: + csvfile: + type: string + format: binary + default: true + example: sample.csv + description: The file object. + securitySchemes: + APIAuthorizer: + type: apiKey + name: x-api-key + in: header + x-amazon-apigateway-authtype: custom + description: Authentication is done using the x-api-key in the request header diff --git a/utility/decryption_using_pki_key.yaml b/utility/decryption_using_pki_key.yaml new file mode 100644 index 000000000..737ef9ce6 --- /dev/null +++ b/utility/decryption_using_pki_key.yaml @@ -0,0 +1,225 @@ +openapi: 3.0.1 +info: + title: Decryption using PKI Key + description: |+ + This Utiltiy microservice decrypts the input text using the input key string. + + This can be use with PKI Key Generator. + + Do ensure that your text is **within 512 characters**. + x-additionalinfo: |+ + Suggested Use Cases: + - This microservice can be used to simplify the deployment, management, and security of one's enterprise PKI with a microservice that helps to automate time-consuming, risky, and error-prone infrastructure tasks, freeing users to focus on higher-value projects. + version: '0.1.0' + x-subscribelink: decryption_using_pki_key +servers: + - url: 'https://apis.sentient.io' +tags: +- name: "v0.1.0" + description: "Published Date - Aug 30, 2019" +paths: + /microservices/utility/rsa_decode/v0.1/getresults: + post: + tags: + - v0.1.0 + responses: + '200': + description: success response + content: + application/json: + schema: + $ref: '#/components/schemas/success' + example: + message: Successfully Processed + status: Success + result: hello + '401': + description: Unauthorized + content: + application/json: + schema: + $ref: '#/components/schemas/unauthorized' + '402': + description: Payment Required + content: + application/json: + schema: + $ref: '#/components/schemas/paymentrequired' + '403': + description: Forbidden + content: + application/json: + schema: + $ref: '#/components/schemas/forbidden' + '404': + description: Not Found + content: + application/json: + schema: + $ref: '#/components/schemas/notfound' + '419': + description: Input Field Missing + content: + application/json: + schema: + $ref: '#/components/schemas/inputfieldmissing' + '413': + description: Input Limit Exceeded + content: + application/json: + schema: + $ref: '#/components/schemas/inputlimitexceeded' + '415': + description: Invalid Input + content: + application/json: + schema: + $ref: '#/components/schemas/invalidinput' + '500': + description: Internal Server Error + content: + application/json: + schema: + $ref: '#/components/schemas/servererror' + '504': + description: Gateway Timeout + content: + application/json: + schema: + $ref: '#/components/schemas/gatewaytimeout' + security: + - APIAuthorizer: [] + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/input' + required: true +components: + schemas: + success: + type: object + properties: + message: + type: string + example: Successfully Processed + description: Detailed description on the API status + status: + type: string + example: Success + description: The status of the API call success/failure + result: + type: string + example: hello + description: Original text + unauthorized: + type: object + properties: + message: + type: string + example: Missing Authentication Token + status: + type: string + example: Failure + forbidden: + type: object + properties: + message: + type: string + example: Access Denied Unauthorized User + status: + type: string + example: Failure + paymentrequired: + type: object + properties: + message: + type: string + example: Insufficient Credits Kindly Top Up + status: + type: string + example: Failure + notfound: + type: object + properties: + message: + type: string + example: Invalid Request URL + status: + type: string + example: Failure + servererror: + type: object + properties: + message: + type: string + example: Internal Server Error + status: + type: string + example: Failure + gatewaytimeout: + type: object + properties: + message: + type: string + example: Request Timeout + status: + type: string + example: Failure + inputfieldmissing: + type: object + properties: + message: + type: string + example: Input Field Missing + status: + type: string + example: Failure + inputlimitexceeded: + type: object + properties: + message: + type: string + example: Input Limit Exceeded + status: + type: string + example: Failure + invalidinput: + type: object + properties: + message: + type: string + example: Invalid Input + status: + type: string + example: Failure + versions: + type: object + properties: + v0.1.0: + type: array + items: + oneOf: + - type: string + example: Published Date - Aug 30, 2019 + description: Initial version release + input: + type: object + properties: + encodeText: + type: string + default: true + example: 4bafe80478a11553a69... + description: Encrypted text + key: + type: string + default: true + example: MIIEowIBAAKCAQ... + description: Private key + securitySchemes: + APIAuthorizer: + type: apiKey + name: x-api-key + in: header + x-amazon-apigateway-authtype: custom + description: Authentication is done using the x-api-key in the request header diff --git a/utility/document_convertor_eng.yaml b/utility/document_convertor_eng.yaml new file mode 100644 index 000000000..05cf17edd --- /dev/null +++ b/utility/document_convertor_eng.yaml @@ -0,0 +1,235 @@ +openapi: 3.0.1 +info: + title: Document Convertor ENG + description: |+ + This Utility microservice extracts the English text content of singular input Microsoft Word, HTML or PDF documents and outputs into plain text format. + + The size of your document file should **not exceed 7 MB**. + x-additionalinfo: |+ + Suggested Use Cases: + - Used for pre/post processing of documents so that the output can paired with another microservice to address a specific solution. For example, text extracted from the document can be used with a Voice microservice such as Text-to-Speech. + + - Can be used for solutions related to processing workflows that are document-heavy so that the user can focus on the more value-added decisions. Documents in a variety of formats can be taken in to return cleanly structured data. Examples included mortgage processing, procurement data etc. + version: '1.0.0' + x-subscribelink: document_convertor_eng +servers: + - url: 'https://apis.sentient.io' +tags: +- name: "v1.0.0" + description: "Published Date - Jul 30, 2020" +paths: + /microservices/utility/docconversion/v1.0/getresults: + post: + tags: + - v1.0.0 + responses: + '200': + description: success response + content: + application/json: + schema: + $ref: '#/components/schemas/success' + example: + results: "\\n L 328/84 \\n Official Journal of the European Union \\n EN \\n + 18.12.2019 \\n DECISIONS \\n COMMISSION IMPLEMENTING DECISION (EU) 2019/2166 \\n + of 16 December 2019 \\n amending Implementing Decision 2014/908/EU as regards the + inclusion of Serbia and South Korea in \\n the lists of third countries and + \ territories whose supervisory and regulatory requirements" + message: Successfully Processed + status: Success + '401': + description: Unauthorized + content: + application/json: + schema: + $ref: '#/components/schemas/unauthorized' + '402': + description: Payment Required + content: + application/json: + schema: + $ref: '#/components/schemas/paymentrequired' + '403': + description: Forbidden + content: + application/json: + schema: + $ref: '#/components/schemas/forbidden' + '404': + description: Not Found + content: + application/json: + schema: + $ref: '#/components/schemas/notfound' + '419': + description: Input Field Missing + content: + application/json: + schema: + $ref: '#/components/schemas/inputfieldmissing' + '413': + description: Input Limit Exceeded + content: + application/json: + schema: + $ref: '#/components/schemas/inputlimitexceeded' + '415': + description: Invalid Input + content: + application/json: + schema: + $ref: '#/components/schemas/invalidinput' + '500': + description: Internal Server Error + content: + application/json: + schema: + $ref: '#/components/schemas/servererror' + '504': + description: Gateway Timeout + content: + application/json: + schema: + $ref: '#/components/schemas/gatewaytimeout' + security: + - APIAuthorizer: [] + requestBody: + content: + multipart/form-data: + schema: + $ref: '#/components/schemas/input' +components: + schemas: + success: + type: object + properties: + results: + type: string + example: \n L 328/84 \n Official Journal of the European Union \n EN \n 18.12.2019 \n DECISIONS \n COMMISSION IMPLEMENTING DECISION (EU) 2019/2166 \n of 16 December 2019 \n amending Implementing Decision 2014/908/EU as regards the inclusion of Serbia and South Korea in \n the lists of third countries and territories whose supervisory and regulatory requirements + description: The result of the API call. + message: + type: string + example: Successfully Processed + description: Detail description on the API status + status: + type: string + example: Success + description: The status of the API call success/failure + unauthorized: + type: object + properties: + message: + type: string + example: Missing Authentication Token + status: + type: string + example: Failure + forbidden: + type: object + properties: + message: + type: string + example: Access Denied Unauthorized User + status: + type: string + example: Failure + paymentrequired: + type: object + properties: + message: + type: string + example: Insufficient Credits Kindly Top Up + status: + type: string + example: Failure + notfound: + type: object + properties: + message: + type: string + example: Invalid Request URL + status: + type: string + example: Failure + servererror: + type: object + properties: + message: + type: string + example: Internal Server Error + status: + type: string + example: Failure + gatewaytimeout: + type: object + properties: + message: + type: string + example: Request Timeout + status: + type: string + example: Failure + inputfieldmissing: + type: object + properties: + message: + type: string + example: Input Field Missing + status: + type: string + example: Failure + inputlimitexceeded: + type: object + properties: + message: + type: string + example: Input Limit Exceeded + status: + type: string + example: Failure + invalidinput: + type: object + properties: + message: + type: string + example: Invalid Input + status: + type: string + example: Failure + versions: + type: object + properties: + v1.0.0: + type: array + items: + oneOf: + - type: string + example: Published Date - Jul 30, 2020 + description: Change libary for PDF reader + v0.1.0: + type: array + items: + oneOf: + - type: string + example: Published Date - Apr 16, 2018 + description: Initial version release + input: + type: object + required: + - filePath + properties: + filePath: + type: string + format: binary + default: true + example: sample.txt + description: The file object. + + Supported formats: docx, pdf, txt. + securitySchemes: + APIAuthorizer: + type: apiKey + name: x-api-key + in: header + x-amazon-apigateway-authtype: custom + description: Authentication is done using the x-api-key in the request header diff --git a/utility/download_dataset.yaml b/utility/download_dataset.yaml new file mode 100644 index 000000000..34c1dc112 --- /dev/null +++ b/utility/download_dataset.yaml @@ -0,0 +1,10 @@ +info: + title: Data Alliance - Download Dataset API + version: '0.1.0' +# tags must include in to the documentation, to read the description text for published date +tags: +- name: "v0.1.0" + description: " " +html: |+ + diff --git a/utility/encryption_using_pki_key.yaml b/utility/encryption_using_pki_key.yaml new file mode 100644 index 000000000..89f64add2 --- /dev/null +++ b/utility/encryption_using_pki_key.yaml @@ -0,0 +1,225 @@ +openapi: 3.0.1 +info: + title: Encryption using PKI Key + description: |+ + This Utiltiy microservice encrypts the input text using the input key string. + + This can be use with PKI Key Generator. + + Do ensure that your text is **within 512 characters**. + x-additionalinfo: |+ + Suggested Use Cases: + - This microservice can be used to simplify the deployment, management, and security of one's enterprise PKI with a microservice that helps to automate time-consuming, risky, and error-prone infrastructure tasks, freeing users to focus on higher-value projects. + version: '0.1.0' + x-subscribelink: encryption_using_pki_key +servers: + - url: 'https://apis.sentient.io' +tags: +- name: "v0.1.0" + description: "Published Date - Aug 30, 2019" +paths: + /microservices/utility/rsa_encode/v0.1/getresults: + post: + tags: + - v0.1.0 + responses: + '200': + description: success response + content: + application/json: + schema: + $ref: '#/components/schemas/success' + example: + message: Successfully Processed + status: Success + result: nXqbfpv8gK3wZqLjohfy2NCdBJSXQ/NyHec52SFcQiePxl/iVB9wwThAc1U3mBRSM2/YysQodsd89DVuQx3aNNV4/BmYmC53yeWIwfpHZv8DOWSY4dremBDFa6vaFLF89ed0RSkgl7+cut4g0bkXuMODMyEfBerqnrsvQlqHbVY= + '401': + description: Unauthorized + content: + application/json: + schema: + $ref: '#/components/schemas/unauthorized' + '402': + description: Payment Required + content: + application/json: + schema: + $ref: '#/components/schemas/paymentrequired' + '403': + description: Forbidden + content: + application/json: + schema: + $ref: '#/components/schemas/forbidden' + '404': + description: Not Found + content: + application/json: + schema: + $ref: '#/components/schemas/notfound' + '419': + description: Input Field Missing + content: + application/json: + schema: + $ref: '#/components/schemas/inputfieldmissing' + '413': + description: Input Limit Exceeded + content: + application/json: + schema: + $ref: '#/components/schemas/inputlimitexceeded' + '415': + description: Invalid Input + content: + application/json: + schema: + $ref: '#/components/schemas/invalidinput' + '500': + description: Internal Server Error + content: + application/json: + schema: + $ref: '#/components/schemas/servererror' + '504': + description: Gateway Timeout + content: + application/json: + schema: + $ref: '#/components/schemas/gatewaytimeout' + security: + - APIAuthorizer: [] + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/input' + required: true +components: + schemas: + success: + type: object + properties: + message: + type: string + example: Successfully Processed + description: Detailed description on the API status + status: + type: string + example: Success + description: The status of the API call. + result: + type: string + description: Encrypted text + example: nXqbfpv8gK3wZqLjohfy2NCdBJSXQ/NyHec52SFcQiePxl/iVB9wwThAc1U3mBRSM2/YysQodsd89DVuQx3aNNV4/BmYmC53yeWIwfpHZv8DOWSY4dremBDFa6vaFLF89ed0RSkgl7+cut4g0bkXuMODMyEfBerqnrsvQlqHbVY= + unauthorized: + type: object + properties: + message: + type: string + example: Missing Authentication Token + status: + type: string + example: Failure + forbidden: + type: object + properties: + message: + type: string + example: Access Denied Unauthorized User + status: + type: string + example: Failure + paymentrequired: + type: object + properties: + message: + type: string + example: Insufficient Credits Kindly Top Up + status: + type: string + example: Failure + notfound: + type: object + properties: + message: + type: string + example: Invalid Request URL + status: + type: string + example: Failure + servererror: + type: object + properties: + message: + type: string + example: Internal Server Error + status: + type: string + example: Failure + gatewaytimeout: + type: object + properties: + message: + type: string + example: Request Timeout + status: + type: string + example: Failure + inputfieldmissing: + type: object + properties: + message: + type: string + example: Input Field Missing + status: + type: string + example: Failure + inputlimitexceeded: + type: object + properties: + message: + type: string + example: Input Limit Exceeded + status: + type: string + example: Failure + invalidinput: + type: object + properties: + message: + type: string + example: Invalid Input + status: + type: string + example: Failure + input: + type: object + properties: + text: + type: string + default: true + example: plain text + description: Input text + key: + type: string + default: true + example: MIIBIjANBgkqhkiG9w0BAQEF... + description: Public key + versions: + type: object + properties: + v0.1.0: + type: array + items: + oneOf: + - type: string + example: Published Date - Aug 30, 2019 + description: Initial version release + securitySchemes: + APIAuthorizer: + type: apiKey + name: x-api-key + in: header + x-amazon-apigateway-authtype: custom + description: Authentication is done using the x-api-key in the request header diff --git a/utility/inverse_text_normalisation_eng.yaml b/utility/inverse_text_normalisation_eng.yaml new file mode 100644 index 000000000..10520a858 --- /dev/null +++ b/utility/inverse_text_normalisation_eng.yaml @@ -0,0 +1,228 @@ +openapi: 3.0.1 +info: + title: Inverse Text Normalisation ENG + description: |+ + This NLP microservice recovers missing punctuations such as full stop, comma, exclamation mark, and question mark from the input text. + + This NLP microservice also converts pre-defined abbreviations from lower case to upper case. + + This NLP microservice also converts first letters of sentences to upper case. + x-additionalinfo: |+ + Suggested Use Cases: + - Can be integrated into services or apps that offer digital writing assistance to make writing clear and effective. + version: '0.1.0' + x-subscribelink: inverse_text_normalisation_eng +servers: + - url: 'https://apis.sentient.io' +tags: +- name: "v0.1.0" + description: "Published Date - Mar 24, 2020" +paths: + /microservices/nlp/inversenorm/v0.1/getpredictions: + post: + tags: + - v0.1.0 + responses: + '200': + description: success response + content: + application/json: + schema: + $ref: '#/components/schemas/success' + example: + '0': |+ + Apple said, the project-financing fund was the 1 of its kind, real estate developers, + often secure bonds for affordable housing development, but must service the debt + during construction, until the houses are built and start to generate revenue, apple + and state officials hope to provide bridge financing during construction at rates + below those from commercial lenders. + '1': |+ + The $2000000000 in funding will be deployable across NTU while the remaining + 5500000000 will go toward efforts specific to apple's home region in northern california, + where fast-growing tech companies have drawn protests from residents who blame them + for rising, housing costs. + '401': + description: Unauthorized + content: + application/json: + schema: + $ref: '#/components/schemas/unauthorized' + '402': + description: Payment Required + content: + application/json: + schema: + $ref: '#/components/schemas/paymentrequired' + '403': + description: Forbidden + content: + application/json: + schema: + $ref: '#/components/schemas/forbidden' + '404': + description: Not Found + content: + application/json: + schema: + $ref: '#/components/schemas/notfound' + '419': + description: Input Field Missing + content: + application/json: + schema: + $ref: '#/components/schemas/inputfieldmissing' + '413': + description: Input Limit Exceeded + content: + application/json: + schema: + $ref: '#/components/schemas/inputlimitexceeded' + '415': + description: Invalid Input + content: + application/json: + schema: + $ref: '#/components/schemas/invalidinput' + '500': + description: Internal Server Error + content: + application/json: + schema: + $ref: '#/components/schemas/servererror' + '504': + description: Gateway Timeout + content: + application/json: + schema: + $ref: '#/components/schemas/gatewaytimeout' + security: + - APIAuthorizer: [] + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/input' + required: true +components: + schemas: + success: + type: object + properties: + : + type: string + example: { 0: Apple said, the project-financing fund was the 1 of its kind, real estate developers, often secure bonds for affordable housing development, but must service the debt during construction, until the houses are built and start to generate revenue, apple and state officials hope to provide bridge financing during construction at rates below those from commercial lenders.} + description: Order sequence number + unauthorized: + type: object + properties: + message: + type: string + example: Missing Authentication Token + status: + type: string + example: Failure + forbidden: + type: object + properties: + message: + type: string + example: Access Denied Unauthorized User + status: + type: string + example: Failure + paymentrequired: + type: object + properties: + message: + type: string + example: Insufficient Credits Kindly Top Up + status: + type: string + example: Failure + notfound: + type: object + properties: + message: + type: string + example: Invalid Request URL + status: + type: string + example: Failure + servererror: + type: object + properties: + message: + type: string + example: Internal Server Error + status: + type: string + example: Failure + gatewaytimeout: + type: object + properties: + message: + type: string + example: Request Timeout + status: + type: string + example: Failure + inputfieldmissing: + type: object + properties: + message: + type: string + example: Input Field Missing + status: + type: string + example: Failure + inputlimitexceeded: + type: object + properties: + message: + type: string + example: Input Limit Exceeded + status: + type: string + example: Failure + invalidinput: + type: object + properties: + message: + type: string + example: Invalid Input + status: + type: string + example: Failure + versions: + type: object + properties: + v0.1.0: + type: array + items: + oneOf: + - type: string + example: Published Date - Mar 24, 2020 + description: Initial version release + input: + type: array + required: + - text + items: + type: object + properties: + text: + x-name: text + type: string + default: true + example: Apple said the project-financing fund was the first of its kind Real estate developers often secure bonds for affordable housing development but must service the debt during construction until the houses are built and start to generate revenue Apple and state officials hope to provide bridge financing during construction at rates below those from commercial lenders + description: |+ + Input text. + + Supported formats: ASCII only + securitySchemes: + APIAuthorizer: + type: apiKey + name: x-api-key + in: header + x-amazon-apigateway-authtype: custom + description: Authentication is done using the x-api-key in the request header diff --git a/utility/inverse_text_normalisation_eng_v1.0.yaml b/utility/inverse_text_normalisation_eng_v1.0.yaml new file mode 100644 index 000000000..63e1e1e8b --- /dev/null +++ b/utility/inverse_text_normalisation_eng_v1.0.yaml @@ -0,0 +1,248 @@ +openapi: 3.0.1 +info: + title: Inverse Text Normalisation ENG + description: |+ + This NLP microservice recovers the missing punctuations such as full stop, comma, exclamation mark, and question mark from the input text. + + It converts pre-defined abbreviations from lower case to upper case and also first letters of sentences to upper case. + + Do ensure that your text is within **5000 characters**. + version: '1.0.0' + x-additionalinfo: |+ + Suggested Use Cases: + - Can be integrated into services or apps that offer digital writing assistance to make writing clear and effective. + x-subscribelink: inverse_text_normalisation_eng +servers: + - url: 'https://apis.sentient.io' +tags: +- name: "v1.0.0" + description: "Published Date - Oct 30, 2020" +paths: + /microservices/nlp/inversenorm/v1/getpredictions: + post: + tags: + - v1.0.0 + responses: + '200': + description: success response + content: + application/json: + schema: + $ref: '#/components/schemas/success' + example: + results: + '0': |+ + Apple said, the project-financing fund was the 1 of its kind, real estate developers, + often secure bonds for affordable housing development, but must service the debt + during construction, until the houses are built and start to generate revenue, apple + and state officials hope to provide bridge financing during construction at rates + below those from commercial lenders. + '1': |+ + The $2000000000 in funding will be deployable across NTU while the remaining + 5500000000 will go toward efforts specific to apple's home region in northern california, + where fast-growing tech companies have drawn protests from residents who blame them + for rising, housing costs. + message: Successfully Processed + status: Success + '401': + description: Unauthorized + content: + application/json: + schema: + $ref: '#/components/schemas/unauthorized' + '402': + description: Payment Required + content: + application/json: + schema: + $ref: '#/components/schemas/paymentrequired' + '403': + description: Forbidden + content: + application/json: + schema: + $ref: '#/components/schemas/forbidden' + '404': + description: Not Found + content: + application/json: + schema: + $ref: '#/components/schemas/notfound' + '419': + description: Input Field Missing + content: + application/json: + schema: + $ref: '#/components/schemas/inputfieldmissing' + '413': + description: Input Limit Exceeded + content: + application/json: + schema: + $ref: '#/components/schemas/inputlimitexceeded' + '415': + description: Invalid Input + content: + application/json: + schema: + $ref: '#/components/schemas/invalidinput' + '500': + description: Internal Server Error + content: + application/json: + schema: + $ref: '#/components/schemas/servererror' + '504': + description: Gateway Timeout + content: + application/json: + schema: + $ref: '#/components/schemas/gatewaytimeout' + security: + - APIAuthorizer: [] + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/input' + required: true +components: + schemas: + success: + type: object + properties: + results: + type: object + description: The result of the API call. + example: { "" } + properties: + : + x-name: + type: string + example: { 0: Apple said, the project-financing fund was the 1 of its kind, real estate developers, often secure bonds for affordable housing development, but must service the debt during construction, until the houses are built and start to generate revenue, apple and state officials hope to provide bridge financing during construction at rates below those from commercial lenders.} + description: Order sequence number + message: + type: string + example: Successfully Processed + description: Detail description on the API status + status: + type: string + example: Success + description: The status of the API call success/failure + unauthorized: + type: object + properties: + message: + type: string + example: Missing Authentication Token + status: + type: string + example: Failure + forbidden: + type: object + properties: + message: + type: string + example: Access Denied Unauthorized User + status: + type: string + example: Failure + paymentrequired: + type: object + properties: + message: + type: string + example: Insufficient Credits Kindly Top Up + status: + type: string + example: Failure + notfound: + type: object + properties: + message: + type: string + example: Invalid Request URL + status: + type: string + example: Failure + servererror: + type: object + properties: + message: + type: string + example: Internal Server Error + status: + type: string + example: Failure + gatewaytimeout: + type: object + properties: + message: + type: string + example: Request Timeout + status: + type: string + example: Failure + inputfieldmissing: + type: object + properties: + message: + type: string + example: Input Field Missing + status: + type: string + example: Failure + inputlimitexceeded: + type: object + properties: + message: + type: string + example: Input Limit Exceeded + status: + type: string + example: Failure + invalidinput: + type: object + properties: + message: + type: string + example: Invalid Input + status: + type: string + example: Failure + versions: + type: object + properties: + v1.0.0: + type: array + items: + oneOf: + - type: string + example: Published Date - Oct 30,2020 + description: Standardizing Output JSON + v0.1.0: + type: array + items: + oneOf: + - type: string + example: Published Date - Mar 24, 2020 + description: Initial version release + input: + type: object + required: + - text + properties: + text: + x-name: text + type: string + default: true + example: Apple said the project-financing fund was the first of its kind Real estate developers often secure bonds for affordable housing development but must service the debt during construction until the houses are built and start to generate revenue Apple and state officials hope to provide bridge financing during construction at rates below those from commercial lenders + description: |+ + Input text + securitySchemes: + APIAuthorizer: + type: apiKey + name: x-api-key + in: header + x-amazon-apigateway-authtype: custom + description: Authentication is done using the x-api-key in the request header diff --git a/utility/json-csv_convertor.yaml b/utility/json-csv_convertor.yaml new file mode 100644 index 000000000..bd89410b6 --- /dev/null +++ b/utility/json-csv_convertor.yaml @@ -0,0 +1,233 @@ +openapi: 3.0.1 +info: + title: JSON-CSV Convertor + description: |+ + This Utility microservice converts the input JSON (json string or json file) to CSV format. + x-additionalinfo: |+ + Suggested Use Cases: + - For users who would like to combine data into useful spreadsheets for others to analyze, update, or refer to. This microservice can convert a collection of JSON into CSV spreadsheets like Google Sheets or Excel to analyze data without programming. + version: '1.0.0' + x-subscribelink: json-csv_convertor +servers: + - url: 'https://apis.sentient.io' +tags: +- name: "v1.0.0" + description: "Published Date - May 15, 2020" +paths: + /microservices/utility/jsontocsv/v1.0/getresults: + post: + tags: + - v1.0.0 + responses: + '200': + description: success response + content: + application/json: + schema: + $ref: '#/components/schemas/success' + example: + results: + url: https://storage.googleapis.com/json_csv_stroage/data_file.csv?X-Goog-Algorithm=GOOG4-RSA-SHA256&X-Goog-Credential=sentient-dev-bigquery%40sentient-207310.iam.gserviceaccount.com%2F20200514%2Fauto%2Fstorage%2Fgoog4_request&X-Goog-Date=20200514T062642Z&X-Goog-Expires=6000&X-Goog-SignedHeaders=host&X-Goog-Signature=4141536f1982dfb26a49c8764517a8147db31ed658aabe36715fe253588c073415bc813be245311cd701462da4d9bd8c07bc587127fea062e00eaf1a30db42a932ef458fae561969bf3d8c614d0c10a993590387a9f8587b8ed48925d8ef8eeed2a7e6ba09049a7a466c4d6204feccedb56dd05ea47d0acd8dcd9517c6b94613f69af7bf5dacf68da3911713da781ee81bc5e0821f507a658cab3f4910f4997462c1fdd612940d088d32c07218ab40ccf3b30af752eab47ae715a354aeb5497cc6470d46b0fbb2db49b2f76535f85b99f758162ed46809a206c2760f39c5c72fc084ec007a5444ccb99a0a3466542d673a326b3290ffa5271fbf3348e99f9926" + status: Success + message: Successfully Converted and stored in Google Cloud Storage + '401': + description: Unauthorized + content: + application/json: + schema: + $ref: '#/components/schemas/unauthorized' + '402': + description: Payment Required + content: + application/json: + schema: + $ref: '#/components/schemas/paymentrequired' + '403': + description: Forbidden + content: + application/json: + schema: + $ref: '#/components/schemas/forbidden' + '404': + description: Not Found + content: + application/json: + schema: + $ref: '#/components/schemas/notfound' + '419': + description: Input Field Missing + content: + application/json: + schema: + $ref: '#/components/schemas/inputfieldmissing' + '413': + description: Input Limit Exceeded + content: + application/json: + schema: + $ref: '#/components/schemas/inputlimitexceeded' + '415': + description: Invalid Input + content: + application/json: + schema: + $ref: '#/components/schemas/invalidinput' + '500': + description: Internal Server Error + content: + application/json: + schema: + $ref: '#/components/schemas/servererror' + '504': + description: Gateway Timeout + content: + application/json: + schema: + $ref: '#/components/schemas/gatewaytimeout' + security: + - APIAuthorizer: [] + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/input' + multipart/form-data: + schema: + $ref: '#/components/schemas/input1' +components: + schemas: + success: + type: object + properties: + results: + type: object + example: [{key:value}] + description: list of json objects + properties: + url: + type: string + description: Pre-signed URL to download the csvfile + example: https://storage.googleapis.com/json_csv_stroage/data_file.csv?X-Goog-Algorithm=GOOG4-RSA-SHA256&X-Goog-Credential=sentient-dev-bigquery%40sentient-207310.iam.gserviceaccount.com%2F20200514%2Fauto%2Fstorage%2Fgoog4_request&X-Goog-Date=20200514T062642Z&X-Goog-Expires=6000&X-Goog-SignedHeaders=host&X-Goog-Signature=4141536f1982dfb26a49c8764517a8147db31ed658aabe36715fe253588c073415bc813be245311cd701462da4d9bd8c07bc587127fea062e00eaf1a30db42a932ef458fae561969bf3d8c614d0c10a993590387a9f8587b8ed48925d8ef8eeed2a7e6ba09049a7a466c4d6204feccedb56dd05ea47d0acd8dcd9517c6b94613f69af7bf5dacf68da3911713da781ee81bc5e0821f507a658cab3f4910f4997462c1fdd612940d088d32c07218ab40ccf3b30af752eab47ae715a354aeb5497cc6470d46b0fbb2db49b2f76535f85b99f758162ed46809a206c2760f39c5c72fc084ec007a5444ccb99a0a3466542d673a326b3290ffa5271fbf3348e99f9926" + status: + type: string + example: Success + description: The status of the API call success/failure + message: + type: string + example: Successfully Converted and stored in Google Cloud Storage + description: Detail description on the API status + unauthorized: + type: object + properties: + message: + type: string + example: Missing Authentication Token + status: + type: string + example: Failure + forbidden: + type: object + properties: + message: + type: string + example: Access Denied Unauthorized User + status: + type: string + example: Failure + paymentrequired: + type: object + properties: + message: + type: string + example: Insufficient Credits Kindly Top Up + status: + type: string + example: Failure + notfound: + type: object + properties: + message: + type: string + example: Invalid Request URL + status: + type: string + example: Failure + servererror: + type: object + properties: + message: + type: string + example: Internal Server Error + status: + type: string + example: Failure + gatewaytimeout: + type: object + properties: + message: + type: string + example: Request Timeout + status: + type: string + example: Failure + inputfieldmissing: + type: object + properties: + message: + type: string + example: Input Field Missing + status: + type: string + example: Failure + inputlimitexceeded: + type: object + properties: + message: + type: string + example: Input Limit Exceeded + status: + type: string + example: Failure + invalidinput: + type: object + properties: + message: + type: string + example: Invalid Input + status: + type: string + example: Failure + input1: + type: object + properties: + jsonfile: + type: object + example: [{key:value}] + default: true + description: List of json objects + input: + type: object + properties: + jsonfile: + type: string + format: binary + example: [{key:value}] + default: true + description: List of json objects + versions: + type: object + properties: + v1.0.0: + type: array + items: + oneOf: + - type: string + example: Published Date - May 15, 2020 + description: Initial version release + securitySchemes: + APIAuthorizer: + type: apiKey + name: x-api-key + in: header + x-amazon-apigateway-authtype: custom + description: Authentication is done using the x-api-key in the request header diff --git a/utility/newspaper_article_scraper.yaml b/utility/newspaper_article_scraper.yaml new file mode 100644 index 000000000..dcefbee00 --- /dev/null +++ b/utility/newspaper_article_scraper.yaml @@ -0,0 +1,325 @@ +openapi: 3.0.1 +info: + title: Newspaper Article Scraper + description: |+ + This api allows to extracting & curating articles and delivers Instapaper style article extraction. + + Current supported languages: Arabic, Russian, Dutch, German, English, Spanish, French, Hebrew, Italian, Korean, Norwegian, Persian, Polish, Portuguese, Swedish, Hungarian, Finnish, Danish, Chinese, Indonesian, Vietnamese, Swahili, Turkish, Greek, Ukrainian. Supports automatic languages detection. + + Note that the URL has to be **spelt in full**, including "https://www." + x-additionalinfo: |+ + Suggested Use Cases: + - Can be used in services related to the creation of a real-time web application that gathers data from several newspapers and shows a summary of the different topics that are being discussed in the news articles. + version: '0.1.0' + x-subscribelink: newspaper_article_scraper +servers: + - url: 'https://apis.sentient.io' +tags: +- name: "v0.1.0" + description: "Published Date - Aug 07, 2020" +paths: + /microservices/utility/newsarticle/v0.1/getresults: + post: + tags: + - v0.1.0 + responses: + '200': + description: success response + content: + application/json: + schema: + $ref: '#/components/schemas/success' + example: + content: + all_images: + - https://static.bangkokpost.com/media/content/20170620/2363063.jpg + - https://www.bangkokpost.com/media/content/20170620/c1_1272315_170620160518_620x413.jpg + - https://static.bangkokpost.com/media/content/20170620/2364459.jpg + - https://static.bangkokpost.com/media/content/20170620/2363071.jpg + - https://static.bangkokpost.com/media/content/20170620/2364455.jpg + - https://static.bangkokpost.com/media/content/20170620/2363075.jpg + authors: + - Bangkok Post Public Company Limited + keywords: + - scholarships + - opportunities + - fair + - study + - learning + - worlds + language: en + link: https://www.bangkokpost.com/learning/news/1272315/study-and-work-in-australia-%E2%80%93-many-opportunities-ahead- + publish_date: 2020-09-30T07:11:15 + summary: |- + Australia is a country welcoming international students to study at all levels of education with its quality and the part-time work rights given. + Moreover, there are opportunities to work full-time and to migrate and hold Australian citizenship after graduation from Australia. + Study, Work and Live in one of the World's most liveable countries. + "Post Study Work Rights and Pathways to Australian Permanent + text: |- + Australia is a country welcoming international students to study at all levels of education with its quality and the part-time work rights given. Moreover, there are opportunities to work full-time and to migrate and hold Australian citizenship after graduation from Australia. Especially, engineers, IT specialists and accountants, and many more, are on the list of occupations which Australia is demanding. + + Study, Work and Live in one of the World's most liveable countries. + + Don't miss the chance to interview directly with 40 leading universities and institutions from across Australia. Application fee waivers and scholarships are also available. + + Unique! "Post Study Work Rights and Pathways to Australian Permanent Resident" seminar by Dr. Visa, Australian Registered Migration Agent, and special talks by Andrew Biggs, + title: Study and Work in Australia + top_image: https://www.bangkokpost.com/media/content/20170620/c1_1272315_170620160518_620x413.jpg + video: + - https://www.youtube.com/embed/8I9uQVHluBk + message: Successfully Processed + status: Success + '401': + description: Unauthorized + content: + application/json: + schema: + $ref: '#/components/schemas/unauthorized' + '402': + description: Payment Required + content: + application/json: + schema: + $ref: '#/components/schemas/paymentrequired' + '403': + description: Forbidden + content: + application/json: + schema: + $ref: '#/components/schemas/forbidden' + '404': + description: Not Found + content: + application/json: + schema: + $ref: '#/components/schemas/notfound' + '419': + description: Input Field Missing + content: + application/json: + schema: + $ref: '#/components/schemas/inputfieldmissing' + '413': + description: Input Limit Exceeded + content: + application/json: + schema: + $ref: '#/components/schemas/inputlimitexceeded' + '415': + description: Invalid Input + content: + application/json: + schema: + $ref: '#/components/schemas/invalidinput' + '500': + description: Internal Server Error + content: + application/json: + schema: + $ref: '#/components/schemas/servererror' + '504': + description: Gateway Timeout + content: + application/json: + schema: + $ref: '#/components/schemas/gatewaytimeout' + security: + - APIAuthorizer: [] + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/input' + required: true +components: + schemas: + success: + type: object + properties: + content: + type: object + example: {} + description: The result of the API call + properties: + all_images: + type: array + items: + type: string + example: + - https://static.bangkokpost.com/media/content/20170620/2363063.jpg + - https://www.bangkokpost.com/media/content/20170620/c1_1272315_170620160518_620x413.jpg + - https://static.bangkokpost.com/media/content/20170620/2364459.jpg + - https://static.bangkokpost.com/media/content/20170620/2363071.jpg + - https://static.bangkokpost.com/media/content/20170620/2364455.jpg + - https://static.bangkokpost.com/media/content/20170620/2363075.jpg + description: All images of new article. + authors: + type: array + items: + type: string + example: + - Bangkok Post Public Company Limited + description: Authors of new article. + keywords: + type: array + items: + type: string + example: + - scholarships + - opportunities + - fair + - study + - learning + - worlds + description: NLP processed keywords from news article. + language: + type: string + example: "en" + description: Language of news article. + link: + type: string + example: "https://www.bangkokpost.com/learning/news/1272315/study-and-work-in-australia-%E2%80%93-many-opportunities-ahead-" + description: Main article link url. + publish_date: + type: string + example: 2020-09-30T07:11:15 + description: Published date of news article. + summary: + type: string + example: "Australia is a country welcoming international students to study at all levels of education with its quality and the part-time work rights given.\nMoreover, there are opportunities to work full-time and to migrate and hold Australian citizenship after graduation from Australia.\nStudy, Work and Live in one of the World's most liveable countries.\n\"Post Study Work Rights and Pathways to Australian Permanent" + description: Main content of news article. + text: + type: string + example: "Australia is a country welcoming international students to study at all levels of education with its quality and the part-time work rights given. Moreover, there are opportunities to work full-time and to migrate and hold Australian citizenship after graduation from Australia. Especially, engineers, IT specialists and accountants, and many more, are on the list of occupations which Australia is demanding.\n\nStudy, Work and Live in one of the World's most liveable countries.\n\nDon't miss the chance to interview directly with 40 leading universities and institutions from across Australia. Application fee waivers and scholarships are also available.\n\nUnique! \"Post Study Work Rights and Pathways to Australian Permanent Resident\" seminar by Dr. Visa, Australian Registered Migration Agent, and special talks by Andrew Biggs," + description: Full text content of news article. + title: + type: string + example: "Study and Work in Australia" + description: Title of news article. + top_image: + type: string + example: "https://www.bangkokpost.com/media/content/20170620/c1_1272315_170620160518_620x413.jpg" + description: Published image of news article. + video: + type: array + items: + type: string + example: + - https://www.youtube.com/embed/8I9uQVHluBk + description: All video clips related to news article if available. + message: + type: string + example: Successfully Processed + description: Detail description on the API status + status: + type: string + example: Success + description: The status of the API call success/failure + unauthorized: + type: object + properties: + message: + type: string + example: Missing Authentication Token + status: + type: string + example: Failure + forbidden: + type: object + properties: + message: + type: string + example: Access Denied Unauthorized User + status: + type: string + example: Failure + paymentrequired: + type: object + properties: + message: + type: string + example: Insufficient Credits Kindly Top Up + status: + type: string + example: Failure + notfound: + type: object + properties: + message: + type: string + example: Invalid Request URL + status: + type: string + example: Failure + servererror: + type: object + properties: + message: + type: string + example: Internal Server Error + status: + type: string + example: Failure + gatewaytimeout: + type: object + properties: + message: + type: string + example: Request Timeout + status: + type: string + example: Failure + inputfieldmissing: + type: object + properties: + message: + type: string + example: Input Field Missing + status: + type: string + example: Failure + invalidinput: + type: object + properties: + message: + type: string + example: Invalid Input + status: + type: string + example: Failure + inputlimitexceeded: + type: object + properties: + message: + type: string + example: Input Limit Exceeded + status: + type: string + example: Failure + versions: + type: object + properties: + v0.1.0: + type: array + items: + oneOf: + - type: string + example: Published Date - Aug 07, 2020 + description: Initial version release + input: + type: object + required: + - url + properties: + url: + type: string + example: https://www.bangkokpost.com/learning/news/1272315/study-and-work-in-australia-%E2%80%93-many-opportunities-ahead + default: true + description: The absolute input url, i.e exact, full address (URL) to the page. + securitySchemes: + APIAuthorizer: + type: apiKey + name: x-api-key + in: header + x-amazon-apigateway-authtype: custom + description: Authentication is done using the x-api-key in the request header diff --git a/utility/pdf_extractor.yaml b/utility/pdf_extractor.yaml new file mode 100644 index 000000000..69e7aaf66 --- /dev/null +++ b/utility/pdf_extractor.yaml @@ -0,0 +1,267 @@ +openapi: 3.0.1 +info: + title: PDF Extractor + description: |+ + This Utility microservice extracts the text content of the input PDF document with the options to extract specific pages. + + It also extracts from password-protected PDFs, if the correct password is provided. + + Output format supported: plain text or HTML. + + Supported languages: Hindi, German, Spanish, Portuguese, French, Turkish, Italian, Russian, Arabic, Indonesian, Chinese, Japanese and Korean. + + The size of your PDF file should **not exceed 7 MB**. + x-additionalinfo: |+ + Suggested Use Cases: + - Used for pre/post processing of documents so that the output can paired with another microservice to address a specific solution. For example, text extracted from the PDF document can be used with a Voice microservice such as Text-to-Speech. + + - Can be used for solutions related to processing workflows that are document-heavy so that the user can focus on the more value-added decisions. Documents in a variety of formats can be taken in to return cleanly structured data. Examples included mortgage processing, procurement data etc. + version: '1.0.0' + x-subscribelink: pdf_extractor +servers: + - url: 'https://apis.sentient.io' +tags: +- name: "v1.0.0" + description: "Published Date - Jul 30, 2020" +paths: + /microservices/utility/pdfextractor/v1.0/getresults: + post: + tags: + - v1.0.0 + responses: + '200': + description: success response + content: + application/json: + schema: + $ref: '#/components/schemas/success' + example: + results: "\\n L 328/84 \\n Official Journal of the European Union \\n EN \\n + 18.12.2019 \\n DECISIONS \\n COMMISSION IMPLEMENTING DECISION (EU) 2019/2166 \\n + of 16 December 2019 \\n amending Implementing Decision 2014/908/EU as regards the + inclusion of Serbia and South Korea in \\n the lists of third countries and + \ territories whose supervisory and regulatory requirements" + message: Successfully Processed + status: Success + extracted_details: "[1, 3] pages are Extracted...." + '401': + description: Unauthorized + content: + application/json: + schema: + $ref: '#/components/schemas/unauthorized' + '402': + description: Payment Required + content: + application/json: + schema: + $ref: '#/components/schemas/paymentrequired' + '403': + description: Forbidden + content: + application/json: + schema: + $ref: '#/components/schemas/forbidden' + '404': + description: Not Found + content: + application/json: + schema: + $ref: '#/components/schemas/notfound' + '419': + description: Input Field Missing + content: + application/json: + schema: + $ref: '#/components/schemas/inputfieldmissing' + '413': + description: Input Limit Exceeded + content: + application/json: + schema: + $ref: '#/components/schemas/inputlimitexceeded' + '415': + description: Invalid Input + content: + application/json: + schema: + $ref: '#/components/schemas/invalidinput' + '500': + description: Internal Server Error + content: + application/json: + schema: + $ref: '#/components/schemas/servererror' + '504': + description: Gateway Timeout + content: + application/json: + schema: + $ref: '#/components/schemas/gatewaytimeout' + security: + - APIAuthorizer: [] + requestBody: + content: + multipart/form-data: + schema: + $ref: '#/components/schemas/input' +components: + schemas: + success: + type: object + properties: + results: + type: string + example: \n L 328/84 \n Official Journal of the European Union \n EN \n 18.12.2019 \n DECISIONS \n COMMISSION IMPLEMENTING DECISION (EU) 2019/2166 \n of 16 December 2019 \n amending Implementing Decision 2014/908/EU as regards the inclusion of Serbia and South Korea in \n the lists of third countries and territories whose supervisory and regulatory requirements + description: The result of the API call. + message: + type: string + example: Successfully Processed + description: Detail description on the API status + status: + type: string + example: Success + description: The status of the API call success/failure + extracted_details: + type: string + example: "[1, 3] pages are Extracted...." + description: Extracted page and file details + unauthorized: + type: object + properties: + message: + type: string + example: Missing Authentication Token + status: + type: string + example: Failure + forbidden: + type: object + properties: + message: + type: string + example: Access Denied Unauthorized User + status: + type: string + example: Failure + invalidinput: + type: object + properties: + message: + type: string + example: Invalid Input + status: + type: string + example: Failure + paymentrequired: + type: object + properties: + message: + type: string + example: Insufficient Credits Kindly Top Up + status: + type: string + example: Failure + notfound: + type: object + properties: + message: + type: string + example: Invalid Request URL + status: + type: string + example: Failure + servererror: + type: object + properties: + message: + type: string + example: Internal Server Error + status: + type: string + example: Failure + gatewaytimeout: + type: object + properties: + message: + type: string + example: Request Timeout + status: + type: string + example: Failure + inputfieldmissing: + type: object + properties: + message: + type: string + example: Input Field Missing + status: + type: string + example: Failure + inputlimitexceeded: + type: object + properties: + message: + type: string + example: Input Limit Exceeded + status: + type: string + example: Failure + versions: + type: object + properties: + v1.0.0: + type: array + items: + oneOf: + - type: string + example: Published Date - Jul 30, 2020 + description: Initial version release + input: + type: object + required: + - filePath + properties: + filePath: + type: string + format: binary + default: true + example: sample.pdf + description: Text-only PDF files are supported. Image or mixed PDF files are not recommended. + pageNumbers: + type: number + default: false + example: "1,3,6" + description: Page numbers, example 1,3,6. Default all pages + maxPages: + type: number + default: false + example: "3" + description: Maximum of page number. Default all pages + startPage: + type: number + default: false + example: "1" + description: Starting page number, if used endPage parameter is mandatory + endPage: + type: number + default: false + example: "5" + description: End of page number, if used startPage parameter is mandatory + convertType: + type: string + default: false + example: "txt" + description: Convertion type (txt / html). Default type is txt + passWord: + type: string + default: false + example: "xxxxxxxx" + description: Password for protected pdf + securitySchemes: + APIAuthorizer: + type: apiKey + name: x-api-key + in: header + x-amazon-apigateway-authtype: custom + description: Authentication is done using the x-api-key in the request header diff --git a/utility/pki_key_generator.yaml b/utility/pki_key_generator.yaml new file mode 100644 index 000000000..4bb84d56a --- /dev/null +++ b/utility/pki_key_generator.yaml @@ -0,0 +1,216 @@ +openapi: 3.0.1 +info: + title: PKI Key Generator + description: |+ + This Utiltiy microservice generates Public key and Private key pair, and is useful for encryption purposes. + x-additionalinfo: |+ + Suggested Use Cases: + - This microservice can be used to simplify the deployment, management, and security of one's enterprise PKI with a microservice that helps to automate time-consuming, risky, and error-prone infrastructure tasks, freeing users to focus on higher-value projects. + version: '0.1.0' + x-subscribelink: pki_key_generator +servers: + - url: 'https://apis.sentient.io' +tags: +- name: "v0.1.0" + description: "Published Date - Aug 30, 2019" +paths: + /microservices/utility/rsa_getkeys/v0.1/getresults: + post: + tags: + - v0.1.0 + responses: + '200': + description: success response + content: + application/json: + schema: + $ref: '#/components/schemas/success' + example: + keyLength: 1024 + publicKey: MIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQK... + privateKey: MIICdQIBADANBgkqhkiG9w0BAQEFAASCAl.... + '401': + description: Unauthorized + content: + application/json: + schema: + $ref: '#/components/schemas/unauthorized' + '402': + description: Payment Required + content: + application/json: + schema: + $ref: '#/components/schemas/paymentrequired' + '403': + description: Forbidden + content: + application/json: + schema: + $ref: '#/components/schemas/forbidden' + '404': + description: Not Found + content: + application/json: + schema: + $ref: '#/components/schemas/notfound' + '419': + description: Input Field Missing + content: + application/json: + schema: + $ref: '#/components/schemas/inputfieldmissing' + '413: + description: Input Limit Exceeded + content: + application/json: + schema: + $ref: '#/components/schemas/inputlimitexceeded' + '415': + description: Invalid Input + content: + application/json: + schema: + $ref: '#/components/schemas/invalidinput' + '500': + description: Internal Server Error + content: + application/json: + schema: + $ref: '#/components/schemas/servererror' + '504': + description: Gateway Timeout + content: + application/json: + schema: + $ref: '#/components/schemas/gatewaytimeout' + security: + - APIAuthorizer: [] + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/input' + required: true +components: + schemas: + success: + type: object + properties: + keyLength: + type: string + example: 1024 + description: byte value of generated key + publicKey: + type: string + example: MIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQK... + description: generated public key for encoding the text + privateKey: + type: string + example: MIICdQIBADANBgkqhkiG9w0BAQEFAASCAl.... + description: private key to decoding. this private key should decode when the text encoded by the public key which generate with this only. + unauthorized: + type: object + properties: + message: + type: string + example: Missing Authentication Token + status: + type: string + example: Failure + forbidden: + type: object + properties: + message: + type: string + example: Access Denied Unauthorized User + status: + type: string + example: Failure + paymentrequired: + type: object + properties: + message: + type: string + example: Insufficient Credits Kindly Top Up + status: + type: string + example: Failure + notfound: + type: object + properties: + message: + type: string + example: Invalid Request URL + status: + type: string + example: Failure + servererror: + type: object + properties: + message: + type: string + example: Internal Server Error + status: + type: string + example: Failure + invalidinput: + type: object + properties: + message: + type: string + example: Invalid Input + status: + type: string + example: Failure + gatewaytimeout: + type: object + properties: + message: + type: string + example: Request Timeout + status: + type: string + example: Failure + inputfieldmissing: + type: object + properties: + message: + type: string + example: Input Field Missing + status: + type: string + example: Failure + inputlimitexceeded: + type: object + properties: + message: + type: string + example: Input Limit Exceeded + status: + type: string + example: Failure + versions: + type: object + properties: + v0.1.0: + type: array + items: + oneOf: + - type: string + example: Published Date - Aug 30, 2019 + description: Initial version release + input: + type: object + properties: + bitcode: + type: string + example: "1" + default: true + description: bitcode to generate the key by byte-length. Maximum up to 5. Empty string and above 5 should be consider as 1. + securitySchemes: + APIAuthorizer: + type: apiKey + name: x-api-key + in: header + x-amazon-apigateway-authtype: custom + description: Authentication is done using the x-api-key in the request header diff --git a/utility/urls_retrieval.yaml b/utility/urls_retrieval.yaml new file mode 100644 index 000000000..fe63ae65d --- /dev/null +++ b/utility/urls_retrieval.yaml @@ -0,0 +1,271 @@ +openapi: 3.0.1 +info: + title: URLs Retrieval + description: |+ + This Utility microservice crawls and retrieves content from the input URLs, up to the specified depth. + + Default depth is 0 and maximum number of URLs is 500. + x-additionalinfo: |+ + Suggested Use Cases: + - Use this microservice to update web content or indices of other sites' web content. + version: '0.2.1' + x-subscribelink: urls_retrieval +servers: + - url: 'https://apis.sentient.io' +tags: +- name: "v0.2.1" + description: "Published Date - Dec 04, 2020" +paths: + /microservices/utility/crawlurls/v0/getresults: + post: + tags: + - v0.2.1 + responses: + '200': + description: success response + content: + application/json: + schema: + $ref: '#/components/schemas/success' + example: + message: Successfully Processed + results: + urls: + - https://www.sentient.io/ja/ + - https://www.sentient.io/ja/ai-data + - https://www.sentient.io/ja/ai-colab + - https://www.sentient.io/ja/data-alliance + - https://www.sentient.io/ja/team + - https://www.sentient.io/ja/contact + - https://www.sentient.io/ja + status: Success + '401': + description: Unauthorized + content: + application/json: + schema: + $ref: '#/components/schemas/unauthorized' + '402': + description: Payment Required + content: + application/json: + schema: + $ref: '#/components/schemas/paymentrequired' + '403': + description: Forbidden + content: + application/json: + schema: + $ref: '#/components/schemas/forbidden' + '404': + description: Not Found + content: + application/json: + schema: + $ref: '#/components/schemas/notfound' + '419': + description: Input Field Missing + content: + application/json: + schema: + $ref: '#/components/schemas/inputfieldmissing' + '413': + description: Input Limit Exceeded + content: + application/json: + schema: + $ref: '#/components/schemas/inputlimitexceeded' + '415': + description: Invalid Input + content: + application/json: + schema: + $ref: '#/components/schemas/invalidinput' + '500': + description: Internal Server Error + content: + application/json: + schema: + $ref: '#/components/schemas/servererror' + '504': + description: Gateway Timeout + content: + application/json: + schema: + $ref: '#/components/schemas/gatewaytimeout' + security: + - APIAuthorizer: [] + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/input' + required: true +components: + schemas: + success: + type: object + properties: + message: + type: string + example: Successfully Processed + description: Response message + results: + type: object + example: {} + description: Json Object of returned results + properties: + urls: + type: array + example: [https://www.sentient.io/ja/,https://www.sentient.io/ja/ai-data] + description: Scrapped urls from the webpage. + items: + oneOf: + - type: string + example: https://www.sentient.io/ja/ + - type: string + example: https://www.sentient.io/ja/ai-data + - type: string + example: https://www.sentient.io/ja/ai-colab + - type: string + example: https://www.sentient.io/ja/data-alliance + - type: string + example: https://www.sentient.io/ja/team + - type: string + example: https://www.sentient.io/ja/contact + - type: string + example: https://www.sentient.io/ja + status: + type: string + example: Success + description: API success call. + unauthorized: + type: object + properties: + message: + type: string + example: Missing Authentication Token + status: + type: string + example: Failure + forbidden: + type: object + properties: + message: + type: string + example: Access Denied Unauthorized User + status: + type: string + example: Failure + paymentrequired: + type: object + properties: + message: + type: string + example: Insufficient Credits Kindly Top Up + status: + type: string + example: Failure + invalidinput: + type: object + properties: + message: + type: string + example: Invalid Input + status: + type: string + example: Failure + notfound: + type: object + properties: + message: + type: string + example: Invalid Request URL + status: + type: string + example: Failure + servererror: + type: object + properties: + message: + type: string + example: Internal Server Error + status: + type: string + example: Failure + gatewaytimeout: + type: object + properties: + message: + type: string + example: Request Timeout + status: + type: string + example: Failure + inputfieldmissing: + type: object + properties: + message: + type: string + example: Input Field Missing + status: + type: string + example: Failure + inputlimitexceeded: + type: object + properties: + message: + type: string + example: Input Limit Exceeded + status: + type: string + example: Failure + versions: + type: object + properties: + v0.2.1: + type: array + items: + oneOf: + - type: string + example: Published Date - Dec 04, 2020 + description: Patch Update + v0.2.0: + type: array + items: + oneOf: + - type: string + example: Published Date - Oct 30, 2020 + description: Partial URL support + v0.1.0: + type: array + items: + oneOf: + - type: string + example: Published Date - Sep 1, 2020 + description: Initial version release + input: + type: object + properties: + url: + type: string + default: true + example: https://www.sentient.io/ja/ + description: url + depth: + type: integer + example: "2" + default: false + description: Default is 0. + numberofurls: + type: integer + example: "10" + default: false + description: Default value is 100. + securitySchemes: + APIAuthorizer: + type: apiKey + name: x-api-key + in: header + x-amazon-apigateway-authtype: custom + description: Authentication is done using the x-api-key in the request header diff --git a/utility/video-to-audio_convertor.yaml b/utility/video-to-audio_convertor.yaml new file mode 100644 index 000000000..febe39416 --- /dev/null +++ b/utility/video-to-audio_convertor.yaml @@ -0,0 +1,239 @@ +openapi: 3.0.1 +info: + title: Video-To-Audio Converter + description: |+ + This API is used to extract the sound from a video file and save it in an audio file. + + The size of your video file should **not exceed 3.5 MB**. + version: '0.1.0' + x-additionalinfo: |+ + Suggested Use Cases: + - For building applications that extracts audio from videos in batches. Users can further pipe the audio into microservices involving ASR for further transciption. + x-subscribelink: video-to-audio_convertor +servers: + - url: 'https://apis.sentient.io' +tags: +- name: "v0.1.0" + description: "Published Date - Mar 06, 2020" +paths: + /microservices/utility/videotoaudio/v0.1/getresults: + post: + tags: + - v0.1.0 + responses: + '200': + description: success response + content: + application/json: + schema: + $ref: '#/components/schemas/success' + example: + results: + AudioContent: UklGRoboDgBXQVZFZm10IBAAAAABAAEAgD4AAAB9AAACABAATElTVBoAAABJTkZPSVNGVA4AAABMYXZmNTguMjAuMTAwAGRhdGFA6A4AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA.... + message: Successfully Processed + status: Success + '401': + description: Unauthorized + content: + application/json: + schema: + $ref: '#/components/schemas/unauthorized' + '402': + description: Payment Required + content: + application/json: + schema: + $ref: '#/components/schemas/paymentrequired' + '403': + description: Forbidden + content: + application/json: + schema: + $ref: '#/components/schemas/forbidden' + '404': + description: Not Found + content: + application/json: + schema: + $ref: '#/components/schemas/notfound' + '419': + description: Input Field Missing + content: + application/json: + schema: + $ref: '#/components/schemas/inputfieldmissing' + '413': + description: Input Limit Exceeded + content: + application/json: + schema: + $ref: '#/components/schemas/inputlimitexceeded' + '415': + description: Invalid Input + content: + application/json: + schema: + $ref: '#/components/schemas/invalidinput' + '500': + description: Internal Server Error + content: + application/json: + schema: + $ref: '#/components/schemas/servererror' + '504': + description: Gateway Timeout + content: + application/json: + schema: + $ref: '#/components/schemas/gatewaytimeout' + security: + - APIAuthorizer: [] + requestBody: + description: Input parameters

FieldType Description
filePathFileRequired. The file object
Maximum file size up to - 3.5MB
samplerateStringOptional. Sample rate of the audio file in Hz
channelStringOptional. Indicates the type of audio channel. Value must be 1 for mono or 2 for Stereo. Default is 2(Stereo)


+ content: + multipart/form-data: + schema: + $ref: '#/components/schemas/input' + # required: true +components: + schemas: + success: + type: object + properties: + results: + type: object + example: { "" } + description: Json Object of returned results + properties: + AudioContent: + type: string + description: Audio file converted to base64 encoded string. + example: UklGRoboDgBXQVZFZm10IBAAAAABAAEAgD4AAAB9AAACABAATElTVBoAAABJTkZPSVNGVA4AAABMYXZmNTguMjAuMTAwAGRhdGFA6A4AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA.... + message: + type: string + example: Successfully Processed + description: Detail description on the API status + status: + type: string + example: Success + description: The status of the API call success/failure + unauthorized: + type: object + properties: + message: + type: string + example: Missing Authentication Token + status: + type: string + example: Failure + forbidden: + type: object + properties: + message: + type: string + example: Access Denied Unauthorized User + status: + type: string + example: Failure + paymentrequired: + type: object + properties: + message: + type: string + example: Insufficient Credits Kindly Top Up + status: + type: string + example: Failure + notfound: + type: object + properties: + message: + type: string + example: Invalid Request URL + status: + type: string + example: Failure + servererror: + type: object + properties: + message: + type: string + example: Internal Server Error + status: + type: string + example: Failure + gatewaytimeout: + type: object + properties: + message: + type: string + example: Request Timeout + status: + type: string + example: Failure + inputfieldmissing: + type: object + properties: + message: + type: string + example: Input Field Missing + status: + type: string + example: Failure + invalidinput: + type: object + properties: + message: + type: string + example: Invalid Input + status: + type: string + example: Failure + inputlimitexceeded: + type: object + properties: + message: + type: string + example: Input Limit Exceeded + status: + type: string + example: Failure + input: + type: object + required: + - filePath + properties: + filePath: + type: string + format: binary + example: sample.mp4 + default: true + description: The file object. + Supported formats: 3g2, avi, flv, mkv, mov, mp4, ogv, webm, wmv, m4v. + samplerate: + type: string + example: "16000" + default: false + description: Sample rate of the audio file in Hz. That there is no set Hz range. Note that decimals and negative values are not supported. + channel: + type: string + example: "1" + default: false + description: Indicates the type of audio channel. Value must be 1 for mono or 2 for Stereo. Default is 2(Stereo) + versions: + type: object + properties: + v0.1.0: + type: array + items: + oneOf: + - type: string + example: Published Date - Mar 06, 2020 + description: Initial version release + securitySchemes: + APIAuthorizer: + type: apiKey + name: x-api-key + in: header + x-amazon-apigateway-authtype: custom + description: Authentication is done using the x-api-key in the request header diff --git a/utility/video-to-image_convertor.yaml b/utility/video-to-image_convertor.yaml new file mode 100644 index 000000000..bb2b996ee --- /dev/null +++ b/utility/video-to-image_convertor.yaml @@ -0,0 +1,240 @@ +openapi: 3.0.1 +info: + title: Video-to-Image Convertor + description: |+ + This Utility microservice captures the images from the input video file at the frame rate of 1 frame per second. + + Supported formats are : 3g2, avi, flv, mkv, mov, mp4, ogv, webm, wmv, m4v with H.264 codec encoded. + x-additionalinfo: |+ + Suggested Use Cases: + - Can be integrated into video editing software to create a quick preview of the footage the user is editing. + version: '0.1.0' + x-subscribelink: video-to-image_convertor +servers: + - url: 'https://apis.sentient.io' +tags: +- name: "v0.1.0" + description: "Published Date - Aug 07, 2020" +paths: + /microservices/utility/videotoimage/v0.1/getresults: + post: + tags: + - v0.1.0 + responses: + '200': + description: success response + content: + application/json: + schema: + $ref: '#/components/schemas/success' + example: + results: + fileContent: document text content + message: Successfully Processed + status: Success + '401': + description: Unauthorized + content: + application/json: + schema: + $ref: '#/components/schemas/unauthorized' + '402': + description: Payment Required + content: + application/json: + schema: + $ref: '#/components/schemas/paymentrequired' + '403': + description: Forbidden + content: + application/json: + schema: + $ref: '#/components/schemas/forbidden' + '404': + description: Not Found + content: + application/json: + schema: + $ref: '#/components/schemas/notfound' + '419': + description: Input Field Missing + content: + application/json: + schema: + $ref: '#/components/schemas/inputfieldmissing' + '413': + description: Input Limit Exceeded + content: + application/json: + schema: + $ref: '#/components/schemas/inputlimitexceeded' + '415': + description: Invalid Input + content: + application/json: + schema: + $ref: '#/components/schemas/invalidinput' + '500': + description: Internal Server Error + content: + application/json: + schema: + $ref: '#/components/schemas/servererror' + '504': + description: Gateway Timeout + content: + application/json: + schema: + $ref: '#/components/schemas/gatewaytimeout' + '406': + description: Not Acceptable + content: + application/json: + schema: + $ref: '#/components/schemas/notaccceptable' + security: + - APIAuthorizer: [] + requestBody: + content: + multipart/form-data: + schema: + $ref: '#/components/schemas/input' + # required: true +components: + schemas: + success: + type: object + properties: + results: + type: object + description: The result of the API call. + example: + fileContent: document text content + message: + type: string + example: Successfully Processed + description: Detail description on the API status + status: + type: string + example: Success + description: The status of the API call success/failure + unauthorized: + type: object + properties: + message: + type: string + example: Missing Authentication Token + status: + type: string + example: Failure + forbidden: + type: object + properties: + message: + type: string + example: Access Denied Unauthorized User + status: + type: string + example: Failure + paymentrequired: + type: object + properties: + message: + type: string + example: Insufficient Credits Kindly Top Up + status: + type: string + example: Failure + notfound: + type: object + properties: + message: + type: string + example: Invalid Request URL + status: + type: string + example: Failure + invalidinput: + type: object + properties: + message: + type: string + example: Invalid Input + status: + type: string + example: Failure + servererror: + type: object + properties: + message: + type: string + example: Internal Server Error + status: + type: string + example: Failure + gatewaytimeout: + type: object + properties: + message: + type: string + example: Request Timeout + status: + type: string + example: Failure + inputfieldmissing: + type: object + properties: + message: + type: string + example: Input Field Missing + status: + type: string + example: Failure + inputlimitexceeded: + type: object + properties: + message: + type: string + example: Input Limit Exceeded + status: + type: string + example: Failure + notaccceptable: + type: object + properties: + message: + type: string + example: Unable to Convert, Video is Encoded Using Non-H.264 Codec + status: + type: string + example: Failure + versions: + type: object + properties: + v0.1.0: + type: array + items: + oneOf: + - type: string + example: Published Date - Aug 07, 2020 + description: Initial version release + input: + type: object + required: + - filePath + properties: + filePath: + type: string + format: binary + default: true + example: sample.mp4 + description: The Video file object. + + Supported formats are : 3g2, avi, flv, mkv, mov, mp4, ogv, webm, wmv, m4v with H.264 codec encoded. + securitySchemes: + APIAuthorizer: + type: apiKey + name: x-api-key + in: header + x-amazon-apigateway-authtype: custom + description: Authentication is done using the x-api-key in the request header diff --git a/utility/web_scraper.yaml b/utility/web_scraper.yaml new file mode 100644 index 000000000..565429bdb --- /dev/null +++ b/utility/web_scraper.yaml @@ -0,0 +1,393 @@ +openapi: 3.0.1 +info: + title: Web Scraper + x-subscribelink: web_scraper + description: |+ + This API is used to extract content or specific HTML elements from web pages. Supports both HTML and Text output. The web scraper can be instructed to extract HTML elements that match the criteria given in the queryList HTTP request parameter, it can even do navigate down the html tree like get all p tag inside a div class "class":"class_name p". + x-additionalinfo: |+ + x-additionalinfo: |+ + Suggested Use Cases: + - Can be used for contact scraping, and as a component of applications used for web indexing, web mining and data mining, online price change monitoring and price comparison, product review scraping (to watch the competition), gathering real estate listings, weather data monitoring, website change detection, research, tracking online presence and reputation, web mashup and, web data integration. + + Examples: + + To get article content, as text + {"url":<URL>} + + Returns all element text matches the tag name: + {"url":<URL>, queryList:[{"title":,"findType":"find_all","tag":"h1"}]}

Few queryList Examples: + + Returns all Html matches the tag name: + queryList:[{"title":,"findType":"find_all","tag":"h1", "returnType":"html"}] + + Returns all Image Links: + queryList:[{"title":,"findType":"find_all","tag":"img", "attribute":"src"}] + + Returns all Links(URL's): + queryList:[{"title":,"findType":"find_all","tag":"a", "attribute":"href"}] + + Returns all links/text/html/images matches the class name: + queryList:[{"findType":"find_all", "class":,"tag":"a", "attribute":"href"}],{"findType":"find_all", "class":, "tag":"a"},{"findType":"find_all", "class":, "tag":"a", "returnType":"html"},{"findType":"find_all", "class":, "tag":"img", "attribute":"src"}] + + Using select in findType, either class/tag/id/nestedClassId is mandatory: + queryList:[{"findType":"select", "class_":, "tag":}] + queryList:[{"findType":"select", "class_":}] + queryList:[{"findType":"select", "tag":}] + queryList:[{"findType":"select", "id":, "tag":}] + queryList:[{"findType":"select", "id":}] + queryList:[{"findType":"select", "tag":}] + queryList:[{"findType":"select", "nestedClassId":}] + queryList:[{"findType":"select", "nestedClassId":, "returnType":"html"}] + queryList:[{"findType":"select", "nestedClassId":, "attribute":"href"}] + Example using nestedClassId:
<div>
   <h1>This is heading</h1>>
   <p class="strikeout">This is paragraph 1</h1>>
   <p class="strikeout">This is paragraph 2</h1>>
   <p class="strikeout">This is paragraph 3</h1>>
</div>
<div id="div2" class="divclass2">
   <h1>This is another heading 2</h1>>
   <p class="strikeout">This is paragraph 4</p>
   <p class="strikeout">This is paragraph 5</p>
   <p class="strikeout">This is paragraph 6</p>
   <ul>
      <li><a href="      <li class="class3"><a href="      <li><a href="   </ul>
</div>

To get tags that match one or more class names
   "queryList":[{"findType":"select", "nestedClassId":"p.strikeout"}] + To get h1 tags that match one or more class names +    "queryList":[{"findType":"select", "nestedClassId":"h1"}] + To get all p tags that matches element id +    "queryList":[{"findType":"select", "nestedClassId":"div#div2 p"}] + To get all litags that matches the element id
   "queryList":[{"findType":"select", "nestedClassId":"div#div2 ul li"}]
To get links from ul list +    "queryList":[{"findType":"select", "nestedClassId":"ul li a"}] + To get links from ul list that matches one or more class names
   "queryList":[{"findType":"select", "nestedClassId":"ul li.class3 a"}] + To get links a element that matches the element id and class name
   "queryList":[{"findType":"select", "nestedClassId":"div#div2 ul li.class3 a"}] + + Notes: + title - is an optional parameter, if title is empty the return json key is "values"
findType - find/find_all/select +    • find - returns first matching possibility
   • find_all - returns all matching possibilities +    • select - If you want to search for tags that match two or more CSS classes. either nestedClassId is mandatory + **returnType is not supported with attribute. + + The results are returned in JSON format and allow for developers to rapidly retrieve website elements like tables, images, etc. from URL + version: '1.1.1' +servers: + - url: 'https://apis.sentient.io' +tags: +- name: "v1.1.1" + description: "Published Date - Dec 04, 2020" +paths: + /microservices/utility/webscraping/v1/getresults: + post: + tags: + - v1.1.1 + responses: + '200': + description: success response + content: + application/json: + schema: + $ref: '#/components/schemas/success' + example: + message: Successfully Processed + results: + data: |- + BBC - HomeBBC HomepageSkip to contentAccessibility Helpsign-inBBC AccountHomeNewsSportReelWorklifeTravelFutureCultureMenuMorecaret-downsearchSearchHomeNewsSportReelWorklifeTravelFutureCultureMusicTVWeatherSoundsnoClose menuWelcome to the BBCBBC HomepagePM warns virus deaths could be 'twice as bad' as springAttributionUKPrince William 'contracted Covid-19 in April'AttributionUKWhich Strictly celeb is the first to leave?AttributionBBC OneMore top storiesBale heads winner to send Spurs secondAttributionFootballWho's ahead in the polls - Trump or Biden?AttributionUS Election 2020Five alternatives to saving money with the bankAttributionBBC ScotlandCoronavirus pandemicnextSpain's funeral homes strike as virus cases riseAttributionEuropeHow many coronavirus cases are there in your area?AttributionUKPolice battle to break up 700-strong illegal raveAttributionEnglandNews headlinesnextScotland's new regional Covid restrictions go liveAttributionScotlandBiden and Trump criss-cross the US as vote nearsAttributionUS Election 2020Veteran journalist Robert Fisk dies aged 74AttributionMiddle EastSport headlinesnextPogba says he made 'stupid mistake'AttributionMan Utd'I don't know the direction Man Utd are going' - MOTD2 analysis. Video'I don't know the direction Man Utd are going' - MOTD2 analysisAttributionMan UtdplayMan City win FA Cup after extra timeAttributionWomen's FootballUS Election 2020nextUS election: Trump is in the fight of his political lifeAttributionUS Election 2020The Asians who want Trump to win re-electionAttributionAsiaThe 750,000 people you didn't know could voteAttributionUS Election 2020Around the UKnextScotland's new regional Covid restrictions go liveAttributionScotlandFollow rules plea ahead of post-lockdown exit planAttributionWalesEight more coronavirus-related deaths in NIAttributionNorthern IrelandThe BBC around the UKScotlandALBAWalesCymruNI3 things we love todayYour pictures on the theme of 'urban living'AttributionIn PicturesCan you guess the celebrity childhood photo?AttributionBBC BitesizeThis Celtic rainforest has the calm vibes we all need. VideoThis Celtic rainforest has the calm vibes we all needAttributionBBC TwoplayPlant powerPlant power, Should you swap that beef burger for a vegan version?Should you swap that beef burger for a vegan version?Watch what might happen if the entire world switched to a plant-based dietAttributionBBC IdeasEntertainment news'This is one of my films of the year'AttributionBBC Radio 5 LiveBill surprises fans with nimble feet (and an elephant)AttributionBBC OneSean Connery's greatest moments on screen - in picturesAttributionEntertainment & ArtsSocietyCouple trolled for intimate wedding photoshootAttributionIndia'I raise £2,000 a month to keep my daughter alive'AttributionEngland'Collaborative effort' needed to help gay players come outAttributionEnglandOur Planet NownextThe BBC’s ongoing focus on the environment and the challenges facing our planetYou've got cheap data, how about cheap power too?Publishedduration2 days agoAttributionScience & EnvironmentThe Repair Shop's Jay Blades: 'Make do and mend' for the planet. Video, 00:03:15The Repair Shop's Jay Blades: 'Make do and mend' for the planetPublishedduration2 days agoplay3:15'You could see avocados growing in Hackney' Video, 00:01:04'You could see avocados growing in Hackney'Publishedduration3 days agoAttributionLondonplay1:04Real-life storiesSteph McGovern on 'toning it down' for TV, Trump and pregnancy. AudioSteph McGovern on 'toning it down' for TV, Trump and pregnancyAttributionBBC Radio 4listen'Nobody would help me until Keanu Reeves turned up!' Video'Nobody would help me until Keanu Reeves turned up!'AttributionBBC OneplayDoctor duped into buying 'Aladdin's lamp' for $41,600AttributionIndiaYou might have missedA magical underwater moment captured on film. VideoA magical underwater moment captured on filmAttributionBBC TwoplayHouse prices climb to record high, says NationwideAttributionBusinessCornwall Poldark house fallen into 'complete disrepair'AttributionEnglandFoodnextPerfect pot-roasts with minimum effortAttributionBBC FoodA super-speedy version of a takeaway classicAttributionBBC FoodHealthy winter warmers to keep you full for longerAttributionBBC FoodLifestyleThree tips to help you through redundancy. VideoThree tips to help you through redundancyAttributionBBC IdeasplayGet your ramble on with Countryfile's top hiking tipsAttributionBBC Children in NeedAwesome autumn activities for younger kidsAttributionTiny Happy PeopleThis week in sportWilder questions Fury gloves in rematchAttributionBoxingTributes after ex-Hearts captain Zaliukas dies aged 36AttributionFootballVerstappen sorry for offensive language during + Portuguese GPAttributionFormula 1Behind the headlinesCharlie Hebdo attack suspect tests positive for Covid-19AttributionEuropeBerlin's new €6bn airport opens... 10 years late. VideoBerlin's new €6bn airport opens... 10 years lateAttributionWorldplayNew York man plunges into rat-infested sinkholeAttributionUS & CanadaTime well spentSam Smith's track-by-track guide to their new album. AudioSam Smith's track-by-track guide to their new albumAttributionBBC Radio 1listenRap Game star shares his Black History Month picksAttributionBBC ThreeThese eerie stories might just keep you awake at nightAttributionBBC Radio 4Modern Slavery StatementRead moreThe BBC around the UKScotlandALBAWalesCymruNIOther servicesComplaintsUS Election 2020A really simple guide to the electionAttributionBBC NewsDisinformation: How to spot it. iPlayerDisinformation: How to spot itAttributionBBC iPlayeriplayerWho do you think will win?AttributionBBC NewsOdd happenings from past US electionsAttributionBBC BitesizeHomeNewsSportReelWorklifeTravelFutureCultureMusicTVWeatherSoundsTerms of UseAbout the BBCPrivacy PolicyCookiesAccessibility HelpParental GuidanceContact the BBCGet Personalised NewslettersWhy you can trust the BBCAdvertise with usAdChoices / Do Not Sell My Info© 2020 BBC. The BBC is not responsible for the content of external sites. Read about our approach to external linking. + dataList: + - imagelinks: + - https://ichef.bbci.co.uk/images/ic/240x135/p08x3gpx.jpg + - https://ichef.bbci.co.uk/curationkit-ichef/240x135/cpsprodpb/16FC3/production/_115174149_063942058.jpg + - https://ichef.bbci.co.uk/images/ic/240x135/p08x2qxp.jpg + - https://ichef.bbci.co.uk/images/ic/240x135/p08x39pc.jpg + - https://ichef.bbci.co.uk/images/ic/240x135/p08wsqty.jpg + - https://ichef.bbci.co.uk/images/ic/240x135/p08vchc7.jpg + status: Success + '400': + description: Restricted + content: + application/json: + schema: + $ref: '#/components/schemas/restricted' + '401': + description: Unauthorized + content: + application/json: + schema: + $ref: '#/components/schemas/unauthorized' + '402': + description: Payment Required + content: + application/json: + schema: + $ref: '#/components/schemas/paymentrequired' + '403': + description: Forbidden + content: + application/json: + schema: + $ref: '#/components/schemas/forbidden' + '404': + description: Not Found + content: + application/json: + schema: + $ref: '#/components/schemas/notfound' + '419': + description: Input Field Missing + content: + application/json: + schema: + $ref: '#/components/schemas/inputfieldmissing' + '413': + description: Input Limit Exceeded + content: + application/json: + schema: + $ref: '#/components/schemas/inputlimitexceeded' + '415': + description: Invalid Input + content: + application/json: + schema: + $ref: '#/components/schemas/invalidinput' + '500': + description: Internal Server Error + content: + application/json: + schema: + $ref: '#/components/schemas/servererror' + '504': + description: Gateway Timeout + content: + application/json: + schema: + $ref: '#/components/schemas/gatewaytimeout' + security: + - APIAuthorizer: [] + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/input' + required: true +components: + schemas: + success: + type: object + properties: + message: + type: string + example: successfully processed + description: Detail description on the API status + status: + type: string + example: success + description: The status of the API call success/failure + results: + type: object + example: {"data":"text content of the webpage","dataList": [{ "title": "imagelinks", "findType": "find_all", "tag": "img", "attribute": "src" }]} + description: Json Object of returned results + properties: + data: + type: string + example: "BBC - HomeBBC HomepageSkip to contentAccessibility Helpsign-inBBC AccountHomeNewsSportReelWorklifeTravelFutureCultureMenuMorecaret-downsearchSearchHomeNewsSportReelWorklifeTravelFutureCultureMusicTVWeatherSoundsnoClose menuWelcome to the BBCBBC HomepagePM warns virus deaths could be 'twice as bad' as springAttributionUKPrince William 'contracted Covid-19 in April'AttributionUKWhich Strictly celeb is the first to leave?AttributionBBC OneMore top storiesBale heads winner to send Spurs secondAttributionFootballWho's ahead in the polls - Trump or Biden?AttributionUS Election 2020Five alternatives to saving money with the bankAttributionBBC ScotlandCoronavirus pandemicnextSpain's funeral homes strike as virus cases riseAttributionEuropeHow many coronavirus cases are there in your area?AttributionUKPolice battle to break up 700-strong illegal raveAttributionEnglandNews headlinesnextScotland's new regional Covid restrictions go liveAttributionScotlandBiden and Trump criss-cross the US as vote nearsAttributionUS Election 2020Veteran journalist Robert Fisk dies aged 74AttributionMiddle EastSport headlinesnextPogba says he made 'stupid mistake'AttributionMan Utd'I don't know the direction Man Utd are going' - MOTD2 analysis. Video'I don't know the direction Man Utd are going' - MOTD2 analysisAttributionMan UtdplayMan City win FA Cup after extra timeAttributionWomen's FootballUS Election 2020nextUS election: Trump is in the fight of his political lifeAttributionUS Election 2020The Asians who want Trump to win re-electionAttributionAsiaThe 750,000 people you didn't know could voteAttributionUS Election 2020Around the UKnextScotland's new regional Covid restrictions go liveAttributionScotlandFollow rules plea ahead of post-lockdown exit planAttributionWalesEight more coronavirus-related deaths in NIAttributionNorthern IrelandThe BBC around the UKScotlandALBAWalesCymruNI3 things we love todayYour pictures on the theme of 'urban living'AttributionIn PicturesCan you guess the celebrity childhood photo?AttributionBBC BitesizeThis Celtic rainforest has the calm vibes we all need. VideoThis Celtic rainforest has the calm vibes we all needAttributionBBC TwoplayPlant powerPlant power, Should you swap that beef burger for a vegan version?Should you swap that beef burger for a vegan version?Watch what might happen if the entire world switched to a plant-based dietAttributionBBC IdeasEntertainment news'This is one of my films of the year'AttributionBBC Radio 5 LiveBill surprises fans with nimble feet (and an elephant)AttributionBBC OneSean Connery's greatest moments on screen - in picturesAttributionEntertainment & ArtsSocietyCouple trolled for intimate wedding photoshootAttributionIndia'I raise £2,000 a month to keep my daughter alive'AttributionEngland'Collaborative effort' needed to help gay players come outAttributionEnglandOur Planet NownextThe BBC’s ongoing focus on the environment and the challenges facing our planetYou've got cheap data, how about cheap power too?Publishedduration2 days agoAttributionScience & EnvironmentThe Repair Shop's Jay Blades: 'Make do and mend' for the planet. Video, 00:03:15The Repair Shop's Jay Blades: 'Make do and mend' for the planetPublishedduration2 days agoplay3:15'You could see avocados growing in Hackney' Video, 00:01:04'You could see avocados growing in Hackney'Publishedduration3 days agoAttributionLondonplay1:04Real-life storiesSteph McGovern on 'toning it down' for TV, Trump and pregnancy. AudioSteph McGovern on 'toning it down' for TV, Trump and pregnancyAttributionBBC Radio 4listen'Nobody would help me until Keanu Reeves turned up!' Video'Nobody would help me until Keanu Reeves turned up!'AttributionBBC OneplayDoctor duped into buying 'Aladdin's lamp' for $41,600AttributionIndiaYou might have missedA magical underwater moment captured on film. VideoA magical underwater moment captured on filmAttributionBBC TwoplayHouse prices climb to record high, says NationwideAttributionBusinessCornwall Poldark house fallen into 'complete disrepair'AttributionEnglandFoodnextPerfect pot-roasts with minimum effortAttributionBBC FoodA super-speedy version of a takeaway classicAttributionBBC FoodHealthy winter warmers to keep you full for longerAttributionBBC FoodLifestyleThree tips to help you through redundancy. VideoThree tips to help you through redundancyAttributionBBC IdeasplayGet your ramble on with Countryfile's top hiking tipsAttributionBBC Children in NeedAwesome autumn activities for younger kidsAttributionTiny Happy PeopleThis week in sportWilder questions Fury gloves in rematchAttributionBoxingTributes after ex-Hearts captain Zaliukas dies aged 36AttributionFootballVerstappen sorry for offensive language during\nPortuguese GPAttributionFormula 1Behind the headlinesCharlie Hebdo attack suspect tests positive for Covid-19AttributionEuropeBerlin's new €6bn airport opens... 10 years late. VideoBerlin's new €6bn airport opens... 10 years lateAttributionWorldplayNew York man plunges into rat-infested sinkholeAttributionUS & CanadaTime well spentSam Smith's track-by-track guide to their new album. AudioSam Smith's track-by-track guide to their new albumAttributionBBC Radio 1listenRap Game star shares his Black History Month picksAttributionBBC ThreeThese eerie stories might just keep you awake at nightAttributionBBC Radio 4Modern Slavery StatementRead moreThe BBC around the UKScotlandALBAWalesCymruNIOther servicesComplaintsUS Election 2020A really simple guide to the electionAttributionBBC NewsDisinformation: How to spot it. iPlayerDisinformation: How to spot itAttributionBBC iPlayeriplayerWho do you think will win?AttributionBBC NewsOdd happenings from past US electionsAttributionBBC BitesizeHomeNewsSportReelWorklifeTravelFutureCultureMusicTVWeatherSoundsTerms of UseAbout the BBCPrivacy PolicyCookiesAccessibility HelpParental GuidanceContact the BBCGet Personalised NewslettersWhy you can trust the BBCAdvertise with usAdChoices / Do Not Sell My Info© 2020 BBC. The BBC is not responsible for the content of external sites. Read about our approach to external linking." + description: Text content of the webpage. + dataList: + type: array + example: [{"imagelinks": ["https://ichef.bbci.co.uk/images/ic/240x135/p08x3gpx.jpg","https://ichef.bbci.co.uk/curationkit-ichef/240x135/cpsprodpb/16FC3/production/_115174149_063942058.jpg","https://ichef.bbci.co.uk/images/ic/240x135/p08x2qxp.jpg","https://ichef.bbci.co.uk/images/ic/240x135/p08x39pc.jpg","https://ichef.bbci.co.uk/images/ic/240x135/p08wsqty.jpg","https://ichef.bbci.co.uk/images/ic/240x135/p08vchc7.jpg"]}] + description: Extracted results of queryList in a list format. + unauthorized: + type: object + properties: + message: + type: string + example: Missing Authentication Token + status: + type: string + example: Failure + restricted: + type: object + properties: + message: + type: string + example: The content is restricted + status: + type: string + example: Failure + forbidden: + type: object + properties: + message: + type: string + example: Access Denied Unauthorized User + status: + type: string + example: Failure + paymentrequired: + type: object + properties: + message: + type: string + example: Insufficient Credits Kindly Top Up + status: + type: string + example: Failure + notfound: + type: object + properties: + message: + type: string + example: Invalid Request + status: + type: string + example: Failure + invalidinput: + type: object + properties: + message: + type: string + example: Invalid Input + status: + type: string + example: Failure + servererror: + type: object + properties: + message: + type: string + example: Internal Server Error + status: + type: string + example: Failure + gatewaytimeout: + type: object + properties: + message: + type: string + example: Request Timeout + status: + type: string + example: Failure + inputfieldmissing: + type: object + properties: + message: + type: string + example: Input Field Missing + status: + type: string + example: Failure + inputlimitexceeded: + type: object + properties: + message: + type: string + example: Input Limit Exceeded + status: + type: string + example: Failure + versions: + type: object + properties: + v1.1.1: + type: array + items: + oneOf: + - type: string + example: Published Date - Dec 04, 2020 + description: Patch Update + v1.1.0: + type: array + items: + oneOf: + - type: string + example: Published Date - Oct 30, 2020 + description: Partial URL support + v1.0.0: + type: array + items: + oneOf: + - type: string + example: Published Date - Jul 03, 2020 + description: Improvised search filters using queryList, now you can even navigate down the html tree like get all p tag inside a div class "class":"class_name p" + v0.1.0: + type: array + items: + oneOf: + - type: string + example: Published Date - Jul 18, 2018 + description: Initial version release + input: + type: object + properties: + url: + type: string + default: true + example: https://www.bbc.co.uk + description: Webpage URL. It also support partial URL like bbc.co.uk + queryList: + type: array + default: false + example: [{"title":,"findType":"find_all","tag":"h1", "returnType":"html"}] + description: List of extraction conditions. + items: + oneOf: + - type: object + properties: + findType: + x-name: findType + type: string + default: false + example: |+ + find_all + description: |+ + Extraction Type. Possible values are: + 1. find - returns the first matching possibility + 2. find_all - returns the all matching possibility + 3. select - If you want to search for tags that match two or more CSS classes. either nestedClassId is mandatory + tag: + x-name: tag + type: string + default: false + example: h1 + description: |+ + The HTML tag to extract + id: + x-name: id + type: string + default: false + example: sampleid + description: |+ + The HTML element id to extract + class: + x-name: class + type: string + default: false + example: sampleclass + description: |+ + The HTML element classname to extract + nestedClassId: + x-name: nestedclassid + type: string + default: false + example: p.strikeout + description: |+ + The nested HTML tags. Example: p.strikeout - looks for those matching "strikeout" classname inside the "p" element. + Add additional nesting elments using .(dot) to concatenate + attribute: + x-name: attribute + type: string + default: false + example: src + description: |+ + The HTML element attribute to extract, supported only with tag/id/class/nestedClassId + title: + x-name: title + type: string + default: false + example: mytitle + description: |+ + The key value of the extracted result. By default, the return json key is "values". + returnType: + x-name: returnType + type: string + default: false + example: html + description: |+ + Optional input parameter. If no input parameter is specified, the default return type would be text. + Use “html” to set return type to HTML format + + securitySchemes: + APIAuthorizer: + type: apiKey + name: x-api-key + in: header + x-amazon-apigateway-authtype: custom + description: Authentication is done using the x-api-key in the request header diff --git a/utility/wikipedia_retrieval.yaml b/utility/wikipedia_retrieval.yaml new file mode 100644 index 000000000..4e8891646 --- /dev/null +++ b/utility/wikipedia_retrieval.yaml @@ -0,0 +1,314 @@ +openapi: 3.0.1 +info: + title: Wikipedia Retrieval + description: |+ + It is an API that provides the user with a Wikipedia article based on the input keyword. Refer to this link for the full list of Wikipedias - https://meta.wikimedia.org/wiki/List_of_Wikipedias + x-additionalinfo: |+ + Suggested Use Cases: + - Access topics within Wikipedia with great specificity. Can be used for research/study-related solutions by using information from this microservice to compare articles, revisions and more. + + - Extract the most relevant content from Wikipedia’s categories to provide a text analysis service to ascertain what any text is in reference to. + version: '0.1.0' + x-subscribelink: wikipedia_retrieval +servers: + - url: 'https://apis.sentient.io' +tags: +- name: "v0.1.0" + description: "Published Date - Apr 23, 2020" +paths: + /microservices/utility/wikipedia/v0.1/getresults: + post: + tags: + - v0.1.0 + responses: + '200': + description: success response + content: + application/json: + schema: + $ref: '#/components/schemas/success' + example: + results: + content: Singapore officially the Republic of Singapore, is a sovereign city-state + and island country located in maritime Southeast Asia. Singapore lies about one + degree of latitude (137 kilometres or 85 miles) north of the equator. + images: + - https://upload.wikimedia.org/wikipedia/commons/f/f5/0008871_-_Krung_Thep_Bridge_001.jpg + - https://upload.wikimedia.org/wikipedia/commons/1/12/2014_Singapore_Products_Export_Treemap.png + - https://upload.wikimedia.org/wikipedia/commons/1/1b/2017_G20_Hamburg_summit_leaders_group_photo.jpg + - https://upload.wikimedia.org/wikipedia/commons/1/10/A_Night_Perspective_on_the_Singapore_Merlion_%288347645113%29.jpg + links: + - 65 + - ".sg" + - 126 Squadron, Republic of Singapore Air Force + - 13th Parliament of Singapore + - 16th Summit of the Non-Aligned Movement + - 1915 Singapore Mutiny + pageid: 27318 + summary: Singapore officially the Republic of Singapore, is a sovereign city-state + and island country located in maritime Southeast Asia. Singapore lies about one + degree of latitude (137 kilometres or 85 miles) north of the equator. + url: https://en.wikipedia.org/wiki/Singapore + message: Successfully Processed + status: Success + '401': + description: Unauthorized + content: + application/json: + schema: + $ref: '#/components/schemas/unauthorized' + '402': + description: Payment Required + content: + application/json: + schema: + $ref: '#/components/schemas/paymentrequired' + '403': + description: Forbidden + content: + application/json: + schema: + $ref: '#/components/schemas/forbidden' + '404': + description: Not Found + content: + application/json: + schema: + $ref: '#/components/schemas/notfound' + '419': + description: Input Field Missing + content: + application/json: + schema: + $ref: '#/components/schemas/inputfieldmissing' + '413': + description: Input Limit Exceeded + content: + application/json: + schema: + $ref: '#/components/schemas/inputlimitexceeded' + '415': + description: Invalid Input + content: + application/json: + schema: + $ref: '#/components/schemas/invalidinput' + '500': + description: Internal Server Error + content: + application/json: + schema: + $ref: '#/components/schemas/servererror' + '504': + description: Gateway Timeout + content: + application/json: + schema: + $ref: '#/components/schemas/gatewaytimeout' + security: + - APIAuthorizer: [] + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/input' + required: true +components: + schemas: + success: + type: object + properties: + results: + type: object + example: { "" } + description: Json Object of returned results + properties: + content: + type: string + example: "Singapore officially the Republic of Singapore, is a sovereign city-state and island country located in maritime Southeast Asia. + Singapore lies about one degree of latitude (137 kilometres or 85 miles) north of the equator." + description: Plain text content of the page, excluding images, tables, and other data. + images: + type: array + example: ["https://upload.wikimedia.org/wikipedia/commons/f/f5/0008871_-_Krung_Thep_Bridge_001.jpg","https://upload.wikimedia.org/wikipedia/commons/1/12/2014_Singapore_Products_Export_Treemap.png"] + description: List of URLs of images on the page. + items: + oneOf: + - type: string + format: list + example: https://upload.wikimedia.org/wikipedia/commons/f/f5/0008871_-_Krung_Thep_Bridge_001.jpg + - type: string + format: list + example: https://upload.wikimedia.org/wikipedia/commons/1/12/2014_Singapore_Products_Export_Treemap.png + - type: string + format: list + example: https://upload.wikimedia.org/wikipedia/commons/1/1b/2017_G20_Hamburg_summit_leaders_group_photo.jpg + - type: string + format: list + example: https://upload.wikimedia.org/wikipedia/commons/1/10/A_Night_Perspective_on_the_Singapore_Merlion_%288347645113%29.jpg + links: + type: array + example: [".sg","126 Squadron, Republic of Singapore Air Force","13th Parliament of Singapore","16th Summit of the Non-Aligned Movement"] + description: List of titles of Wikipedia page links on a page. + items: + oneOf: + - type: string + format: list + example: +65 + - type: string + format: list + example: .sg + - type: string + format: list + example: 126 Squadron, Republic of Singapore Air Force + - type: string + format: list + example: 13th Parliament of Singapore + - type: string + format: list + example: 16th Summit of the Non-Aligned Movement + - type: string + format: list + example: 1915 Singapore Mutiny + pageid: + type: integer + example: 27318 + description: The id of the page requested + summary: + type: string + example: Singapore officially the Republic of Singapore, is a sovereign city-state and island country located in maritime Southeast Asia. + Singapore lies about one degree of latitude (137 kilometres or 85 miles) north of the equator. + description: A short summary of the Wikipedia article that was requested + url: + type: string + example: https://en.wikipedia.org/wiki/Singapore + description: The website url of the requested wikipedia articles + message: + type: string + example: Successfully Processed + description: Detail description on the API status + status: + type: string + example: Success + description: The status of the API call success/failure + unauthorized: + type: object + properties: + message: + type: string + example: Missing Authentication Token + status: + type: string + example: Failure + forbidden: + type: object + properties: + message: + type: string + example: Access Denied Unauthorized User + status: + type: string + example: Failure + paymentrequired: + type: object + properties: + message: + type: string + example: Insufficient Credits Kindly Top Up + status: + type: string + example: Failure + invalidinput: + type: object + properties: + message: + type: string + example: Invalid Input + status: + type: string + example: Failure + notfound: + type: object + properties: + message: + type: string + example: Invalid Request URL + status: + type: string + example: Failure + servererror: + type: object + properties: + message: + type: string + example: Internal Server Error + status: + type: string + example: Failure + gatewaytimeout: + type: object + properties: + message: + type: string + example: Request Timeout + status: + type: string + example: Failure + inputfieldmissing: + type: object + properties: + message: + type: string + example: Input Field Missing + status: + type: string + example: Failure + inputlimitexceeded: + type: object + properties: + message: + type: string + example: Input Limit Exceeded + status: + type: string + example: Failure + versions: + type: object + properties: + v0.1.0: + type: array + items: + oneOf: + - type: string + example: Published Date - Apr 23, 2020 + description: Initial version release + input: + type: object + properties: + title: + type: string + example: Singapore + default: true + description: The search term, highest match to the title of the Wikipedia page. + pageid: + type: integer + default: true + example: 27318 + description: The Wikipedia id of the page requested. + language: + type: string + default: false + example: en + description: Indicates the language in which the Wikipedia page is written. Default is English, for other languages give the input as ISO 639-1 language code. Please refer this link for language code https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes. + filter_key: + type: string + default: false + example: all + description: Indicates the filter criteria of the output result fields. The default return set includes pageid, url, and summary.“all” - returns all the fields. You can also filter by individual fields using the list value. Possible values are pageid, url, summary, content, links, and images + securitySchemes: + APIAuthorizer: + type: apiKey + name: x-api-key + in: header + x-amazon-apigateway-authtype: custom + description: Authentication is done using the x-api-key in the request header diff --git a/utility/wikipedia_retrieval_v1.0.yaml b/utility/wikipedia_retrieval_v1.0.yaml new file mode 100644 index 000000000..b423cc9b8 --- /dev/null +++ b/utility/wikipedia_retrieval_v1.0.yaml @@ -0,0 +1,342 @@ +openapi: 3.0.1 +info: + title: Wikipedia Retrieval + description: |+ + It is an API that provides the user with a Wikipedia article based on the input keyword. Refer to this link for the full list of Wikipedias - https://meta.wikimedia.org/wiki/List_of_Wikipedias + x-additionalinfo: |+ + Suggested Use Cases: + - Access topics within Wikipedia with great specificity. Can be used for research/study-related solutions by using information from this microservice to compare articles, revisions and more. + + - Extract the most relevant content from Wikipedia’s categories to provide a text analysis service to ascertain what any text is in reference to. + version: '1.0.0' + x-subscribelink: wikipedia_retrieval +servers: + - url: 'https://apis.sentient.io' +tags: +- name: "v1.0.0" + description: "Published Date - Jan 11, 2021" +paths: + /microservices/utility/wikipedia/v1/getresults: + post: + tags: + - v1.0.0 + responses: + '200': + description: success response + content: + application/json: + schema: + $ref: '#/components/schemas/success' + example: + results: + content: Singapore officially the Republic of Singapore, is a sovereign city-state + and island country located in maritime Southeast Asia. Singapore lies about one + degree of latitude (137 kilometres or 85 miles) north of the equator. + images: + - https://upload.wikimedia.org/wikipedia/commons/f/f5/0008871_-_Krung_Thep_Bridge_001.jpg + - https://upload.wikimedia.org/wikipedia/commons/1/12/2014_Singapore_Products_Export_Treemap.png + - https://upload.wikimedia.org/wikipedia/commons/1/1b/2017_G20_Hamburg_summit_leaders_group_photo.jpg + - https://upload.wikimedia.org/wikipedia/commons/1/10/A_Night_Perspective_on_the_Singapore_Merlion_%288347645113%29.jpg + links: + - 65 + - ".sg" + - 126 Squadron, Republic of Singapore Air Force + - 13th Parliament of Singapore + - 16th Summit of the Non-Aligned Movement + - 1915 Singapore Mutiny + pageid: 27318 + summary: Singapore officially the Republic of Singapore, is a sovereign city-state + and island country located in maritime Southeast Asia. Singapore lies about one + degree of latitude (137 kilometres or 85 miles) north of the equator. + thumbnail: + height: 333 + source: https://upload.wikimedia.org/wikipedia/commons/thumb/4/48/Flag_of_Singapore.svg/500px-Flag_of_Singapore.svg.png + width: 500 + url: https://en.wikipedia.org/wiki/Singapore + message: Successfully Processed + status: Success + '401': + description: Unauthorized + content: + application/json: + schema: + $ref: '#/components/schemas/unauthorized' + '402': + description: Payment Required + content: + application/json: + schema: + $ref: '#/components/schemas/paymentrequired' + '403': + description: Forbidden + content: + application/json: + schema: + $ref: '#/components/schemas/forbidden' + '404': + description: Not Found + content: + application/json: + schema: + $ref: '#/components/schemas/notfound' + '419': + description: Input Field Missing + content: + application/json: + schema: + $ref: '#/components/schemas/inputfieldmissing' + '413': + description: Input Limit Exceeded + content: + application/json: + schema: + $ref: '#/components/schemas/inputlimitexceeded' + '415': + description: Invalid Input + content: + application/json: + schema: + $ref: '#/components/schemas/invalidinput' + '500': + description: Internal Server Error + content: + application/json: + schema: + $ref: '#/components/schemas/servererror' + '504': + description: Gateway Timeout + content: + application/json: + schema: + $ref: '#/components/schemas/gatewaytimeout' + security: + - APIAuthorizer: [] + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/input' + required: true +components: + schemas: + success: + type: object + properties: + results: + type: object + example: { "" } + description: Json Object of returned results + properties: + content: + type: string + example: "Singapore officially the Republic of Singapore, is a sovereign city-state and island country located in maritime Southeast Asia. + Singapore lies about one degree of latitude (137 kilometres or 85 miles) north of the equator." + description: Plain text content of the page, excluding images, tables, and other data. + images: + type: array + example: ["https://upload.wikimedia.org/wikipedia/commons/f/f5/0008871_-_Krung_Thep_Bridge_001.jpg","https://upload.wikimedia.org/wikipedia/commons/1/12/2014_Singapore_Products_Export_Treemap.png"] + description: List of URLs of images on the page. + items: + oneOf: + - type: string + format: list + example: https://upload.wikimedia.org/wikipedia/commons/f/f5/0008871_-_Krung_Thep_Bridge_001.jpg + - type: string + format: list + example: https://upload.wikimedia.org/wikipedia/commons/1/12/2014_Singapore_Products_Export_Treemap.png + - type: string + format: list + example: https://upload.wikimedia.org/wikipedia/commons/1/1b/2017_G20_Hamburg_summit_leaders_group_photo.jpg + - type: string + format: list + example: https://upload.wikimedia.org/wikipedia/commons/1/10/A_Night_Perspective_on_the_Singapore_Merlion_%288347645113%29.jpg + links: + type: array + example: [".sg","126 Squadron, Republic of Singapore Air Force","13th Parliament of Singapore","16th Summit of the Non-Aligned Movement"] + description: List of titles of Wikipedia page links on a page. + items: + oneOf: + - type: string + format: list + example: +65 + - type: string + format: list + example: .sg + - type: string + format: list + example: 126 Squadron, Republic of Singapore Air Force + - type: string + format: list + example: 13th Parliament of Singapore + - type: string + format: list + example: 16th Summit of the Non-Aligned Movement + - type: string + format: list + example: 1915 Singapore Mutiny + pageid: + type: integer + example: 27318 + description: The id of the page requested + summary: + type: string + example: Singapore officially the Republic of Singapore, is a sovereign city-state and island country located in maritime Southeast Asia. + Singapore lies about one degree of latitude (137 kilometres or 85 miles) north of the equator. + description: A short summary of the Wikipedia article that was requested + thumbnail: + type: object + example: {"height":333,"source":"https://upload.wikimedia.org/wikipedia/commons/thumb/4/48/Flag_of_Singapore.svg/500px-Flag_of_Singapore.svg.png", "width":500} + description: URL and dimensions of thumbnail image associated with page, if any. + properties: + height: + type: string + example: 333 + description: Height of the thumbnail image + source: + type: string + example: https://upload.wikimedia.org/wikipedia/commons/thumb/4/48/Flag_of_Singapore.svg/500px-Flag_of_Singapore.svg.png + description: Source URL of the thumbnail image + width: + type: string + example: 500 + description: Width of the thumbnail image + url: + type: string + example: https://en.wikipedia.org/wiki/Singapore + description: The website url of the requested wikipedia articles + message: + type: string + example: Successfully Processed + description: Detail description on the API status + status: + type: string + example: Success + description: The status of the API call success/failure + unauthorized: + type: object + properties: + message: + type: string + example: Missing Authentication Token + status: + type: string + example: Failure + forbidden: + type: object + properties: + message: + type: string + example: Access Denied Unauthorized User + status: + type: string + example: Failure + paymentrequired: + type: object + properties: + message: + type: string + example: Insufficient Credits Kindly Top Up + status: + type: string + example: Failure + invalidinput: + type: object + properties: + message: + type: string + example: Invalid Input + status: + type: string + example: Failure + notfound: + type: object + properties: + message: + type: string + example: Invalid Request URL + status: + type: string + example: Failure + servererror: + type: object + properties: + message: + type: string + example: Internal Server Error + status: + type: string + example: Failure + gatewaytimeout: + type: object + properties: + message: + type: string + example: Request Timeout + status: + type: string + example: Failure + inputfieldmissing: + type: object + properties: + message: + type: string + example: Input Field Missing + status: + type: string + example: Failure + inputlimitexceeded: + type: object + properties: + message: + type: string + example: Input Limit Exceeded + status: + type: string + example: Failure + versions: + type: object + properties: + v1.0.0: + type: array + items: + oneOf: + - type: string + example: Published Date - Jan 11, 2021 + description: Patch Update, Optimization and thumbnail is added as an additional field + v0.1.0: + type: array + items: + oneOf: + - type: string + example: Published Date - Apr 23, 2020 + description: Initial version release + input: + type: object + properties: + keyword: + type: string + example: Singapore + default: true + description: The search term, highest match to the title of the Wikipedia page. Not Mandatory when pageid is given. + pageid: + type: integer + default: false + example: 27318 + description: The Wikipedia id of the page requested. Mandatory only when title is not given. + language: + type: string + default: false + example: en + description: Indicates the language in which the Wikipedia page is written. Default is English, for other languages give the input as ISO 639-1 language code. Please refer this link for language code https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes + additional_fields: + type: string + default: false + example: all + description: The default returns the pageid, url, summary and thumbnail, when given “all” - returns all the fields i.e pageid, url, summary, content, links, images and thumbnail. + securitySchemes: + APIAuthorizer: + type: apiKey + name: x-api-key + in: header + x-amazon-apigateway-authtype: custom + description: Authentication is done using the x-api-key in the request header diff --git a/utility/youtube_video_downloader.yaml b/utility/youtube_video_downloader.yaml new file mode 100644 index 000000000..2975beb08 --- /dev/null +++ b/utility/youtube_video_downloader.yaml @@ -0,0 +1,223 @@ +openapi: 3.0.1 +info: + title: Youtube Video Downloader + description: |+ + This Utility microservice retrieves the Youtube video of the input URL and outputs a download link. + x-additionalinfo: |+ + Suggested Use Cases: + - Can be integrated into apps used to download and watch videos when the user wants to save limited data. + version: '0.1.0' + x-subscribelink: youtube_video_downloader +servers: + - url: 'https://apis.sentient.io' +tags: +- name: "v0.1.0" + description: "Published Date - Nov 25, 2019" +paths: + /microservices/utility/downloadyoutubevideos/v0.1/getresults: + post: + tags: + - v0.1.0 + responses: + '200': + description: success response + content: + application/json: + schema: + $ref: '#/components/schemas/success' + example: + results: + url: https://storage.googleapis.com/youtubedownload/video.mp4?X-Goog-Algorithm=GOOG4-RSA-SHA256&X-Goog-Credential=cloudstorage%40sentient-231509.iam.gserviceaccount.com%2F20200513%2Fauto%2Fstorage%2Fgoog4_request&X-Goog-Date=20200513T115310Z&X-Goog-Expires=6000&X-Goog-SignedHeaders=host&X-Goog-Signature=730f588eb4794828389c6a098002d666b307ab695dbd07f84e5309f79503e857e2d8352e11125a0d569f7e3704da6a0320e426f7fe99ed68d965d3812700c4930060e95da1f7d0694c7751ca493c3f097bcd85a37f33ee8a0a7c7366a8aeba2f5bae7814cc1f0ec5f397ebe70f0bc9bcb82be8843db609ebef01953ae3fdd82d48b39184ac566d570cd3a2b3c1f1a09353f0b2d83643eb1b3140850585a299ada899f6473e76c585128d0b864724f67430f6b2b8798e4399c991d97e2716c5382b6597fca8ee43e72f409848491109ba093399355eeb76b92bf769d2e10e5d2952615e8fbc7798bb7bca8d71ef631339634911346d0175cc45fb691d6c8b9cae + message: Successfully downloaded and stored in Google Cloud Storage. + status: success + '401': + description: Unauthorized + content: + application/json: + schema: + $ref: '#/components/schemas/unauthorized' + '402': + description: Payment Required + content: + application/json: + schema: + $ref: '#/components/schemas/paymentrequired' + '403': + description: Forbidden + content: + application/json: + schema: + $ref: '#/components/schemas/forbidden' + '404': + description: Not Found + content: + application/json: + schema: + $ref: '#/components/schemas/notfound' + '419': + description: Input Field Missing + content: + application/json: + schema: + $ref: '#/components/schemas/inputfieldmissing' + '413': + description: Input Limit Exceeded + content: + application/json: + schema: + $ref: '#/components/schemas/inputlimitexceeded' + '415': + description: Invalid Input + content: + application/json: + schema: + $ref: '#/components/schemas/invalidinput' + '500': + description: Internal Server Error + content: + application/json: + schema: + $ref: '#/components/schemas/servererror' + '504': + description: Gateway Timeout + content: + application/json: + schema: + $ref: '#/components/schemas/gatewaytimeout' + security: + - APIAuthorizer: [] + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/input' + required: true +components: + schemas: + success: + type: object + properties: + results: + type: object + example: { "" } + description: Json Object of returned results + properties: + url: + type: string + description: Pre-signed URL to download the video + example: https://storage.googleapis.com/youtubedownload/video.mp4?X-Goog-Algorithm=GOOG4-RSA-SHA256&X-Goog-Credential=cloudstorage%40sentient-231509.iam.gserviceaccount.com%2F20200513%2Fauto%2Fstorage%2Fgoog4_request&X-Goog-Date=20200513T115310Z&X-Goog-Expires=6000&X-Goog-SignedHeaders=host&X-Goog-Signature=730f588eb4794828389c6a098002d666b307ab695dbd07f84e5309f79503e857e2d8352e11125a0d569f7e3704da6a0320e426f7fe99ed68d965d3812700c4930060e95da1f7d0694c7751ca493c3f097bcd85a37f33ee8a0a7c7366a8aeba2f5bae7814cc1f0ec5f397ebe70f0bc9bcb82be8843db609ebef01953ae3fdd82d48b39184ac566d570cd3a2b3c1f1a09353f0b2d83643eb1b3140850585a299ada899f6473e76c585128d0b864724f67430f6b2b8798e4399c991d97e2716c5382b6597fca8ee43e72f409848491109ba093399355eeb76b92bf769d2e10e5d2952615e8fbc7798bb7bca8d71ef631339634911346d0175cc45fb691d6c8b9cae + message: + type: string + example: Successfully downloaded and stored in Google Cloud Storage. + description: Detail description on the API status + status: + type: string + example: success + description: The status of the API call success/failure + unauthorized: + type: object + properties: + message: + type: string + example: Missing Authentication Token + status: + type: string + example: Failure + forbidden: + type: object + properties: + message: + type: string + example: Access Denied Unauthorized User + status: + type: string + example: Failure + paymentrequired: + type: object + properties: + message: + type: string + example: Insufficient Credits Kindly Top Up + status: + type: string + example: Failure + notfound: + type: object + properties: + message: + type: string + example: Invalid Request URL + status: + type: string + example: Failure + servererror: + type: object + properties: + message: + type: string + example: Internal Server Error + status: + type: string + example: Failure + gatewaytimeout: + type: object + properties: + message: + type: string + example: Request Timeout + status: + type: string + example: Failure + invalidinput: + type: object + properties: + message: + type: string + example: Invalid Input + status: + type: string + example: Failure + inputfieldmissing: + type: object + properties: + message: + type: string + example: Input Field Missing + status: + type: string + example: Failure + inputlimitexceeded: + type: object + properties: + message: + type: string + example: Input Limit Exceeded + status: + type: string + example: Failure + input: + type: object + properties: + url: + type: string + default: true + example: https://www.youtube.com/watch?v=1bumPyvzCyo + description: |+ + Youtube URL. + versions: + type: object + properties: + v0.1.0: + type: array + items: + oneOf: + - type: string + example: Published Date - Nov 25, 2019 + description: Initial version release + securitySchemes: + APIAuthorizer: + type: apiKey + name: x-api-key + in: header + x-amazon-apigateway-authtype: custom + description: Authentication is done using the x-api-key in the request header diff --git a/voice/asr_with_voice_activity_detection_eng_sg.yaml b/voice/asr_with_voice_activity_detection_eng_sg.yaml new file mode 100644 index 000000000..d69738753 --- /dev/null +++ b/voice/asr_with_voice_activity_detection_eng_sg.yaml @@ -0,0 +1,261 @@ +openapi: 3.0.1 +info: + title: ASR with Voice Activity Detection ENG (SG) + description: |+ + This Voice microservice combines Voice Activity Detection feature and Automatic Speech Recognition capability. It detects speech in an audio file (.wav format) and transcribes English speech content from the audio stream into text. The transcript text is timestamped for each utterance. An utterance is a continuous piece of speech beginning and ending with a clear pause. + + This Voice microservice performs well on Singapore-accented English speech. For best performance, select the model which best matches the use-case: news_parliament, nsc_parliament, nscfull_8k. + + The size of your audio file should be **between 3 KB to 10 MB**. + version: '0.1.0' + x-additionalinfo: |+ + Suggested Use Cases: + - Combine this with the Text-to-Speech API to deliver voice-enabled experiences in IoT (Internet of Things) applications, such as implementing voice commands like “turn the volume up". + x-subscribelink: asr_with_voice_activity_detection_eng_sg +servers: + - url: 'https://apis.sentient.io' +tags: +- name: "v0.1.0" + description: "Published Date - Dec 14, 2019" +paths: + /microservices/voice/vadasr/v0.1/getpredictions: + post: + tags: + - v0.1.0 + responses: + '200': + description: success response + content: + application/json: + schema: + $ref: '#/components/schemas/success' + example: + - seqNum: 1 + start: 0.64 + end: 23.72 + text: HELLO WORLD + '401': + description: Unauthorized + content: + application/json: + schema: + $ref: '#/components/schemas/unauthorized' + '402': + description: Payment Required + content: + application/json: + schema: + $ref: '#/components/schemas/paymentrequired' + '403': + description: Forbidden + content: + application/json: + schema: + $ref: '#/components/schemas/forbidden' + '404': + description: Not Found + content: + application/json: + schema: + $ref: '#/components/schemas/notfound' + '419': + description: Input Field Missing + content: + application/json: + schema: + $ref: '#/components/schemas/inputfieldmissing' + '413': + description: Input Limit Exceeded + content: + application/json: + schema: + $ref: '#/components/schemas/inputlimitexceeded' + '415': + description: Invalid Input + content: + application/json: + schema: + $ref: '#/components/schemas/invalidinput' + '500': + description: Internal Server Error + content: + application/json: + schema: + $ref: '#/components/schemas/servererror' + '504': + description: Gateway Timeout + content: + application/json: + schema: + $ref: '#/components/schemas/gatewaytimeout' + security: + - APIAuthorizer: [] + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/input' + required: true +components: + schemas: + success: + type: object + properties: + end: + type: string + example: 23.72 + description: End time of utterance + seqNum: + type: string + example: 1 + description: Running sequence number starts from 1. + start: + type: integer + example: 0.64 + description: Start time of utterance + text: + type: string + description: Converted text from the input audio file + example: THE COMING YEAR LIFE FOR A REASON A CITIZEN OR A LIFETIME LIKE YOU WHEN SOMEONE IS IN YOUR LIFE A REASON IT USUALLY TO MEET IN NEED WITHIN YOU HAVE NEVER MET YOU BUT I LIKE YOU WHEN SOMEONE IS IN YOUR LIFE FOR A SEASON IS BECAUSE IT IS YOUR TURN TO SHARE LEARN AND GROW AND WANT SOMEONE IN YOUR LIFE FOR A LIFETIME IT CITY THROUGH LESSONS AND IF NOT WHAT THE PEOPLE + unauthorized: + type: object + properties: + message: + type: string + example: Missing Authentication Token + status: + type: string + example: Failure + forbidden: + type: object + properties: + message: + type: string + example: Access Denied Unauthorized User + status: + type: string + example: Failure + paymentrequired: + type: object + properties: + message: + type: string + example: Insufficient Credits Kindly Top Up + status: + type: string + example: Failure + notfound: + type: object + properties: + message: + type: string + example: Invalid Request URL + status: + type: string + example: Failure + servererror: + type: object + properties: + message: + type: string + example: Internal Server Error + status: + type: string + example: Failure + gatewaytimeout: + type: object + properties: + message: + type: string + example: Request Timeout + status: + type: string + example: Failure + inputfieldmissing: + type: object + properties: + message: + type: string + example: Input Field Missing + status: + type: string + example: Failure + inputlimitexceeded: + type: object + properties: + message: + type: string + example: Input Limit Exceeded + status: + type: string + example: Failure + invalidinput: + type: object + properties: + message: + type: string + example: Invalid Input + status: + type: string + example: Failure + input: + type: object + required: + - wav_base64 + - wav_url + properties: + model: + x-name: model + type: string + default: true + example: news_parliament + description: |+ + Model selection. For best performance, select the model which best matches the use-case: + + 1. news_parliament - 16 kHz, mono channel, .wav format. Trained on Singapore news and parliament corpus. + 2. nsc_parliament - 16 kHz, mono channel, .wav format. Trained on National Speech Corpus and parliament corpus. + 3. nscfull_8k - 8 kHz, mono channel, .wav format. Trained on National Speech Corpus. Trained on Full National Speech Corpus corpus. + wav_url/wav_base64: + x-name: wav_url/wav_base64 + type: string + default: true + example: https://api.sentient.io/test2.wav or UklGRpxNHQBXQVZFZm10IBAAAAABAAEAgD4AAAB9AAACABAAT ... + description: |+ + The public URL link to the wave file or Input audio wav file in base64 format. + + Mono channel, 8kHz / 16kHz sampling rate. + file_type: + x-name: file_type + type: string + default: true + example: wav + description: |+ + Input file extension. + + Currently supported formats: .wav + vad_threshold: + x-name: vad_threshold + type: number + format: float + default: true + example: 0.4 + description: |+ + 0.0 to 1.0. Lower will result in more sentence splits. Recommended value is 0.25. + versions: + type: object + properties: + v0.1.0: + type: array + items: + oneOf: + - type: string + example: Published Date - Dec 14,2019 + description: Initial version release + + securitySchemes: + APIAuthorizer: + type: apiKey + name: x-api-key + in: header + x-amazon-apigateway-authtype: custom + description: Authentication is done using the x-api-key in the request header diff --git a/voice/asr_with_voice_activity_detection_eng_sg_v1.0.yaml b/voice/asr_with_voice_activity_detection_eng_sg_v1.0.yaml new file mode 100644 index 000000000..cce373106 --- /dev/null +++ b/voice/asr_with_voice_activity_detection_eng_sg_v1.0.yaml @@ -0,0 +1,299 @@ +openapi: 3.0.1 +info: + title: ASR with Voice Activity Detection ENG (SG) + description: |+ + This Voice microservice combines Voice Activity Detection feature and Automatic Speech Recognition capability. It detects speech in an audio file (.wav format) and transcribes English speech content from the audio stream into text. The transcript text is timestamped for each utterance. An utterance is a continuous piece of speech beginning and ending with a clear pause. + This microservice performs well on Singaporean-accented English speech. For best performance, select the model which best matches the use-case, whether for prepared speech (16kHz) or telephony (8kHz). + + The size of your audio file should be **between 3 KB to 10 MB**. + version: '1.1.0' + x-additionalinfo: |+ + Suggested Use Cases: + - Combine this with the Text-to-Speech API to deliver voice-enabled experiences in IoT (Internet of Things) applications, such as implementing voice commands like “turn the volume up". + x-subscribelink: asr_with_voice_activity_detection_eng_sg +servers: + - url: 'https://apis.sentient.io' +tags: +- name: "v1.1.0" + description: "Published Date - Jan 22, 2021" +paths: + /microservices/voice/vadasr/v1/getpredictions: + post: + tags: + - v1.1.0 + responses: + '200': + description: success response + content: + application/json: + schema: + $ref: '#/components/schemas/success' + example: + results: + output: + - seqNum: 1 + start: 0.64 + end: 23.72 + text: HELLO WORLD + message: Successfully Processed + status: Success + '401': + description: Unauthorized + content: + application/json: + schema: + $ref: '#/components/schemas/unauthorized' + '402': + description: Payment Required + content: + application/json: + schema: + $ref: '#/components/schemas/paymentrequired' + '403': + description: Forbidden + content: + application/json: + schema: + $ref: '#/components/schemas/forbidden' + '404': + description: Not Found + content: + application/json: + schema: + $ref: '#/components/schemas/notfound' + '419': + description: Input Field Missing + content: + application/json: + schema: + $ref: '#/components/schemas/inputfieldmissing' + '413': + description: Input Limit Exceeded + content: + application/json: + schema: + $ref: '#/components/schemas/inputlimitexceeded' + '415': + description: Invalid Input + content: + application/json: + schema: + $ref: '#/components/schemas/invalidinput' + '500': + description: Internal Server Error + content: + application/json: + schema: + $ref: '#/components/schemas/servererror' + '504': + description: Gateway Timeout + content: + application/json: + schema: + $ref: '#/components/schemas/gatewaytimeout' + security: + - APIAuthorizer: [] + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/input' + required: true +components: + schemas: + success: + type: object + properties: + results: + type: object + description: The result of the API call. + example: { "" } + properties: + output: + type: array + example: [{end: 23.72,seqNum: 1,start: 0.64,text: HELLO WORLD }] + description: List of details of start and end time of utterances in the input audio + items: + oneOf: + - type: object + properties: + end: + type: string + example: 23.72 + description: End time of utterance + seqNum: + type: string + example: 1 + description: Running sequence number starts from 1. + start: + type: integer + example: 0.64 + description: Start time of utterance + text: + type: string + description: Converted text from the input audio file + example: THE COMING YEAR LIFE FOR A REASON A CITIZEN OR A LIFETIME LIKE YOU WHEN SOMEONE IS IN YOUR LIFE A REASON IT USUALLY TO MEET IN NEED WITHIN YOU HAVE NEVER MET YOU BUT I LIKE YOU WHEN SOMEONE IS IN YOUR LIFE FOR A SEASON IS BECAUSE IT IS YOUR TURN TO SHARE LEARN AND GROW AND WANT SOMEONE IN YOUR LIFE FOR A LIFETIME IT CITY THROUGH LESSONS AND IF NOT WHAT THE PEOPLE + message: + type: string + example: Successfully Processed + description: Detail description on the API status + status: + type: string + example: Success + description: The status of the API call success/failure + unauthorized: + type: object + properties: + message: + type: string + example: Missing Authentication Token + status: + type: string + example: Failure + forbidden: + type: object + properties: + message: + type: string + example: Access Denied Unauthorized User + status: + type: string + example: Failure + paymentrequired: + type: object + properties: + message: + type: string + example: Insufficient Credits Kindly Top Up + status: + type: string + example: Failure + notfound: + type: object + properties: + message: + type: string + example: Invalid Request URL + status: + type: string + example: Failure + servererror: + type: object + properties: + message: + type: string + example: Internal Server Error + status: + type: string + example: Failure + gatewaytimeout: + type: object + properties: + message: + type: string + example: Request Timeout + status: + type: string + example: Failure + inputfieldmissing: + type: object + properties: + message: + type: string + example: Input Field Missing + status: + type: string + example: Failure + inputlimitexceeded: + type: object + properties: + message: + type: string + example: Input Limit Exceeded + status: + type: string + example: Failure + invalidinput: + type: object + properties: + message: + type: string + example: Invalid Input + status: + type: string + example: Failure + input: + type: object + required: + - model + - wav_base64 + properties: + model: + x-name: model + type: string + default: true + example: prepared_speech + description: |+ + Model selection. For best performance, select the model which best matches the use-case: + + 1. prepared_speech - Better suited for transcribing prepared / formal speech (e.g. news or parliamentary speeches). 16 kHz, mono channel, .wav format. + 2. telephony - Better suited for conversational speech or telephony use cases. 8 kHz, mono channel, .wav format. + wav_base64: + x-name: wav_base64 + type: string + default: true + example: UklGRpxNHQBXQVZFZm10IBAAAAABAAEAgD4AAAB9AAACABAAT ... + description: |+ + Input audio wav file in base64 format. + + Mono channel, 8kHz / 16kHz sampling rate. + file_type: + x-name: file_type + type: string + default: true + example: wav + description: |+ + Input file extension. + + Currently supported formats: .wav + threshold: + x-name: threshold + type: number + format: float + default: true + example: 0.4 + description: |+ + 0.0 to 1.0. Lower will result in more sentence splits. Recommended value is 0.25. + versions: + type: object + properties: + v1.1.0: + type: array + items: + oneOf: + - type: string + example: Published Date - Jan 22, 2021 + description: Model name update + v1.0.0: + type: array + items: + oneOf: + - type: string + example: Published Date - Dec 09, 2020 + description: Standardizing Output JSON + + v0.1.0: + type: array + items: + oneOf: + - type: string + example: Published Date - Dec 14,2019 + description: Initial version release + + securitySchemes: + APIAuthorizer: + type: apiKey + name: x-api-key + in: header + x-amazon-apigateway-authtype: custom + description: Authentication is done using the x-api-key in the request header diff --git a/voice/automatic_speech_recognition_chi_sg.yaml b/voice/automatic_speech_recognition_chi_sg.yaml new file mode 100644 index 000000000..a5c9ba89e --- /dev/null +++ b/voice/automatic_speech_recognition_chi_sg.yaml @@ -0,0 +1,244 @@ +openapi: 3.0.1 +info: + title: Automatic Speech Recognition CHI (SG) + description: |+ + This Voice microservice takes in the input audio file (in WAV format at 16kHz) and transcribes Mandarin speech content within the input file into text. + + This microservice works best when the audio file consists of mostly speech with no long pauses in between. + x-additionalinfo: |+ + Suggested Use Cases: + - Extraction of text from voice ( from sound files), especially with Singaporean accented Mandarin. + + - Extraction of text from video, especially with Singaporean accented Mandarin. + + - Improve customer service - empower a customer service system by adding IVR (interactive voice response) and agent conversations to call centers. Perform analytics on conversation data to gain more insights into the calls and customers. + + - Enable voice control services - e.g. implement voice commands such as “turn the volume up,” and voice search such as saying “what is the temperature in Paris?” + + - Transcribe multimedia content - transcribe audio and video to include captions and improve audience reach and experience. For example, this microservice can be used for indexing or subtitling video and/or multispeaker content; similar to video captioning on YouTube. + version: '0.1.1' + x-subscribelink: automatic_speech_recognition_chi_sg +servers: + - url: 'https://apis.sentient.io' +tags: +- name: "v0.1.1" + description: "Published Date - Sep 28, 2018" +paths: + /microservices/voice/asrsch/v0.1/getpredictions: + post: + tags: + - v0.1.1 + responses: + '200': + description: success response + content: + application/json: + schema: + $ref: '#/components/schemas/success' + example: + message: "各位同学朋友老师教授大家好我叫墓园" + status: success + '401': + description: Unauthorized + content: + application/json: + schema: + $ref: '#/components/schemas/unauthorized' + '402': + description: Payment Required + content: + application/json: + schema: + $ref: '#/components/schemas/paymentrequired' + '403': + description: Forbidden + content: + application/json: + schema: + $ref: '#/components/schemas/forbidden' + '404': + description: Not Found + content: + application/json: + schema: + $ref: '#/components/schemas/notfound' + '419': + description: Input Field Missing + content: + application/json: + schema: + $ref: '#/components/schemas/inputfieldmissing' + '413': + description: Input Limit Exceeded + content: + application/json: + schema: + $ref: '#/components/schemas/inputlimitexceeded' + '415': + description: Invalid Input + content: + application/json: + schema: + $ref: '#/components/schemas/invalidinput' + '500': + description: Internal Server Error + content: + application/json: + schema: + $ref: '#/components/schemas/servererror' + '504': + description: Gateway Timeout + content: + application/json: + schema: + $ref: '#/components/schemas/gatewaytimeout' + security: + - APIAuthorizer: [] + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/input' + required: true +components: + schemas: + success: + type: object + properties: + message: + type: string + example: 各位同学朋友老师教授大家好我叫墓园 + description: Converted Text + status: + type: string + example: success + description: The status of the API call success/failure + unauthorized: + type: object + properties: + message: + type: string + example: Missing Authentication Token + status: + type: string + example: Failure + forbidden: + type: object + properties: + message: + type: string + example: Access Denied Unauthorized User + status: + type: string + example: Failure + paymentrequired: + type: object + properties: + message: + type: string + example: Insufficient Credits Kindly Top Up + status: + type: string + example: Failure + notfound: + type: object + properties: + message: + type: string + example: Invalid Request URL + status: + type: string + example: Failure + servererror: + type: object + properties: + message: + type: string + example: Internal Server Error + status: + type: string + example: Failure + gatewaytimeout: + type: object + properties: + message: + type: string + example: Request Timeout + status: + type: string + example: Failure + inputfieldmissing: + type: object + properties: + message: + type: string + example: Input Field Missing + status: + type: string + example: Failure + inputlimitexceeded: + type: object + properties: + message: + type: string + example: Input Limit Exceeded + status: + type: string + example: Failure + invalidinput: + type: object + properties: + message: + type: string + example: Invalid Input + status: + type: string + example: Failure + input: + type: object + required: + - audio + properties: + audio: + x-name: audio + type: string + default: true + example: data:audio/wav;base64,UklGRkbiBABXQVZFZm10IBAAAAABA... + description: |+ + Input audio file in base64 format. + + Input file needs to be prefixed by the data type and encoding. + + Data:audio/wav;base64, + language: + x-name: language + type: string + default: true + example: 1 + description: |+ + Language setting: + 1 Mandarin + versions: + type: object + properties: + v0.1.1: + type: array + items: + oneOf: + - type: string + example: Published Date - Sep 28,2018 + description: Patch update on bug fixes + v0.1.0: + type: array + items: + oneOf: + - type: string + example: Published Date - Jun 21,2018 + description: Initial version release + securitySchemes: + APIAuthorizer: + type: apiKey + name: x-api-key + in: header + x-amazon-apigateway-authtype: custom + description: Authentication is done using the x-api-key in the request header diff --git a/voice/automatic_speech_recognition_eng.yaml b/voice/automatic_speech_recognition_eng.yaml new file mode 100644 index 000000000..8e447ccfe --- /dev/null +++ b/voice/automatic_speech_recognition_eng.yaml @@ -0,0 +1,203 @@ +openapi: 3.0.1 +info: + title: Automatic Speech Recognition ENG + description: |+ + This Voice microservice takes in an audio file (in WAV format at 16kHz) and transcribes English speech content within the input file into text. + + The Automatic Speech Recognition (ASR) AI model is employed to understand the mapping of sound features to actual words in English. + + Use this microservice if the audio file consists of mostly speech with no long pauses in between. + version: '0.1' +servers: + - url: 'https://apis.sentient.io' +tags: +- name: "v0.1" + description: "Published Date - Jun 18, 2018" +paths: + /microservices/voice/asreng/v0.1/getpredictions: + post: + tags: + - v0.1 + responses: + '200': + description: success response + content: + application/json: + schema: + $ref: '#/components/schemas/success' + example: + message: Hi there + status: success + '401': + description: Unauthorized + content: + application/json: + schema: + $ref: '#/components/schemas/unauthorized' + '402': + description: Payment Required + content: + application/json: + schema: + $ref: '#/components/schemas/paymentrequired' + '403': + description: Forbidden + content: + application/json: + schema: + $ref: '#/components/schemas/forbidden' + '404': + description: Not Found + content: + application/json: + schema: + $ref: '#/components/schemas/notfound' + '419': + description: Input Field Missing + content: + application/json: + schema: + $ref: '#/components/schemas/inputfieldmissing' + '420': + description: Input Limit Exceeded + content: + application/json: + schema: + $ref: '#/components/schemas/inputlimitexceeded' + '500': + description: Internal Server Error + content: + application/json: + schema: + $ref: '#/components/schemas/servererror' + '504': + description: Gateway Timeout + content: + application/json: + schema: + $ref: '#/components/schemas/gatewaytimeout' + security: + - APIAuthorizer: [] + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/input' + required: true +components: + schemas: + success: + type: object + properties: + message: + x-name: message + type: string + example: Hi there + description: Converted Text + status: + x-name: status + type: string + example: success + description: The status of the API call success/failure + unauthorized: + type: object + properties: + message: + type: string + example: Missing Authentication Token + status: + type: string + example: Failure + forbidden: + type: object + properties: + message: + type: string + example: Access Denied Unauthorized User + status: + type: string + example: Failure + paymentrequired: + type: object + properties: + message: + type: string + example: Insufficient Credits Kindly Top Up + status: + type: string + example: Failure + notfound: + type: object + properties: + message: + type: string + example: Invalid Request URL + status: + type: string + example: Failure + servererror: + type: object + properties: + message: + type: string + example: Internal Server Error + status: + type: string + example: Failure + gatewaytimeout: + type: object + properties: + message: + type: string + example: Request Timeout + status: + type: string + example: Failure + inputfieldmissing: + type: object + properties: + message: + type: string + example: Input Field Missing + status: + type: string + example: Failure + inputlimitexceeded: + type: object + properties: + message: + type: string + example: Input Limit Exceeded + status: + type: string + example: Failure + input: + type: object + required: + - audio + properties: + audio: + x-name: audio + type: string + default: true + example: data:audio/wav;base64,UklGRkbiBABXQVZFZm10IBAAAAABA... + description: |+ + Input file in base64 format and needs to be prefixed by the data type and encoding + data:audio/wav;base64, + versions: + type: object + properties: + v0.1: + type: array + items: + oneOf: + - type: string + example: Published Date - Jun 18,2018 + description: Initial version release + securitySchemes: + APIAuthorizer: + type: apiKey + name: x-api-key + in: header + x-amazon-apigateway-authtype: custom + description: Authentication is done using the x-api-key in the request header diff --git a/voice/automatic_speech_recognition_eng_sg.yaml b/voice/automatic_speech_recognition_eng_sg.yaml new file mode 100644 index 000000000..0fcc4431a --- /dev/null +++ b/voice/automatic_speech_recognition_eng_sg.yaml @@ -0,0 +1,287 @@ +openapi: 3.0.1 +info: + title: Automatic Speech Recognition ENG (SG) + description: |+ + This Voice microservice transcribes the input audio stream into text. + + This microservice performs well on Singaporean-accented English speech. For best performance, select the model which best matches the use-case: news_parliament, nsc_parliament and nscfull_8k. + + The size of your audio file should be **between 3 KB to 10 MB**. + version: '0.1.0' + x-additionalinfo: |+ + Suggested Use Cases: + - Combine this with the Text-to-Speech API to deliver voice-enabled experiences in IoT (Internet of Things) applications, such as implementing voice commands. + x-subscribelink: automatic_speech_recognition_eng_sg +servers: + - url: 'https://apis.sentient.io' +tags: +- name: "v0.1.0" + description: "Published Date - Jul 03, 2020" +paths: + /microservices/voice/asr/v0.1/getpredictions: + post: + tags: + - v0.1.0 + responses: + '200': + description: success response + content: + application/json: + schema: + $ref: '#/components/schemas/success' + example: + results: + - seqNum: 1 + start: 1.0 + end: 4.0 + text: HELLO WORLD + '401': + description: Unauthorized + content: + application/json: + schema: + $ref: '#/components/schemas/unauthorized' + '402': + description: Payment Required + content: + application/json: + schema: + $ref: '#/components/schemas/paymentrequired' + '403': + description: Forbidden + content: + application/json: + schema: + $ref: '#/components/schemas/forbidden' + '404': + description: Not Found + content: + application/json: + schema: + $ref: '#/components/schemas/notfound' + '419': + description: Input Field Missing + content: + application/json: + schema: + $ref: '#/components/schemas/inputfieldmissing' + '413': + description: Input Limit Exceeded + content: + application/json: + schema: + $ref: '#/components/schemas/inputlimitexceeded' + '415': + description: Invalid Input + content: + application/json: + schema: + $ref: '#/components/schemas/invalidinput' + '500': + description: Internal Server Error + content: + application/json: + schema: + $ref: '#/components/schemas/servererror' + '504': + description: Gateway Timeout + content: + application/json: + schema: + $ref: '#/components/schemas/gatewaytimeout' + security: + - APIAuthorizer: [] + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/input' + required: true +components: + schemas: + success: + type: object + properties: + results: + type: array + example: [{ "" }] + description: List of Json Objects + items: + oneOf: + - type: object + example: {seqNum: 1,start: 1.0,end: 4.0,text: HELLO WORLD} + properties: + end: + type: number + format: float + example: 23.72 + description: End time of utterance in seconds + seqNum: + type: number + example: 1 + description: Running sequence. Starts from 1. + start: + type: number + format: float + example: 0.64 + description: Start time of utterance in seconds + text: + type: string + description: Converted text from the input audio file + example: THE COMING YEAR LIFE FOR A REASON A CITIZEN OR A LIFETIME LIKE YOU WHEN SOMEONE IS IN YOUR LIFE A REASON IT USUALLY TO MEET IN NEED WITHIN YOU HAVE NEVER MET YOU BUT I LIKE YOU WHEN SOMEONE IS IN YOUR LIFE FOR A SEASON IS BECAUSE IT IS YOUR TURN TO SHARE LEARN AND GROW AND WANT SOMEONE IN YOUR LIFE FOR A LIFETIME IT CITY THROUGH LESSONS AND IF NOT WHAT THE PEOPLE + unauthorized: + type: object + properties: + message: + type: string + example: Missing Authentication Token + status: + type: string + example: Failure + forbidden: + type: object + properties: + message: + type: string + example: Access Denied Unauthorized User + status: + type: string + example: Failure + paymentrequired: + type: object + properties: + message: + type: string + example: Insufficient Credits Kindly Top Up + status: + type: string + example: Failure + notfound: + type: object + properties: + message: + type: string + example: Invalid Request URL + status: + type: string + example: Failure + servererror: + type: object + properties: + message: + type: string + example: Internal Server Error + status: + type: string + example: Failure + gatewaytimeout: + type: object + properties: + message: + type: string + example: Request Timeout + status: + type: string + example: Failure + inputfieldmissing: + type: object + properties: + message: + type: string + example: Input Field Missing + status: + type: string + example: Failure + inputlimitexceeded: + type: object + properties: + message: + type: string + example: Input Limit Exceeded + status: + type: string + example: Failure + invalidinput: + type: object + properties: + message: + type: string + example: Invalid Input + status: + type: string + example: Failure + input: + type: object + required: + - model + - wav_base64 + properties: + model: + x-name: model + type: string + default: true + example: nsc_parliament + description: |+ + Model selection. For best performance, select the model which best matches the use-case: + + 1. news_parliament - 16 kHz, mono channel, .wav format. Trained on Singapore news and parliament corpus. + 2. nsc_parliament - 16 kHz, mono channel, .wav format. Trained on National Speech Corpus and parliament corpus. + 3. nscfull_8k - 8 kHz, mono channel, .wav format. Trained on National Speech Corpus. Trained on Full National Speech Corpus corpus. + wav_base64: + x-name: wav_base64 + type: string + default: true + example: UklGRkbiBABXQVZFZm10IBAAAAABA... + description: |+ + Input wav file in base64 format. + srt: + x-name: srt + type: array + default: false + example: [{seqNum: 1,start: 1.0,end: 4.0}] + description: |+ + Optional. An ordered array of utterance struct. Used for time-coding. + items: + oneOf: + - type: object + properties: + end: + x-name: end + type: number + format: float + default: false + example: "4.0" + description: |+ + "End time of utterance, in seconds. Offset from the start of stream." + seqNum: + x-name: seqNum + type: number + default: false + example: "1" + description: |+ + "Running sequence. Starts from 1." + start: + x-name: start + type: number + format: float + default: false + example: "1.0" + description: |+ + "Start time of utterance, in seconds. Offset from the start of stream." + versions: + type: object + properties: + v0.1.0: + type: array + items: + oneOf: + - type: string + example: Published Date - Jul 03,2020 + description: Initial version release + securitySchemes: + APIAuthorizer: + type: apiKey + name: x-api-key + in: header + x-amazon-apigateway-authtype: custom + description: Authentication is done using the x-api-key in the request header. diff --git a/voice/automatic_speech_recognition_eng_sg_v1.0.yaml b/voice/automatic_speech_recognition_eng_sg_v1.0.yaml new file mode 100644 index 000000000..0ede6f6f7 --- /dev/null +++ b/voice/automatic_speech_recognition_eng_sg_v1.0.yaml @@ -0,0 +1,317 @@ +openapi: 3.0.1 +info: + title: Automatic Speech Recognition ENG (SG) + description: |+ + This Voice microservice transcribes the input audio stream into text. + + This microservice performs well on Singaporean-accented English speech. For best performance, select the model which best matches the use-case, whether for prepared speech (16kHz) or telephony (8kHz). + + The size of your audio file should be **between 3 KB to 10 MB**. + version: '1.1.0' + x-additionalinfo: |+ + Suggested Use Cases: + - Combine this with the Text-to-Speech API to deliver voice-enabled experiences in IoT (Internet of Things) applications, such as implementing voice commands. + x-subscribelink: automatic_speech_recognition_eng_sg +servers: + - url: 'https://apis.sentient.io' +tags: +- name: "v1.1.0" + description: "Published Date - Jan 22, 2021" +paths: + /microservices/voice/asr/v1/getpredictions: + post: + tags: + - v1.1.0 + responses: + '200': + description: success response + content: + application/json: + schema: + $ref: '#/components/schemas/success' + example: + results: + output: + - seqNum: 1 + start: 0.64 + end: 23.72 + text: HELLO WORLD + message: Successfully Processed + status: Success + '401': + description: Unauthorized + content: + application/json: + schema: + $ref: '#/components/schemas/unauthorized' + '402': + description: Payment Required + content: + application/json: + schema: + $ref: '#/components/schemas/paymentrequired' + '403': + description: Forbidden + content: + application/json: + schema: + $ref: '#/components/schemas/forbidden' + '404': + description: Not Found + content: + application/json: + schema: + $ref: '#/components/schemas/notfound' + '419': + description: Input Field Missing + content: + application/json: + schema: + $ref: '#/components/schemas/inputfieldmissing' + '413': + description: Input Limit Exceeded + content: + application/json: + schema: + $ref: '#/components/schemas/inputlimitexceeded' + '415': + description: Invalid Input + content: + application/json: + schema: + $ref: '#/components/schemas/invalidinput' + '500': + description: Internal Server Error + content: + application/json: + schema: + $ref: '#/components/schemas/servererror' + '504': + description: Gateway Timeout + content: + application/json: + schema: + $ref: '#/components/schemas/gatewaytimeout' + security: + - APIAuthorizer: [] + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/input' + required: true +components: + schemas: + success: + type: object + properties: + results: + type: object + description: The result of the API call. + example: { "" } + properties: + output: + type: array + example: [{ "" }] + description: List of Json Objects + items: + oneOf: + - type: object + example: {seqNum: 1,start: 1.0,end: 4.0,text: HELLO WORLD} + properties: + end: + type: number + format: float + example: 23.72 + description: End time of utterance in seconds + seqNum: + type: number + example: 1 + description: Running sequence. Starts from 1. + start: + type: number + format: float + example: 0.64 + description: Start time of utterance in seconds + text: + type: string + description: Converted text from the input audio file + example: THE COMING YEAR LIFE FOR A REASON A CITIZEN OR A LIFETIME LIKE YOU WHEN SOMEONE IS IN YOUR LIFE A REASON IT USUALLY TO MEET IN NEED WITHIN YOU HAVE NEVER MET YOU BUT I LIKE YOU WHEN SOMEONE IS IN YOUR LIFE FOR A SEASON IS BECAUSE IT IS YOUR TURN TO SHARE LEARN AND GROW AND WANT SOMEONE IN YOUR LIFE FOR A LIFETIME IT CITY THROUGH LESSONS AND IF NOT WHAT THE PEOPLE + message: + type: string + example: Successfully Processed + description: Detail description on the API status + status: + type: string + example: Success + description: The status of the API call success/failure + unauthorized: + type: object + properties: + message: + type: string + example: Missing Authentication Token + status: + type: string + example: Failure + forbidden: + type: object + properties: + message: + type: string + example: Access Denied Unauthorized User + status: + type: string + example: Failure + paymentrequired: + type: object + properties: + message: + type: string + example: Insufficient Credits Kindly Top Up + status: + type: string + example: Failure + notfound: + type: object + properties: + message: + type: string + example: Invalid Request URL + status: + type: string + example: Failure + servererror: + type: object + properties: + message: + type: string + example: Internal Server Error + status: + type: string + example: Failure + gatewaytimeout: + type: object + properties: + message: + type: string + example: Request Timeout + status: + type: string + example: Failure + inputfieldmissing: + type: object + properties: + message: + type: string + example: Input Field Missing + status: + type: string + example: Failure + inputlimitexceeded: + type: object + properties: + message: + type: string + example: Input Limit Exceeded + status: + type: string + example: Failure + invalidinput: + type: object + properties: + message: + type: string + example: Invalid Input + status: + type: string + example: Failure + input: + type: object + required: + - model + - wav_base64 + properties: + model: + x-name: model + type: string + default: true + example: prepared_speech + description: |+ + Model selection. For best performance, select the model which best matches the use-case: + + 1. prepared_speech - Better suited for transcribing prepared / formal speech (e.g. news or parliamentary speeches). 16 kHz, mono channel, .wav format. + 2. telephony - Better suited for conversational speech or telephony use cases. 8 kHz, mono channel, .wav format. + wav_base64: + x-name: wav_base64 + type: string + default: true + example: UklGRkbiBABXQVZFZm10IBAAAAABA... + description: |+ + Input wav file in base64 format. + srt: + x-name: srt + type: array + default: false + example: [{seqNum: 1,start: 1.0,end: 4.0}] + description: |+ + Optional. An ordered array of utterance struct. Used for time-coding. + items: + oneOf: + - type: object + properties: + end: + x-name: end + type: number + format: float + default: false + example: "4.0" + description: |+ + "End time of utterance, in seconds. Offset from the start of stream." + seqNum: + x-name: seqNum + type: number + default: false + example: "1" + description: |+ + "Running sequence. Starts from 1." + start: + x-name: start + type: number + format: float + default: false + example: "1.0" + description: |+ + "Start time of utterance, in seconds. Offset from the start of stream." + versions: + type: object + properties: + v1.1.0: + type: array + items: + oneOf: + - type: string + example: Published Date - Jan 22, 2021 + description: Model name update + v1.0.0: + type: array + items: + oneOf: + - type: string + example: Published Date - Dec 09, 2020 + description: Standardizing Output JSON + + v0.1.0: + type: array + items: + oneOf: + - type: string + example: Published Date - Jul 03,2020 + description: Initial version release + securitySchemes: + APIAuthorizer: + type: apiKey + name: x-api-key + in: header + x-amazon-apigateway-authtype: custom + description: Authentication is done using the x-api-key in the request header. diff --git a/voice/automatic_voice_recognition_eng.yaml b/voice/automatic_voice_recognition_eng.yaml new file mode 100644 index 000000000..94fbad094 --- /dev/null +++ b/voice/automatic_voice_recognition_eng.yaml @@ -0,0 +1,219 @@ +openapi: 3.0.1 +info: + title: Automatic Voice Recognition ENG + description: |+ + This Voice microservice takes in an audio file (in WAV format at 16kHz) and transcribes English speech content within the input file into text. + + The Automatic Speech Recognition (ASR) AI model is employed to understand the mapping of sound features to actual words in English. + + Use this microservice if the audio file consists of mostly speech with no long pauses in between. + version: '0.1.0' +servers: + - url: 'https://apis.sentient.io' +tags: +- name: "v0.1.0" + description: "Published Date - Jun 18, 2018" +paths: + /microservices/voice/asreng/v0.1/getpredictions: + post: + tags: + - v0.1.0 + responses: + '200': + description: success response + content: + application/json: + schema: + $ref: '#/components/schemas/success' + example: + message: Hi there + status: success + '401': + description: Unauthorized + content: + application/json: + schema: + $ref: '#/components/schemas/unauthorized' + '402': + description: Payment Required + content: + application/json: + schema: + $ref: '#/components/schemas/paymentrequired' + '403': + description: Forbidden + content: + application/json: + schema: + $ref: '#/components/schemas/forbidden' + '404': + description: Not Found + content: + application/json: + schema: + $ref: '#/components/schemas/notfound' + '419': + description: Input Field Missing + content: + application/json: + schema: + $ref: '#/components/schemas/inputfieldmissing' + '420': + description: Input Limit Exceeded + content: + application/json: + schema: + $ref: '#/components/schemas/inputlimitexceeded' + '422': + description: Invalid Input + content: + application/json: + schema: + $ref: '#/components/schemas/invalidinput' + '500': + description: Internal Server Error + content: + application/json: + schema: + $ref: '#/components/schemas/servererror' + '504': + description: Gateway Timeout + content: + application/json: + schema: + $ref: '#/components/schemas/gatewaytimeout' + security: + - APIAuthorizer: [] + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/input' + required: true +components: + schemas: + success: + type: object + properties: + message: + x-name: message + type: string + example: Hi there + description: Converted Text + status: + x-name: status + type: string + example: success + description: The status of the API call success/failure + unauthorized: + type: object + properties: + message: + type: string + example: Missing Authentication Token + status: + type: string + example: Failure + forbidden: + type: object + properties: + message: + type: string + example: Access Denied Unauthorized User + status: + type: string + example: Failure + paymentrequired: + type: object + properties: + message: + type: string + example: Insufficient Credits Kindly Top Up + status: + type: string + example: Failure + notfound: + type: object + properties: + message: + type: string + example: Invalid Request URL + status: + type: string + example: Failure + servererror: + type: object + properties: + message: + type: string + example: Internal Server Error + status: + type: string + example: Failure + gatewaytimeout: + type: object + properties: + message: + type: string + example: Request Timeout + status: + type: string + example: Failure + inputfieldmissing: + type: object + properties: + message: + type: string + example: Input Field Missing + status: + type: string + example: Failure + inputlimitexceeded: + type: object + properties: + message: + type: string + example: Input Limit Exceeded + status: + type: string + example: Failure + invalidinput: + type: object + properties: + message: + type: string + example: Invalid Input + status: + type: string + example: Failure + input: + type: object + required: + - audio + properties: + audio: + x-name: audio + type: string + default: true + example: data:audio/wav;base64,UklGRkbiBABXQVZFZm10IBAAAAABA... + description: |+ + Input audio file in base64 format. It also needs to be prefixed by the data type and encoding. + + data:audio/wav;base64, + versions: + type: object + properties: + v0.1.0: + type: array + items: + oneOf: + - type: string + example: Published Date - Jun 18,2018 + description: Initial version release + securitySchemes: + APIAuthorizer: + type: apiKey + name: x-api-key + in: header + x-amazon-apigateway-authtype: custom + description: Authentication is done using the x-api-key in the request header diff --git a/voice/online_automatic_speech_recognition_eng_sg.yaml b/voice/online_automatic_speech_recognition_eng_sg.yaml new file mode 100644 index 000000000..d74750dfa --- /dev/null +++ b/voice/online_automatic_speech_recognition_eng_sg.yaml @@ -0,0 +1,17 @@ +# This is a testing yaml file fir MS that does not have a proper yaml documentation +# API Documentation Platfrom will check if the yaml file has a "html" key +# If have "html", will read HTML content and hide all other API documentation element +info: + title: Online Automatic Speech Recognition ENG (SG) + description: >- + This Utility microservice converts audio format to the WAV format.

The encoding scheme, bitrate, sample rate of the output WAV are to be specified.

Authentication:

Authentication is done using the x-api-key in the request header. + version: '0.1.0' +# tags must include in to the documentation, to read the description text for published date +tags: +- name: "v0.1.0" + description: "Published Date - Apr 17, 2020" +html: |+ +
+ +
diff --git a/voice/online_command_automatic_speech_recognition_eng_sg.yaml b/voice/online_command_automatic_speech_recognition_eng_sg.yaml new file mode 100644 index 000000000..8dbaeec6a --- /dev/null +++ b/voice/online_command_automatic_speech_recognition_eng_sg.yaml @@ -0,0 +1,10 @@ +info: + title: Online Command Automatic Speech Recognition ENG (SG) + version: '0.1.0' +# tags must include in to the documentation, to read the description text for published date +tags: +- name: "v0.1.0" + description: "Published Date - Aug 31, 2020" +html: |+ + diff --git a/voice/text-to-speech_chi.yaml b/voice/text-to-speech_chi.yaml new file mode 100644 index 000000000..9b7fccfe3 --- /dev/null +++ b/voice/text-to-speech_chi.yaml @@ -0,0 +1,228 @@ +openapi: 3.0.1 +info: + title: Text-To-Speech CHI + description: |+ + This Voice microservice converts Mandarin text into speech in a female voice. + + The Text-to-Speech AI generated synthesized voice speaks with native Mandarin accent. + + Do ensure that your text is **within 750 characters**. + x-additionalinfo: |+ + Suggested Use Cases: + - Voice bots in contact centers - Deliver a better voice experience for customer service by dynamically generating speech, instead of playing static, pre-recorded audio. Engage with synthesized voices that give callers a sense of familiarity and personalization. + + - Voice generation in devices - Enable natural communications with users by empowering your devices to speak humanlike voices. Build an end-to-end voice user interface together with Speech-to-Text and improve user experience with easy and engaging interactions. + + - Accessible EPGs (Electronic Program Guides) - Implement text-to-speech functionality in EPGs to provide a better user experience to customers and meet accessibility requirements for services and applications. + version: '0.1.0' + x-subscribelink: text-to-speech_chi +servers: + - url: 'https://apis.sentient.io' +tags: +- name: "v0.1.0" + description: "Published Date - Sep 28, 2018" +paths: + /microservices/voice/ttssch/v0.1/getpredictions: + post: + tags: + - v0.1.0 + responses: + '200': + description: success response + content: + application/json: + schema: + $ref: '#/components/schemas/success' + example: + audioContent: UklGRiQAAABXQVZFZm10IBAAAAABAAEAgD4AAAB9AAACABAAZGF0YQAAAAA= + message: Successfully Processed + status: Success + '401': + description: Unauthorized + content: + application/json: + schema: + $ref: '#/components/schemas/unauthorized' + '402': + description: Payment Required + content: + application/json: + schema: + $ref: '#/components/schemas/paymentrequired' + '403': + description: Forbidden + content: + application/json: + schema: + $ref: '#/components/schemas/forbidden' + '404': + description: Not Found + content: + application/json: + schema: + $ref: '#/components/schemas/notfound' + '419': + description: Input Field Missing + content: + application/json: + schema: + $ref: '#/components/schemas/inputfieldmissing' + '413': + description: Input Limit Exceeded + content: + application/json: + schema: + $ref: '#/components/schemas/inputlimitexceeded' + '415': + description: Invalid Input + content: + application/json: + schema: + $ref: '#/components/schemas/invalidinput' + '500': + description: Internal Server Error + content: + application/json: + schema: + $ref: '#/components/schemas/servererror' + '504': + description: Gateway Timeout + content: + application/json: + schema: + $ref: '#/components/schemas/gatewaytimeout' + security: + - APIAuthorizer: [] + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/input' + required: true +components: + schemas: + success: + type: object + properties: + message: + type: string + example: Successfully Processed + description: Detail description on the api status + status: + type: string + example: Success + description: The status of the API call success/failure + audioContent: + type: string + example: UklGRiQAAABXQVZFZm10IBAAAAABAAEAgD4AAAB9AAACABAAZGF0YQAAAAA= + description: Audio file converted to base64 encoded string. + unauthorized: + type: object + properties: + message: + type: string + example: Missing Authentication Token + status: + type: string + example: Failure + forbidden: + type: object + properties: + message: + type: string + example: Access Denied Unauthorized User + status: + type: string + example: Failure + invalidinput: + type: object + properties: + message: + type: string + example: Invalid Input + status: + type: string + example: Failure + paymentrequired: + type: object + properties: + message: + type: string + example: Insufficient Credits Kindly Top Up + status: + type: string + example: Failure + notfound: + type: object + properties: + message: + type: string + example: Invalid Request URL + status: + type: string + example: Failure + servererror: + type: object + properties: + message: + type: string + example: Internal Server Error + status: + type: string + example: Failure + gatewaytimeout: + type: object + properties: + message: + type: string + example: Request Timeout + status: + type: string + example: Failure + inputfieldmissing: + type: object + properties: + message: + type: string + example: Input Field Missing + status: + type: string + example: Failure + inputlimitexceeded: + type: object + properties: + message: + type: string + example: Input Limit Exceeded + status: + type: string + example: Failure + versions: + type: object + properties: + v0.1.0: + type: array + items: + oneOf: + - type: string + example: Published Date - Sep 28,2018 + description: Initial version release + input: + type: object + required: + - text + properties: + text: + x-name: text + type: string + default: true + example: 大家好 我叫 墓园 + description: |+ + Input text + securitySchemes: + APIAuthorizer: + type: apiKey + name: x-api-key + in: header + x-amazon-apigateway-authtype: custom + description: Authentication is done using the x-api-key in the request header diff --git a/voice/text-to-speech_eng.yaml b/voice/text-to-speech_eng.yaml new file mode 100644 index 000000000..b40128aff --- /dev/null +++ b/voice/text-to-speech_eng.yaml @@ -0,0 +1,347 @@ +openapi: 3.0.1 +info: + title: Text-To-Speech ENG + description: | + "This Voice microservice converts English text into speech in a female voice. + + The Text-to-Speech AI generated synthesized voice speaks with Singapore English accent. + + Do ensure that your text is within **2000 characters**. + x-additionalinfo: |+ + Suggested Use Cases: + - Transcribes spoken English words, sentences or phrases into written forms + + - Voice bots in contact centers - deliver a better voice experience for customer service by dynamically generating speech, instead of playing static, pre-recorded audio. Engage with synthesized voices that give callers a sense of familiarity and personalization. + + - Voice generation in devices - enable natural communications with users by empowering your devices to speak humanlike voices. Build an end-to-end voice user interface together with Speech-to-Text and improve user experience with easy and engaging interactions. + + - Accessible EPGs (Electronic Program Guides) - implement text-to-speech functionality in EPGs to provide a better user experience to customers and meet accessibility requirements for services and applications. + version: '0.1.0' + x-subscribelink: text-to-speech_eng +servers: + - url: 'https://apis.sentient.io' +tags: + - name: v0.1.0 + description: 'Published Date - Sep 28, 2018' +paths: + /microservices/voice/ttseng/v0.1/getpredictions: + post: + tags: + - v0.1.0 + responses: + '200': + description: success response + content: + application/json: + schema: + $ref: '#/components/schemas/success' + example: + audioContent: UklGRiQAAABXQVZFZm10IBAAAAABAAEAgD4AAAB9AAACABAAZGF0YQAAAAA= + message: Successfully Processed + status: Success + '401': + description: Unauthorized + content: + application/json: + schema: + $ref: '#/components/schemas/unauthorized' + '402': + description: Payment Required + content: + application/json: + schema: + $ref: '#/components/schemas/paymentrequired' + '403': + description: Forbidden + content: + application/json: + schema: + $ref: '#/components/schemas/forbidden' + '404': + description: Not Found + content: + application/json: + schema: + $ref: '#/components/schemas/notfound' + '419': + description: Input Field Missing + content: + application/json: + schema: + $ref: '#/components/schemas/inputfieldmissing' + '413': + description: Input Limit Exceeded + content: + application/json: + schema: + $ref: '#/components/schemas/inputlimitexceeded' + '415': + description: Invalid Input + content: + application/json: + schema: + $ref: '#/components/schemas/invalidinput' + '500': + description: Internal Server Error + content: + application/json: + schema: + $ref: '#/components/schemas/servererror' + '504': + description: Gateway Timeout + content: + application/json: + schema: + $ref: '#/components/schemas/gatewaytimeout' + security: + - APIAuthorizer: [] + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/input' + required: true + x-codeSamples: + - lang: Python + Python3 + source: |- + import http.client + + conn = http.client.HTTPSConnection("apis.sentient.io") + + payload = "{\"text\":\"Testing microservice\"}" + + headers = { + 'content-type': "application/json", + 'x-api-key': "REPLACE_KEY_VALUE" + } + + conn.request("POST", "/microservices/voice/ttseng/v0.1/getpredictions", payload, headers) + + res = conn.getresponse() + data = res.read() + + print(data.decode("utf-8")) + - lang: Csharp + Restsharp + source: |- + var client = new RestClient("https://apis.sentient.io/microservices/voice/ttseng/v0.1/getpredictions"); + var request = new RestRequest(Method.POST); + request.AddHeader("content-type", "application/json"); + request.AddHeader("x-api-key", "REPLACE_KEY_VALUE"); + request.AddParameter("application/json", "{\"text\":\"Testing microservice\"}", ParameterType.RequestBody); + IRestResponse response = client.Execute(request); + - lang: Go + Native + source: "package main\n\nimport (\n\t\"fmt\"\n\t\"strings\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://apis.sentient.io/microservices/voice/ttseng/v0.1/getpredictions\"\n\n\tpayload := strings.NewReader(\"{\\\"text\\\":\\\"Testing microservice\\\"}\")\n\n\treq, _ := http.NewRequest(\"POST\", url, payload)\n\n\treq.Header.Add(\"content-type\", \"application/json\")\n\treq.Header.Add(\"x-api-key\", \"REPLACE_KEY_VALUE\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}" + - lang: Java + Unirest + source: |- + HttpResponse response = Unirest.post("https://apis.sentient.io/microservices/voice/ttseng/v0.1/getpredictions") + .header("content-type", "application/json") + .header("x-api-key", "REPLACE_KEY_VALUE") + .body("{\"text\":\"Testing microservice\"}") + .asString(); + - lang: Node + Native + source: |- + const http = require("https"); + + const options = { + "method": "POST", + "hostname": "apis.sentient.io", + "port": null, + "path": "/microservices/voice/ttseng/v0.1/getpredictions", + "headers": { + "content-type": "application/json", + "x-api-key": "REPLACE_KEY_VALUE" + } + }; + + const req = http.request(options, function (res) { + const chunks = []; + + res.on("data", function (chunk) { + chunks.push(chunk); + }); + + res.on("end", function () { + const body = Buffer.concat(chunks); + console.log(body.toString()); + }); + }); + + req.write(JSON.stringify({text: 'Testing microservice'})); + req.end(); + - lang: Php + Curl + source: |- + "https://apis.sentient.io/microservices/voice/ttseng/v0.1/getpredictions", + CURLOPT_RETURNTRANSFER => true, + CURLOPT_ENCODING => "", + CURLOPT_MAXREDIRS => 10, + CURLOPT_TIMEOUT => 30, + CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, + CURLOPT_CUSTOMREQUEST => "POST", + CURLOPT_POSTFIELDS => "{\"text\":\"Testing microservice\"}", + CURLOPT_HTTPHEADER => [ + "content-type: application/json", + "x-api-key: REPLACE_KEY_VALUE" + ], + ]); + + $response = curl_exec($curl); + $err = curl_error($curl); + + curl_close($curl); + + if ($err) { + echo "cURL Error #:" . $err; + } else { + echo $response; + } + - lang: Ruby + Native + source: |- + require 'uri' + require 'net/http' + require 'openssl' + + url = URI("https://apis.sentient.io/microservices/voice/ttseng/v0.1/getpredictions") + + http = Net::HTTP.new(url.host, url.port) + http.use_ssl = true + http.verify_mode = OpenSSL::SSL::VERIFY_NONE + + request = Net::HTTP::Post.new(url) + request["content-type"] = 'application/json' + request["x-api-key"] = 'REPLACE_KEY_VALUE' + request.body = "{\"text\":\"Testing microservice\"}" + + response = http.request(request) + puts response.read_body +components: + schemas: + success: + type: object + properties: + message: + type: string + example: Successfully Processed + description: Detail description on the api status + status: + type: string + example: Success + description: The status of the API call success/failure + audioContent: + type: string + example: UklGRiQAAABXQVZFZm10IBAAAAABAAEAgD4AAAB9AAACABAAZGF0YQAAAAA= + description: Audio file converted to base64 encoded string. + unauthorized: + type: object + properties: + message: + type: string + example: Missing Authentication Token + status: + type: string + example: Failure + invalidinput: + type: object + properties: + message: + type: string + example: Invalid Input + status: + type: string + example: Failure + forbidden: + type: object + properties: + message: + type: string + example: Access Denied Unauthorized User + status: + type: string + example: Failure + paymentrequired: + type: object + properties: + message: + type: string + example: Insufficient Credits Kindly Top Up + status: + type: string + example: Failure + notfound: + type: object + properties: + message: + type: string + example: Invalid Request URL + status: + type: string + example: Failure + servererror: + type: object + properties: + message: + type: string + example: Internal Server Error + status: + type: string + example: Failure + gatewaytimeout: + type: object + properties: + message: + type: string + example: Request Timeout + status: + type: string + example: Failure + inputfieldmissing: + type: object + properties: + message: + type: string + example: Input Field Missing + status: + type: string + example: Failure + inputlimitexceeded: + type: object + properties: + message: + type: string + example: Input Limit Exceeded + status: + type: string + example: Failure + versions: + type: object + properties: + v0.1.0: + type: array + items: + oneOf: + - type: string + example: 'Published Date - Sep 28,2018' + description: Initial version release + input: + type: object + required: + - text + properties: + text: + x-name: text + type: string + default: true + example: Testing microservice + description: | + Input text + securitySchemes: + APIAuthorizer: + type: apiKey + name: x-api-key + in: header + x-amazon-apigateway-authtype: custom + description: Authentication is done using the x-api-key in the request header diff --git a/voice/voice_activity_detection_eng.yaml b/voice/voice_activity_detection_eng.yaml new file mode 100644 index 000000000..021359beb --- /dev/null +++ b/voice/voice_activity_detection_eng.yaml @@ -0,0 +1,245 @@ +openapi: 3.0.1 +info: + title: Voice Activity Detection ENG + description: |+ + This Voice microservice detects utterances in the input audio and outputs the start and end time of these utterances. + + An utterance is the smallest unit of speech. It is a continuous piece of speech beginning and ending with a clear pause. + x-additionalinfo: |+ + Suggested Use Cases: + - Narrate a blurb or chunk of text in English + + - Improve customer service - empower a customer service system by adding IVR (interactive voice response) and agent conversations to call centers. Perform analytics on conversation data to gain more insights into the calls and customers. + + - Enable voice control - implement voice commands such as “turn the volume up,” and voice search such as saying “what is the temperature in Paris?” + + - Transcribe multimedia content - transcribe audio and video to include captions and improve audience reach and experience. For example, this microservice can be used for indexing or subtitling video and/or multispeaker content; similar to video captioning on YouTube. + version: '0.1.0' + x-subscribelink: voice_activity_detection_eng +servers: + - url: 'https://apis.sentient.io' +tags: +- name: "v0.1.0" + description: "Published Date - Jul 03, 2020" +paths: + /microservices/voice/vad/v0.1/getpredictions: + post: + tags: + - v0.1.0 + responses: + '200': + description: success response + content: + application/json: + schema: + $ref: '#/components/schemas/success' + example: + results: [{end: 23.72,seqNum: 1,start: 0.64}] + + '401': + description: Unauthorized + content: + application/json: + schema: + $ref: '#/components/schemas/unauthorized' + '402': + description: Payment Required + content: + application/json: + schema: + $ref: '#/components/schemas/paymentrequired' + '403': + description: Forbidden + content: + application/json: + schema: + $ref: '#/components/schemas/forbidden' + '404': + description: Not Found + content: + application/json: + schema: + $ref: '#/components/schemas/notfound' + '419': + description: Input Field Missing + content: + application/json: + schema: + $ref: '#/components/schemas/inputfieldmissing' + '420': + description: Input Limit Exceeded + content: + application/json: + schema: + $ref: '#/components/schemas/inputlimitexceeded' + '422': + description: Invalid Input + content: + application/json: + schema: + $ref: '#/components/schemas/invalidinput' + '500': + description: Internal Server Error + content: + application/json: + schema: + $ref: '#/components/schemas/servererror' + '504': + description: Gateway Timeout + content: + application/json: + schema: + $ref: '#/components/schemas/gatewaytimeout' + security: + - APIAuthorizer: [] + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/input' + required: true +components: + schemas: + success: + type: object + properties: + results: + type: array + example: [{end: 23.72,seqNum: 1,start: 0.64}] + description: List of details of start and end time of utterances in the input audio + items: + oneOf: + - type: object + properties: + end: + type: number + format: float + example: 23.72 + description: End time of utterance, in seconds. Offset from the start of stream. + seqNum: + type: number + example: 1 + description: Running sequence. Starts from 1. + start: + type: number + format: float + example: 0.64 + description: Start time of utterance, in seconds. Offset from the start of stream. + unauthorized: + type: object + properties: + message: + type: string + example: Missing Authentication Token + status: + type: string + example: Failure + forbidden: + type: object + properties: + message: + type: string + example: Access Denied Unauthorized User + status: + type: string + example: Failure + paymentrequired: + type: object + properties: + message: + type: string + example: Insufficient Credits Kindly Top Up + status: + type: string + example: Failure + notfound: + type: object + properties: + message: + type: string + example: Invalid Request URL + status: + type: string + example: Failure + invalidinput: + type: object + properties: + message: + type: string + example: Invalid Input + status: + type: string + example: Failure + servererror: + type: object + properties: + message: + type: string + example: Internal Server Error + status: + type: string + example: Failure + gatewaytimeout: + type: object + properties: + message: + type: string + example: Request Timeout + status: + type: string + example: Failure + inputfieldmissing: + type: object + properties: + message: + type: string + example: Input Field Missing + status: + type: string + example: Failure + inputlimitexceeded: + type: object + properties: + message: + type: string + example: Input Limit Exceeded + status: + type: string + example: Failure + input: + type: object + required: + - wav_base64 + properties: + wav_base64: + x-name: wav_base64 + type: string + default: true + example: UklGRkbiBABXQVZFZm10IBAAAAABA... + description: |+ + Required. Input audio file in base64 format + threshold: + x-name: threshold + type: number + format: float + default: false + example: 0.2 + description: |+ + Optional. Threshold ranges between 0.0 and 1.0 and default is 0.4 + versions: + type: object + properties: + v0.1.0: + type: array + items: + oneOf: + - type: string + example: Published Date - Jul 03,2020 + description: Initial version release + securitySchemes: + APIAuthorizer: + type: apiKey + name: x-api-key + in: header + x-amazon-apigateway-authtype: custom + description: Authentication is done using the x-api-key in the request header diff --git a/voice/voice_activity_detection_eng_v1.0.yaml b/voice/voice_activity_detection_eng_v1.0.yaml new file mode 100644 index 000000000..0ec7ac1cf --- /dev/null +++ b/voice/voice_activity_detection_eng_v1.0.yaml @@ -0,0 +1,265 @@ +openapi: 3.0.1 +info: + title: Voice Activity Detection ENG + description: |+ + This Voice microservice detects utterances in the input audio and outputs the start and end time of these utterances. + + An utterance is the smallest unit of speech. It is a continuous piece of speech beginning and ending with a clear pause. + version: '1.0.0' + x-additionalinfo: |+ + Suggested Use Cases: + - Narrate a blurb or chunk of text in English + - Improve customer service - empower a customer service system by adding IVR (interactive voice response) and agent conversations to call centers. Perform analytics on conversation data to gain more insights into the calls and customers. + - Enable voice control - implement voice commands such as “turn the volume up,” and voice search such as saying “what is the temperature in Paris?” + - Transcribe multimedia content - transcribe audio and video to include captions and improve audience reach and experience. For example, this microservice can be used for indexing or subtitling video and/or multispeaker content; similar to video captioning on YouTube. + x-subscribelink: voice_activity_detection_eng +servers: + - url: 'https://apis.sentient.io' +tags: +- name: "v1.0.0" + description: "Published Date - Dec 09, 2020" +paths: + /microservices/voice/vad/v1/getpredictions: + post: + tags: + - v1.0.0 + responses: + '200': + description: success response + content: + application/json: + schema: + $ref: '#/components/schemas/success' + example: + results: + output: [{end: 23.72,seqNum: 1,start: 0.64}] + message: Successfully Processed + status: Success + + '401': + description: Unauthorized + content: + application/json: + schema: + $ref: '#/components/schemas/unauthorized' + '402': + description: Payment Required + content: + application/json: + schema: + $ref: '#/components/schemas/paymentrequired' + '403': + description: Forbidden + content: + application/json: + schema: + $ref: '#/components/schemas/forbidden' + '404': + description: Not Found + content: + application/json: + schema: + $ref: '#/components/schemas/notfound' + '419': + description: Input Field Missing + content: + application/json: + schema: + $ref: '#/components/schemas/inputfieldmissing' + '413': + description: Input Limit Exceeded + content: + application/json: + schema: + $ref: '#/components/schemas/inputlimitexceeded' + '415': + description: Invalid Input + content: + application/json: + schema: + $ref: '#/components/schemas/invalidinput' + '500': + description: Internal Server Error + content: + application/json: + schema: + $ref: '#/components/schemas/servererror' + '504': + description: Gateway Timeout + content: + application/json: + schema: + $ref: '#/components/schemas/gatewaytimeout' + security: + - APIAuthorizer: [] + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/input' + required: true +components: + schemas: + success: + type: object + properties: + results: + type: object + description: The result of the API call. + example: { "" } + properties: + output: + type: array + example: [{end: 23.72,seqNum: 1,start: 0.64}] + description: List of details of start and end time of utterances in the input audio + items: + oneOf: + - type: object + properties: + end: + type: number + format: float + example: 23.72 + description: End time of utterance, in seconds. Offset from the start of stream. + seqNum: + type: number + example: 1 + description: Running sequence. Starts from 1. + start: + type: number + format: float + example: 0.64 + description: Start time of utterance, in seconds. Offset from the start of stream. + message: + type: string + example: Successfully Processed + description: Detail description on the API status + status: + type: string + example: Success + description: The status of the API call success/failure + unauthorized: + type: object + properties: + message: + type: string + example: Missing Authentication Token + status: + type: string + example: Failure + forbidden: + type: object + properties: + message: + type: string + example: Access Denied Unauthorized User + status: + type: string + example: Failure + invalidinput: + type: object + properties: + message: + type: string + example: Invalid Input + status: + type: string + example: Failure + paymentrequired: + type: object + properties: + message: + type: string + example: Insufficient Credits Kindly Top Up + status: + type: string + example: Failure + notfound: + type: object + properties: + message: + type: string + example: Invalid Request URL + status: + type: string + example: Failure + servererror: + type: object + properties: + message: + type: string + example: Internal Server Error + status: + type: string + example: Failure + gatewaytimeout: + type: object + properties: + message: + type: string + example: Request Timeout + status: + type: string + example: Failure + inputfieldmissing: + type: object + properties: + message: + type: string + example: Input Field Missing + status: + type: string + example: Failure + inputlimitexceeded: + type: object + properties: + message: + type: string + example: Input Limit Exceeded + status: + type: string + example: Failure + input: + type: object + required: + - wav_base64 + properties: + wav_base64: + x-name: wav_base64 + type: string + default: true + example: UklGRkbiBABXQVZFZm10IBAAAAABA... + description: |+ + Required. Input audio file in base64 format. + threshold: + x-name: threshold + type: number + format: float + default: false + example: 0.2 + description: |+ + Optional. Threshold ranges between 0.0 and 1.0 and default is 0.4 + versions: + type: object + properties: + v1.0.0: + type: array + items: + oneOf: + - type: string + example: Published Date - Dec 09, 2020 + description: Standardizing Output JSON + v0.1.0: + type: array + items: + oneOf: + - type: string + example: Published Date - Jul 03,2020 + description: Initial version release + securitySchemes: + APIAuthorizer: + type: apiKey + name: x-api-key + in: header + x-amazon-apigateway-authtype: custom + description: Authentication is done using the x-api-key in the request header From 43264f1a28cfd3ffe1e940f5b2d4ea18217873f9 Mon Sep 17 00:00:00 2001 From: Priyadharshini Date: Thu, 11 Feb 2021 21:58:09 +0530 Subject: [PATCH 410/792] removed unwanted files --- yaml/amenities_hardcourts_hdb_sg.yaml | 236 --- yaml/amenities_lamp_posts_hdb_sg.yaml | 238 --- yaml/amenities_shelters_hdb_sg.yaml | 241 --- ..._with_voice_activity_detection_eng_sg.yaml | 261 --- ..._voice_activity_detection_eng_sg_v1.0.yaml | 299 --- yaml/audio_format_convertor.yaml | 253 --- yaml/automatic_speech_recognition_chi_sg.yaml | 244 --- yaml/automatic_speech_recognition_eng.yaml | 203 -- yaml/automatic_speech_recognition_eng_sg.yaml | 287 --- ...omatic_speech_recognition_eng_sg_v1.0.yaml | 317 --- yaml/automatic_voice_recognition_eng.yaml | 219 --- yaml/base64-decoder.yaml | 220 --- yaml/base64-encoder.yaml | 237 --- yaml/base64-file-decode.yaml | 220 --- yaml/base64-file-encode.yaml | 237 --- yaml/building_addresses_hdb_sg.yaml | 415 ---- yaml/carpark_hdb_sg.yaml | 506 ----- yaml/commercial_directories_hdb_sg.yaml | 520 ----- yaml/csv-json_convertor.yaml | 232 --- yaml/d&b_basic_individual_search_sg.yaml | 1307 ------------- yaml/d&b_brief_financial_information_sg.yaml | 1404 -------------- yaml/d&b_business_check_plus_sg.yaml | 1705 ----------------- yaml/d&b_business_check_sg.yaml | 1149 ----------- yaml/decryption_using_pki_key.yaml | 225 --- yaml/demographics_classification.yaml | 293 --- yaml/demographics_hdb_sg.yaml | 448 ----- yaml/directory_of_singapore_startups.yaml | 548 ------ yaml/document_convertor_eng.yaml | 235 --- yaml/download_dataset.yaml | 10 - yaml/encryption_using_pki_key.yaml | 225 --- yaml/face_recognition_politicians_sg.yaml | 271 --- yaml/face_recognition_v1.0.yaml | 358 ---- ...tness_stations_and_playgrounds_hdb_sg.yaml | 237 --- yaml/flat_ownership_hdb_sg.yaml | 449 ----- yaml/index.yaml | 255 --- yaml/inverse_text_normalisation_eng.yaml | 228 --- yaml/inverse_text_normalisation_eng_v1.0.yaml | 248 --- yaml/json-csv_convertor.yaml | 233 --- yaml/landmark_detection_jp.yaml | 237 --- yaml/landmark_detection_sg.yaml | 241 --- yaml/named-entity_recognition_eng.yaml | 264 --- yaml/named-entity_recognition_eng_v1.0.yaml | 269 --- yaml/named-entity_recognition_jp.yaml | 255 --- yaml/named-entity_recognition_jp_v1.0.yaml | 329 ---- yaml/named-entity_recognition_thai.yaml | 237 --- yaml/named-entity_recognition_thai_v1.0.yaml | 331 ---- yaml/newspaper_article_scraper.yaml | 325 ---- yaml/object_detection.yaml | 250 --- yaml/object_detection_v1.0.yaml | 278 --- ...e_automatic_speech_recognition_eng_sg.yaml | 17 - ...d_automatic_speech_recognition_eng_sg.yaml | 10 - yaml/page_profiler_eng.yaml | 255 --- yaml/page_profiler_eng_v2.0.yaml | 228 --- yaml/page_profiler_eng_v2.1.yaml | 269 --- yaml/page_profiler_jp.yaml | 335 ---- yaml/page_profiler_thai.yaml | 346 ---- yaml/pdf_extractor.yaml | 267 --- yaml/people_counting.yaml | 247 --- yaml/people_counting_v1.0.yaml | 259 --- yaml/pki_key_generator.yaml | 216 --- yaml/residential_sales_and_rental_hdb_sg.yaml | 496 ----- yaml/script_alignment.yaml | 277 --- yaml/script_alignment_v1.0.yaml | 302 --- yaml/season_parking_availability_hdb_sg.yaml | 440 ----- yaml/sentiment-analysis-aws.yaml | 186 -- yaml/sentiment-analysis-google.yaml | 176 -- yaml/spacy_named-entity_recognition_eng.yaml | 317 --- yaml/staple_invoice.yaml | 223 --- yaml/staple_receipt.yaml | 1573 --------------- yaml/taxonomy_matcher_eng.yaml | 235 --- yaml/taxonomy_matcher_eng_v1.0.yaml | 257 --- yaml/text-to-speech_chi.yaml | 228 --- yaml/text-to-speech_eng.yaml | 347 ---- yaml/urls_retrieval.yaml | 271 --- yaml/video-to-audio_convertor.yaml | 239 --- yaml/video-to-image_convertor.yaml | 240 --- yaml/voice_activity_detection_eng.yaml | 245 --- yaml/voice_activity_detection_eng_v1.0.yaml | 265 --- yaml/web_scraper.yaml | 393 ---- yaml/wikipedia_retrieval.yaml | 314 --- yaml/wikipedia_retrieval_v1.0.yaml | 342 ---- yaml/word_sense_disambiguation_eng.yaml | 304 --- yaml/word_sense_disambiguation_eng_v1.0.yaml | 326 ---- yaml/youtube_video_downloader.yaml | 223 --- 84 files changed, 28897 deletions(-) delete mode 100644 yaml/amenities_hardcourts_hdb_sg.yaml delete mode 100644 yaml/amenities_lamp_posts_hdb_sg.yaml delete mode 100644 yaml/amenities_shelters_hdb_sg.yaml delete mode 100644 yaml/asr_with_voice_activity_detection_eng_sg.yaml delete mode 100644 yaml/asr_with_voice_activity_detection_eng_sg_v1.0.yaml delete mode 100644 yaml/audio_format_convertor.yaml delete mode 100644 yaml/automatic_speech_recognition_chi_sg.yaml delete mode 100644 yaml/automatic_speech_recognition_eng.yaml delete mode 100644 yaml/automatic_speech_recognition_eng_sg.yaml delete mode 100644 yaml/automatic_speech_recognition_eng_sg_v1.0.yaml delete mode 100644 yaml/automatic_voice_recognition_eng.yaml delete mode 100644 yaml/base64-decoder.yaml delete mode 100644 yaml/base64-encoder.yaml delete mode 100644 yaml/base64-file-decode.yaml delete mode 100644 yaml/base64-file-encode.yaml delete mode 100644 yaml/building_addresses_hdb_sg.yaml delete mode 100644 yaml/carpark_hdb_sg.yaml delete mode 100644 yaml/commercial_directories_hdb_sg.yaml delete mode 100644 yaml/csv-json_convertor.yaml delete mode 100644 yaml/d&b_basic_individual_search_sg.yaml delete mode 100644 yaml/d&b_brief_financial_information_sg.yaml delete mode 100644 yaml/d&b_business_check_plus_sg.yaml delete mode 100644 yaml/d&b_business_check_sg.yaml delete mode 100644 yaml/decryption_using_pki_key.yaml delete mode 100644 yaml/demographics_classification.yaml delete mode 100644 yaml/demographics_hdb_sg.yaml delete mode 100644 yaml/directory_of_singapore_startups.yaml delete mode 100644 yaml/document_convertor_eng.yaml delete mode 100644 yaml/download_dataset.yaml delete mode 100644 yaml/encryption_using_pki_key.yaml delete mode 100644 yaml/face_recognition_politicians_sg.yaml delete mode 100644 yaml/face_recognition_v1.0.yaml delete mode 100644 yaml/fitness_stations_and_playgrounds_hdb_sg.yaml delete mode 100644 yaml/flat_ownership_hdb_sg.yaml delete mode 100644 yaml/index.yaml delete mode 100644 yaml/inverse_text_normalisation_eng.yaml delete mode 100644 yaml/inverse_text_normalisation_eng_v1.0.yaml delete mode 100644 yaml/json-csv_convertor.yaml delete mode 100644 yaml/landmark_detection_jp.yaml delete mode 100644 yaml/landmark_detection_sg.yaml delete mode 100644 yaml/named-entity_recognition_eng.yaml delete mode 100644 yaml/named-entity_recognition_eng_v1.0.yaml delete mode 100644 yaml/named-entity_recognition_jp.yaml delete mode 100644 yaml/named-entity_recognition_jp_v1.0.yaml delete mode 100644 yaml/named-entity_recognition_thai.yaml delete mode 100644 yaml/named-entity_recognition_thai_v1.0.yaml delete mode 100644 yaml/newspaper_article_scraper.yaml delete mode 100644 yaml/object_detection.yaml delete mode 100644 yaml/object_detection_v1.0.yaml delete mode 100644 yaml/online_automatic_speech_recognition_eng_sg.yaml delete mode 100644 yaml/online_command_automatic_speech_recognition_eng_sg.yaml delete mode 100644 yaml/page_profiler_eng.yaml delete mode 100644 yaml/page_profiler_eng_v2.0.yaml delete mode 100644 yaml/page_profiler_eng_v2.1.yaml delete mode 100644 yaml/page_profiler_jp.yaml delete mode 100644 yaml/page_profiler_thai.yaml delete mode 100644 yaml/pdf_extractor.yaml delete mode 100644 yaml/people_counting.yaml delete mode 100644 yaml/people_counting_v1.0.yaml delete mode 100644 yaml/pki_key_generator.yaml delete mode 100644 yaml/residential_sales_and_rental_hdb_sg.yaml delete mode 100644 yaml/script_alignment.yaml delete mode 100644 yaml/script_alignment_v1.0.yaml delete mode 100644 yaml/season_parking_availability_hdb_sg.yaml delete mode 100644 yaml/sentiment-analysis-aws.yaml delete mode 100644 yaml/sentiment-analysis-google.yaml delete mode 100644 yaml/spacy_named-entity_recognition_eng.yaml delete mode 100644 yaml/staple_invoice.yaml delete mode 100644 yaml/staple_receipt.yaml delete mode 100644 yaml/taxonomy_matcher_eng.yaml delete mode 100644 yaml/taxonomy_matcher_eng_v1.0.yaml delete mode 100644 yaml/text-to-speech_chi.yaml delete mode 100644 yaml/text-to-speech_eng.yaml delete mode 100644 yaml/urls_retrieval.yaml delete mode 100644 yaml/video-to-audio_convertor.yaml delete mode 100644 yaml/video-to-image_convertor.yaml delete mode 100644 yaml/voice_activity_detection_eng.yaml delete mode 100644 yaml/voice_activity_detection_eng_v1.0.yaml delete mode 100644 yaml/web_scraper.yaml delete mode 100644 yaml/wikipedia_retrieval.yaml delete mode 100644 yaml/wikipedia_retrieval_v1.0.yaml delete mode 100644 yaml/word_sense_disambiguation_eng.yaml delete mode 100644 yaml/word_sense_disambiguation_eng_v1.0.yaml delete mode 100644 yaml/youtube_video_downloader.yaml diff --git a/yaml/amenities_hardcourts_hdb_sg.yaml b/yaml/amenities_hardcourts_hdb_sg.yaml deleted file mode 100644 index d259b8da7..000000000 --- a/yaml/amenities_hardcourts_hdb_sg.yaml +++ /dev/null @@ -1,236 +0,0 @@ -openapi: 3.0.1 -info: - title: HDB Hardcourts Locations (SG) - x-subscribelink: amenities_hardcourts_hdb_sg - description: |+ - This Data microservice returns the indicative outline of hardcourts for all Housing Development Board of Singapore (HDB) Towns, HDB Estates and on HDB Land. The features were identified visually from high definition ortho-rectified aerial imagery and manually digitised. The imagery was obtained from Singapore Land Authority (SLA) (captured in 2014). Objects largely obstructed by trees, structures and / or shadow are likely not captured in this dataset. The outlines of partially obstructed objects were extrapolated where possible and may not fully represent the actual shape of the actual object. - As this is a dataset download microservice, a successful call will return a pre-signed URL where the entire dataset can be downloaded as a CSV file. - The HDB POTH programme makes selected public and non-public datasets available to developers and companies to improve their service offerings to benefit the lives of Singapore citizens. Sentient.io is proud to partner with HDB to manage and facilitate the sharing of data for the POTH Programme. - x-additionalinfo: |+ - Suggested Use Cases: - - Real estate services - can be used as a solution to extract information related to the types and number of hardcourts present in an area for people buying or renting a HDB home. - - Download the complete dataset using a pre-signed URL. It's a two steps process - - **Step 1:** Get the pre-signed URL - - Replace the correct x-api-key, and API endpoint - - > **curl -X GET -H "Content-Type: application/json" -H "x-api-key:XXXXX" <\>** - - **Step 2:** Download file - - Using the results.url (i.e) the pre-signed URL to download the dataset - - > **curl --request GET "results.url" >> "FILE_NAME"** - - **Data schema** - - | Name | Type | Size | Description | - |---|---|---|---|---| - | FEATID | Integer | N/A | Feature ID. Unique running number. | - | TYPE | Char | N/A | Captures the type of object. | - | LVL | Char | N/A | Captures whether the object is located at Ground level or Above Ground level. | - | QUALITY | Char | N/A | Captures whether the section of the feature was Fully Visible or Partially Visible. | - | INC_CRC | Varchar | 50 | Sub Location Id | - | FMEL_UPD_D | Datetime | N/A | Area of the feature | - | Shape__Length | Float | N/A | Length of the feature | - version: '0.1.0' -servers: - - url: 'https://api.sentient.io' -tags: -- name: "v0.1.0" - description: "Published Date - Mar 24, 2020" -paths: - /DaaS/prod/hdb/amenities/gs/csv/hardcourt/hdb: - get: - tags: - - v0.1.0 - responses: - '200': - description: success response - content: - application/json: - schema: - $ref: '#/components/schemas/success' - example: - results: - url: "" - status: Success - message: Successfully Processed - '401': - description: Unauthorized - content: - application/json: - schema: - $ref: '#/components/schemas/unauthorized' - '402': - description: Payment Required - content: - application/json: - schema: - $ref: '#/components/schemas/paymentrequired' - '403': - description: Forbidden - content: - application/json: - schema: - $ref: '#/components/schemas/forbidden' - '404': - description: Not Found - content: - application/json: - schema: - $ref: '#/components/schemas/notfound' - '419': - description: Input Field Missing - content: - application/json: - schema: - $ref: '#/components/schemas/inputfieldmissing' - '413': - description: Input Limit Exceeded - content: - application/json: - schema: - $ref: '#/components/schemas/inputlimitexceeded' - '415': - description: Invalid Input - content: - application/json: - schema: - $ref: '#/components/schemas/invalidinput' - '500': - description: Internal Server Error - content: - application/json: - schema: - $ref: '#/components/schemas/servererror' - '504': - description: Gateway Timeout - content: - application/json: - schema: - $ref: '#/components/schemas/gatewaytimeout' - security: - - APIAuthorizer: [] -components: - schemas: - success: - type: object - properties: - results: - type: object - example: { "" } - description: Json Object of returned results - properties: - url: - type: string - description: pre-signed URL to download the file - example: "" - status: - type: string - example: Success - description: The status of the API call. success/failure - message: - type: string - example: Successfully Processed - description: Detail description on the api status - unauthorized: - type: object - properties: - message: - type: string - example: Missing Authentication Token - status: - type: string - example: Failure - forbidden: - type: object - properties: - message: - type: string - example: Access Denied Unauthorized User - status: - type: string - example: Failure - paymentrequired: - type: object - properties: - message: - type: string - example: Insufficient Credits Kindly Top Up - status: - type: string - example: Failure - notfound: - type: object - properties: - message: - type: string - example: Invalid Request URL - status: - type: string - example: Failure - servererror: - type: object - properties: - message: - type: string - example: Internal Server Error - status: - type: string - example: Failure - gatewaytimeout: - type: object - properties: - message: - type: string - example: Request Timeout - status: - type: string - example: Failure - inputfieldmissing: - type: object - properties: - message: - type: string - example: Input Field Missing - status: - type: string - example: Failure - inputlimitexceeded: - type: object - properties: - message: - type: string - example: Input Limit Exceeded - status: - type: string - example: Failure - invalidinput: - type: object - properties: - message: - type: string - example: Invalid Input - status: - type: string - example: Failure - versions: - type: object - properties: - v0.1.0: - type: array - items: - oneOf: - - type: string - example: Published Date - Mar 24, 2020 - description: Initial version release - securitySchemes: - APIAuthorizer: - type: apiKey - name: x-api-key - in: header - x-amazon-apigateway-authtype: custom - description: Authentication is done using the x-api-key in the request header. diff --git a/yaml/amenities_lamp_posts_hdb_sg.yaml b/yaml/amenities_lamp_posts_hdb_sg.yaml deleted file mode 100644 index c5fb4f0ad..000000000 --- a/yaml/amenities_lamp_posts_hdb_sg.yaml +++ /dev/null @@ -1,238 +0,0 @@ -openapi: 3.0.1 -info: - title: HDB Lamp Posts Locations (SG) - x-subscribelink: amenities_lamp_posts_hdb_sg - description: |+ - This Data microservice returns the indicative location of lamp posts for all Housing Development Board of Singapore (HDB) Towns, HDB Estates and on HDB Land. The features were identified visually from high definition ortho-rectified aerial imagery and manually digitised. The imagery was obtained from Singapore Land Authority (SLA) (captured in 2014). Objects largely obstructed by trees, structures and / or shadow are likely not captured in this dataset. - As this is a dataset download microservice, a successful call will return a pre-signed URL where the entire dataset can be downloaded as a CSV file. - The HDB POTH programme makes selected public and non-public datasets available to developers and companies to improve their service offerings to benefit the lives of Singapore citizens. Sentient.io is proud to partner with HDB to manage and facilitate the sharing of data for the POTH Programme. - x-additionalinfo: |+ - Suggested Use Cases: - - Real estate services or social service solutions - can be used as a background check solution to extract information related to lampposts present in an area for people with certain preferences when buying or renting a HDB home. For example, the elderly may prefer HDB homes surrounded with more lampposts as they require more aid in terms of lighting when walking home. - - Download the complete dataset using a pre-signed URL. It's a two steps process - - **Step 1:** Get the pre-signed URL - - Replace the correct x-api-key, and API endpoint - - > **curl -X GET -H "Content-Type: application/json" -H "x-api-key:XXXXX" ** - - **Step 2:** Download file - - Using the results.url (i.e) the pre-signed URL to download the dataset - - > **curl --request GET "results.url" >> "FILE_NAME"** - - **Data schema** - - | Name | Type | Size | Description | - |---|---|---|---|---| - | FEATID | Integer | N/A | Feature ID. Unique running number. | - | TYPE | Char | N/A | Captures the type of object. | - | LVL | Char | N/A | Captures whether the object is located at Ground level or Above Ground level. | - | QUALITY | Char | N/A | Captures whether the section of the feature was Fully Visible or Partially Visible. | - | INC_CRC | Varchar | 50 | Sub Location Id | - | FMEL_UPD_D | Datetime | N/A | Area of the feature | - | x | Float | N/A | ESRI x coordinate | - | y | Float | N/A | ESRI y coordinate | - version: '0.1.0' -servers: - - url: 'https://api.sentient.io' -tags: -- name: "v0.1.0" - description: "Published Date - Mar 24, 2020" - -paths: - /DaaS/prod/hdb/amenities/gs/csv/lamppost/hdb: - get: - tags: - - v0.1.0 - responses: - '200': - description: success response - content: - application/json: - schema: - $ref: '#/components/schemas/success' - example: - results: - url: "" - status: Success - message: Successfully Processed - '401': - description: Unauthorized - content: - application/json: - schema: - $ref: '#/components/schemas/unauthorized' - '402': - description: Payment Required - content: - application/json: - schema: - $ref: '#/components/schemas/paymentrequired' - '403': - description: Forbidden - content: - application/json: - schema: - $ref: '#/components/schemas/forbidden' - '404': - description: Not Found - content: - application/json: - schema: - $ref: '#/components/schemas/notfound' - '419': - description: Input Field Missing - content: - application/json: - schema: - $ref: '#/components/schemas/inputfieldmissing' - '413': - description: Input Limit Exceeded - content: - application/json: - schema: - $ref: '#/components/schemas/inputlimitexceeded' - '415': - description: Invalid Input - content: - application/json: - schema: - $ref: '#/components/schemas/invalidinput' - '500': - description: Internal Server Error - content: - application/json: - schema: - $ref: '#/components/schemas/servererror' - '504': - description: Gateway Timeout - content: - application/json: - schema: - $ref: '#/components/schemas/gatewaytimeout' - security: - - APIAuthorizer: [] -components: - schemas: - success: - type: object - properties: - results: - type: object - example: { "" } - description: Json Object of returned results - properties: - url: - type: string - description: pre-signed URL to download the file - example: "" - status: - type: string - example: Success - description: The status of the API call. success/failure - message: - type: string - example: Successfully Processed - description: Detail description on the api status - unauthorized: - type: object - properties: - message: - type: string - example: Missing Authentication Token - status: - type: string - example: Failure - forbidden: - type: object - properties: - message: - type: string - example: Access Denied Unauthorized User - status: - type: string - example: Failure - paymentrequired: - type: object - properties: - message: - type: string - example: Insufficient Credits Kindly Top Up - status: - type: string - example: Failure - notfound: - type: object - properties: - message: - type: string - example: Invalid Request URL - status: - type: string - example: Failure - servererror: - type: object - properties: - message: - type: string - example: Internal Server Error - status: - type: string - example: Failure - gatewaytimeout: - type: object - properties: - message: - type: string - example: Request Timeout - status: - type: string - example: Failure - inputfieldmissing: - type: object - properties: - message: - type: string - example: Input Field Missing - status: - type: string - example: Failure - inputlimitexceeded: - type: object - properties: - message: - type: string - example: Input Limit Exceeded - status: - type: string - example: Failure - invalidinput: - type: object - properties: - message: - type: string - example: Invalid Input - status: - type: string - example: Failure - versions: - type: object - properties: - v0.1.0: - type: array - items: - oneOf: - - type: string - example: Published Date - Mar 24, 2020 - description: Initial version release - securitySchemes: - APIAuthorizer: - type: apiKey - name: x-api-key - in: header - x-amazon-apigateway-authtype: custom - description: Authentication is done using the x-api-key in the request header. diff --git a/yaml/amenities_shelters_hdb_sg.yaml b/yaml/amenities_shelters_hdb_sg.yaml deleted file mode 100644 index db33f0c34..000000000 --- a/yaml/amenities_shelters_hdb_sg.yaml +++ /dev/null @@ -1,241 +0,0 @@ -openapi: 3.0.1 -info: - title: HDB Shelters Locations (SG) - x-subscribelink: amenities_shelters_hdb_sg - description: |+ - This Data microservice returns the indicative outline of shelters for all HDB Towns and Estates and only on HDB Land. The features were identified visually from high definition ortho-rectified aerial imagery and manually digitised. The imagery was obtained from SLA (captured in 2014). Objects largely obstructed by trees, structures and / or shadow are likely not captured in this dataset. The outlines of partially obstructed objects were extrapolated where possible and may not fully represent the actual shape of the actual object. Precinct Pavilions are not included in this microservice. - As this is a dataset download microservice, a successful call will return a pre-signed URL where the entire dataset can be downloaded as a CSV file. - The HDB POTH programme makes selected public and non-public datasets available to developers and companies to improve their service offerings to benefit the lives of Singapore citizens. Sentient.io is proud to partner with HDB to manage and facilitate the sharing of data for the POTH Programme. - x-additionalinfo: |+ - Suggested Use Cases: - - Real estate services - can be used as a solution to extract information related to the types and number of shelters present for people buying or renting a HDB home. - - - Property background checks - can be used as a background check service for retail shops owners looking to set up their shops in HDBs, as areas with shelters may induce the likelihood of more customers. - - - Can also be used as a solution to improve user awareness and personalization - for example, a weather app can refer a user to the nearest HDB shelter in the case of a rainy day. - - Download the complete dataset using a pre-signed URL. It's a two steps process - - **Step 1:** Get the pre-signed URL - - Replace the correct x-api-key, and API endpoint - - > **curl -X GET -H "Content-Type: application/json" -H "x-api-key:XXXXX" <\>** - - **Step 2:** Download file - - Using the results.url (i.e) the pre-signed URL to download the dataset - - > **curl --request GET "results.url" >> "FILE_NAME"** - - **Data schema** - - | Name | Type | Size | Description | - |---|---|---|---|---| - | FEATID | Integer | N/A | Feature ID. Unique running number. | - | TYPE | Char | N/A | Captures the type of object. | - | LVL | Char | N/A | Captures whether the object is located at Ground level or Above Ground level. | - | QUALITY | Char | N/A | Captures whether the section of the feature was Fully Visible or Partially Visible. | - | INC_CRC | Varchar | 50 | Sub Location Id | - | FMEL_UPD_D | Datetime | N/A | Area of the feature | - | Shape__Area | Float | N/A | Area of the feature | - | Shape__Length | Float | N/A | Length of the feature | - version: '0.1.0' -servers: - - url: 'https://api.sentient.io' -tags: -- name: "v0.1.0" - description: "Published Date - Mar 24, 2020" -paths: - /DaaS/prod/hdb/amenities/gs/csv/shelter/hdb: - get: - tags: - - v0.1.0 - responses: - '200': - description: success response - content: - application/json: - schema: - $ref: '#/components/schemas/success' - example: - results: - url: "" - status: Success - message: Successfully Processed - '401': - description: Unauthorized - content: - application/json: - schema: - $ref: '#/components/schemas/unauthorized' - '402': - description: Payment Required - content: - application/json: - schema: - $ref: '#/components/schemas/paymentrequired' - '403': - description: Forbidden - content: - application/json: - schema: - $ref: '#/components/schemas/forbidden' - '404': - description: Not Found - content: - application/json: - schema: - $ref: '#/components/schemas/notfound' - '419': - description: Input Field Missing - content: - application/json: - schema: - $ref: '#/components/schemas/inputfieldmissing' - '413': - description: Input Limit Exceeded - content: - application/json: - schema: - $ref: '#/components/schemas/inputlimitexceeded' - '415': - description: Invalid Input - content: - application/json: - schema: - $ref: '#/components/schemas/invalidinput' - '500': - description: Internal Server Error - content: - application/json: - schema: - $ref: '#/components/schemas/servererror' - '504': - description: Gateway Timeout - content: - application/json: - schema: - $ref: '#/components/schemas/gatewaytimeout' - security: - - APIAuthorizer: [] -components: - schemas: - success: - type: object - properties: - results: - type: object - example: { "" } - description: Json Object of returned results - properties: - url: - type: string - description: pre-signed URL to download the file - example: "" - status: - type: string - example: Success - description: The status of the API call. success/failure - message: - type: string - example: Successfully Processed - description: Detail description on the api status - unauthorized: - type: object - properties: - message: - type: string - example: Missing Authentication Token - status: - type: string - example: Failure - forbidden: - type: object - properties: - message: - type: string - example: Access Denied Unauthorized User - status: - type: string - example: Failure - paymentrequired: - type: object - properties: - message: - type: string - example: Insufficient Credits Kindly Top Up - status: - type: string - example: Failure - notfound: - type: object - properties: - message: - type: string - example: Invalid Request URL - status: - type: string - example: Failure - servererror: - type: object - properties: - message: - type: string - example: Internal Server Error - status: - type: string - example: Failure - gatewaytimeout: - type: object - properties: - message: - type: string - example: Request Timeout - status: - type: string - example: Failure - inputfieldmissing: - type: object - properties: - message: - type: string - example: Input Field Missing - status: - type: string - example: Failure - inputlimitexceeded: - type: object - properties: - message: - type: string - example: Input Limit Exceeded - status: - type: string - example: Failure - invalidinput: - type: object - properties: - message: - type: string - example: Invalid Input - status: - type: string - example: Failure - versions: - type: object - properties: - v0.1.0: - type: array - items: - oneOf: - - type: string - example: Published Date - Mar 24, 2020 - description: Initial version release - securitySchemes: - APIAuthorizer: - type: apiKey - name: x-api-key - in: header - x-amazon-apigateway-authtype: custom - description: Authentication is done using the x-api-key in the request header. diff --git a/yaml/asr_with_voice_activity_detection_eng_sg.yaml b/yaml/asr_with_voice_activity_detection_eng_sg.yaml deleted file mode 100644 index d69738753..000000000 --- a/yaml/asr_with_voice_activity_detection_eng_sg.yaml +++ /dev/null @@ -1,261 +0,0 @@ -openapi: 3.0.1 -info: - title: ASR with Voice Activity Detection ENG (SG) - description: |+ - This Voice microservice combines Voice Activity Detection feature and Automatic Speech Recognition capability. It detects speech in an audio file (.wav format) and transcribes English speech content from the audio stream into text. The transcript text is timestamped for each utterance. An utterance is a continuous piece of speech beginning and ending with a clear pause. - - This Voice microservice performs well on Singapore-accented English speech. For best performance, select the model which best matches the use-case: news_parliament, nsc_parliament, nscfull_8k. - - The size of your audio file should be **between 3 KB to 10 MB**. - version: '0.1.0' - x-additionalinfo: |+ - Suggested Use Cases: - - Combine this with the Text-to-Speech API to deliver voice-enabled experiences in IoT (Internet of Things) applications, such as implementing voice commands like “turn the volume up". - x-subscribelink: asr_with_voice_activity_detection_eng_sg -servers: - - url: 'https://apis.sentient.io' -tags: -- name: "v0.1.0" - description: "Published Date - Dec 14, 2019" -paths: - /microservices/voice/vadasr/v0.1/getpredictions: - post: - tags: - - v0.1.0 - responses: - '200': - description: success response - content: - application/json: - schema: - $ref: '#/components/schemas/success' - example: - - seqNum: 1 - start: 0.64 - end: 23.72 - text: HELLO WORLD - '401': - description: Unauthorized - content: - application/json: - schema: - $ref: '#/components/schemas/unauthorized' - '402': - description: Payment Required - content: - application/json: - schema: - $ref: '#/components/schemas/paymentrequired' - '403': - description: Forbidden - content: - application/json: - schema: - $ref: '#/components/schemas/forbidden' - '404': - description: Not Found - content: - application/json: - schema: - $ref: '#/components/schemas/notfound' - '419': - description: Input Field Missing - content: - application/json: - schema: - $ref: '#/components/schemas/inputfieldmissing' - '413': - description: Input Limit Exceeded - content: - application/json: - schema: - $ref: '#/components/schemas/inputlimitexceeded' - '415': - description: Invalid Input - content: - application/json: - schema: - $ref: '#/components/schemas/invalidinput' - '500': - description: Internal Server Error - content: - application/json: - schema: - $ref: '#/components/schemas/servererror' - '504': - description: Gateway Timeout - content: - application/json: - schema: - $ref: '#/components/schemas/gatewaytimeout' - security: - - APIAuthorizer: [] - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/input' - required: true -components: - schemas: - success: - type: object - properties: - end: - type: string - example: 23.72 - description: End time of utterance - seqNum: - type: string - example: 1 - description: Running sequence number starts from 1. - start: - type: integer - example: 0.64 - description: Start time of utterance - text: - type: string - description: Converted text from the input audio file - example: THE COMING YEAR LIFE FOR A REASON A CITIZEN OR A LIFETIME LIKE YOU WHEN SOMEONE IS IN YOUR LIFE A REASON IT USUALLY TO MEET IN NEED WITHIN YOU HAVE NEVER MET YOU BUT I LIKE YOU WHEN SOMEONE IS IN YOUR LIFE FOR A SEASON IS BECAUSE IT IS YOUR TURN TO SHARE LEARN AND GROW AND WANT SOMEONE IN YOUR LIFE FOR A LIFETIME IT CITY THROUGH LESSONS AND IF NOT WHAT THE PEOPLE - unauthorized: - type: object - properties: - message: - type: string - example: Missing Authentication Token - status: - type: string - example: Failure - forbidden: - type: object - properties: - message: - type: string - example: Access Denied Unauthorized User - status: - type: string - example: Failure - paymentrequired: - type: object - properties: - message: - type: string - example: Insufficient Credits Kindly Top Up - status: - type: string - example: Failure - notfound: - type: object - properties: - message: - type: string - example: Invalid Request URL - status: - type: string - example: Failure - servererror: - type: object - properties: - message: - type: string - example: Internal Server Error - status: - type: string - example: Failure - gatewaytimeout: - type: object - properties: - message: - type: string - example: Request Timeout - status: - type: string - example: Failure - inputfieldmissing: - type: object - properties: - message: - type: string - example: Input Field Missing - status: - type: string - example: Failure - inputlimitexceeded: - type: object - properties: - message: - type: string - example: Input Limit Exceeded - status: - type: string - example: Failure - invalidinput: - type: object - properties: - message: - type: string - example: Invalid Input - status: - type: string - example: Failure - input: - type: object - required: - - wav_base64 - - wav_url - properties: - model: - x-name: model - type: string - default: true - example: news_parliament - description: |+ - Model selection. For best performance, select the model which best matches the use-case: - - 1. news_parliament - 16 kHz, mono channel, .wav format. Trained on Singapore news and parliament corpus. - 2. nsc_parliament - 16 kHz, mono channel, .wav format. Trained on National Speech Corpus and parliament corpus. - 3. nscfull_8k - 8 kHz, mono channel, .wav format. Trained on National Speech Corpus. Trained on Full National Speech Corpus corpus. - wav_url/wav_base64: - x-name: wav_url/wav_base64 - type: string - default: true - example: https://api.sentient.io/test2.wav or UklGRpxNHQBXQVZFZm10IBAAAAABAAEAgD4AAAB9AAACABAAT ... - description: |+ - The public URL link to the wave file or Input audio wav file in base64 format. - - Mono channel, 8kHz / 16kHz sampling rate. - file_type: - x-name: file_type - type: string - default: true - example: wav - description: |+ - Input file extension. - - Currently supported formats: .wav - vad_threshold: - x-name: vad_threshold - type: number - format: float - default: true - example: 0.4 - description: |+ - 0.0 to 1.0. Lower will result in more sentence splits. Recommended value is 0.25. - versions: - type: object - properties: - v0.1.0: - type: array - items: - oneOf: - - type: string - example: Published Date - Dec 14,2019 - description: Initial version release - - securitySchemes: - APIAuthorizer: - type: apiKey - name: x-api-key - in: header - x-amazon-apigateway-authtype: custom - description: Authentication is done using the x-api-key in the request header diff --git a/yaml/asr_with_voice_activity_detection_eng_sg_v1.0.yaml b/yaml/asr_with_voice_activity_detection_eng_sg_v1.0.yaml deleted file mode 100644 index cce373106..000000000 --- a/yaml/asr_with_voice_activity_detection_eng_sg_v1.0.yaml +++ /dev/null @@ -1,299 +0,0 @@ -openapi: 3.0.1 -info: - title: ASR with Voice Activity Detection ENG (SG) - description: |+ - This Voice microservice combines Voice Activity Detection feature and Automatic Speech Recognition capability. It detects speech in an audio file (.wav format) and transcribes English speech content from the audio stream into text. The transcript text is timestamped for each utterance. An utterance is a continuous piece of speech beginning and ending with a clear pause. - This microservice performs well on Singaporean-accented English speech. For best performance, select the model which best matches the use-case, whether for prepared speech (16kHz) or telephony (8kHz). - - The size of your audio file should be **between 3 KB to 10 MB**. - version: '1.1.0' - x-additionalinfo: |+ - Suggested Use Cases: - - Combine this with the Text-to-Speech API to deliver voice-enabled experiences in IoT (Internet of Things) applications, such as implementing voice commands like “turn the volume up". - x-subscribelink: asr_with_voice_activity_detection_eng_sg -servers: - - url: 'https://apis.sentient.io' -tags: -- name: "v1.1.0" - description: "Published Date - Jan 22, 2021" -paths: - /microservices/voice/vadasr/v1/getpredictions: - post: - tags: - - v1.1.0 - responses: - '200': - description: success response - content: - application/json: - schema: - $ref: '#/components/schemas/success' - example: - results: - output: - - seqNum: 1 - start: 0.64 - end: 23.72 - text: HELLO WORLD - message: Successfully Processed - status: Success - '401': - description: Unauthorized - content: - application/json: - schema: - $ref: '#/components/schemas/unauthorized' - '402': - description: Payment Required - content: - application/json: - schema: - $ref: '#/components/schemas/paymentrequired' - '403': - description: Forbidden - content: - application/json: - schema: - $ref: '#/components/schemas/forbidden' - '404': - description: Not Found - content: - application/json: - schema: - $ref: '#/components/schemas/notfound' - '419': - description: Input Field Missing - content: - application/json: - schema: - $ref: '#/components/schemas/inputfieldmissing' - '413': - description: Input Limit Exceeded - content: - application/json: - schema: - $ref: '#/components/schemas/inputlimitexceeded' - '415': - description: Invalid Input - content: - application/json: - schema: - $ref: '#/components/schemas/invalidinput' - '500': - description: Internal Server Error - content: - application/json: - schema: - $ref: '#/components/schemas/servererror' - '504': - description: Gateway Timeout - content: - application/json: - schema: - $ref: '#/components/schemas/gatewaytimeout' - security: - - APIAuthorizer: [] - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/input' - required: true -components: - schemas: - success: - type: object - properties: - results: - type: object - description: The result of the API call. - example: { "" } - properties: - output: - type: array - example: [{end: 23.72,seqNum: 1,start: 0.64,text: HELLO WORLD }] - description: List of details of start and end time of utterances in the input audio - items: - oneOf: - - type: object - properties: - end: - type: string - example: 23.72 - description: End time of utterance - seqNum: - type: string - example: 1 - description: Running sequence number starts from 1. - start: - type: integer - example: 0.64 - description: Start time of utterance - text: - type: string - description: Converted text from the input audio file - example: THE COMING YEAR LIFE FOR A REASON A CITIZEN OR A LIFETIME LIKE YOU WHEN SOMEONE IS IN YOUR LIFE A REASON IT USUALLY TO MEET IN NEED WITHIN YOU HAVE NEVER MET YOU BUT I LIKE YOU WHEN SOMEONE IS IN YOUR LIFE FOR A SEASON IS BECAUSE IT IS YOUR TURN TO SHARE LEARN AND GROW AND WANT SOMEONE IN YOUR LIFE FOR A LIFETIME IT CITY THROUGH LESSONS AND IF NOT WHAT THE PEOPLE - message: - type: string - example: Successfully Processed - description: Detail description on the API status - status: - type: string - example: Success - description: The status of the API call success/failure - unauthorized: - type: object - properties: - message: - type: string - example: Missing Authentication Token - status: - type: string - example: Failure - forbidden: - type: object - properties: - message: - type: string - example: Access Denied Unauthorized User - status: - type: string - example: Failure - paymentrequired: - type: object - properties: - message: - type: string - example: Insufficient Credits Kindly Top Up - status: - type: string - example: Failure - notfound: - type: object - properties: - message: - type: string - example: Invalid Request URL - status: - type: string - example: Failure - servererror: - type: object - properties: - message: - type: string - example: Internal Server Error - status: - type: string - example: Failure - gatewaytimeout: - type: object - properties: - message: - type: string - example: Request Timeout - status: - type: string - example: Failure - inputfieldmissing: - type: object - properties: - message: - type: string - example: Input Field Missing - status: - type: string - example: Failure - inputlimitexceeded: - type: object - properties: - message: - type: string - example: Input Limit Exceeded - status: - type: string - example: Failure - invalidinput: - type: object - properties: - message: - type: string - example: Invalid Input - status: - type: string - example: Failure - input: - type: object - required: - - model - - wav_base64 - properties: - model: - x-name: model - type: string - default: true - example: prepared_speech - description: |+ - Model selection. For best performance, select the model which best matches the use-case: - - 1. prepared_speech - Better suited for transcribing prepared / formal speech (e.g. news or parliamentary speeches). 16 kHz, mono channel, .wav format. - 2. telephony - Better suited for conversational speech or telephony use cases. 8 kHz, mono channel, .wav format. - wav_base64: - x-name: wav_base64 - type: string - default: true - example: UklGRpxNHQBXQVZFZm10IBAAAAABAAEAgD4AAAB9AAACABAAT ... - description: |+ - Input audio wav file in base64 format. - - Mono channel, 8kHz / 16kHz sampling rate. - file_type: - x-name: file_type - type: string - default: true - example: wav - description: |+ - Input file extension. - - Currently supported formats: .wav - threshold: - x-name: threshold - type: number - format: float - default: true - example: 0.4 - description: |+ - 0.0 to 1.0. Lower will result in more sentence splits. Recommended value is 0.25. - versions: - type: object - properties: - v1.1.0: - type: array - items: - oneOf: - - type: string - example: Published Date - Jan 22, 2021 - description: Model name update - v1.0.0: - type: array - items: - oneOf: - - type: string - example: Published Date - Dec 09, 2020 - description: Standardizing Output JSON - - v0.1.0: - type: array - items: - oneOf: - - type: string - example: Published Date - Dec 14,2019 - description: Initial version release - - securitySchemes: - APIAuthorizer: - type: apiKey - name: x-api-key - in: header - x-amazon-apigateway-authtype: custom - description: Authentication is done using the x-api-key in the request header diff --git a/yaml/audio_format_convertor.yaml b/yaml/audio_format_convertor.yaml deleted file mode 100644 index 5fb6e071e..000000000 --- a/yaml/audio_format_convertor.yaml +++ /dev/null @@ -1,253 +0,0 @@ -openapi: 3.0.1 -info: - title: Audio Format Convertor - description: >- - This API is used to convert your audio like music(any format) to the WAV format. - - The size of your audio file should **not exceed 10 MB**. - x-additionalinfo: |+ - Suggested Use Cases: - - Build services related to sound engineering or audio editing as WAV is the format of choice for video and audio editors. WAV files are lossless compared to the lossy MP3 file format, meaning that WAV audio is a high-quality uncompressed file that is excellent for studio recordings and audio mastering. - version: '0.1.0' - x-subscribelink: audio_format_convertor -servers: - - url: 'https://apis.sentient.io' -tags: -- name: "v0.1.0" - description: "Published Date - Mar 24, 2020" -paths: - /microservices/utility/audioprocessing/v0.1/getresults: - post: - tags: - - v0.1.0 - responses: - '200': - description: success response - content: - application/json: - schema: - $ref: '#/components/schemas/success' - example: - results: - AudioContent: actual base64 string of input wav - message: Successfully Processed - status: Success - '401': - description: Unauthorized - content: - application/json: - schema: - $ref: '#/components/schemas/unauthorized' - '402': - description: Payment Required - content: - application/json: - schema: - $ref: '#/components/schemas/paymentrequired' - '403': - description: Forbidden - content: - application/json: - schema: - $ref: '#/components/schemas/forbidden' - '404': - description: Not Found - content: - application/json: - schema: - $ref: '#/components/schemas/notfound' - '419': - description: Input Field Missing - content: - application/json: - schema: - $ref: '#/components/schemas/inputfieldmissing' - '413': - description: Input Limit Exceeded - content: - application/json: - schema: - $ref: '#/components/schemas/inputlimitexceeded' - '415': - description: Invalid Input - content: - application/json: - schema: - $ref: '#/components/schemas/invalidinput' - '500': - description: Internal Server error - content: - application/json: - schema: - $ref: '#/components/schemas/servererror' - '504': - description: Gateway Timeout - content: - application/json: - schema: - $ref: '#/components/schemas/gatewaytimeout' - security: - - APIAuthorizer: [] - requestBody: - content: - multipart/form-data: - schema: - $ref: '#/components/schemas/input' - required: true -components: - schemas: - success: - type: object - properties: - results: - type: string - example: - AudioContent: UklGRgaAoQBXQVZFZm10IBAAAAABAAIARKwAABCxAgAEABAATElTVBoAAABJTkZPSVNGVA4AAABMYXZmNTguMjkuMTAwAGRhdGHAf6EAAAAAAAAAAAAAAAAAAAAAAAAAAAAA................. - description: Audio wav file convert to base64 encode string - message: - type: string - example: Successfully Processed - description: Detail description on the API status - status: - type: string - example: Success - description: The status of the API call success/failure - unauthorized: - type: object - properties: - message: - type: string - example: Missing Authentication Token - status: - type: string - example: Failure - forbidden: - type: object - properties: - message: - type: string - example: Access Denied Unauthorized User - status: - type: string - example: Failure - paymentrequired: - type: object - properties: - message: - type: string - example: Insufficient Credits Kindly Top Up - status: - type: string - example: Failure - notfound: - type: object - properties: - message: - type: string - example: Invalid Request URL - status: - type: string - example: Failure - servererror: - type: object - properties: - message: - type: string - example: Internal Server Error - status: - type: string - example: Failure - gatewaytimeout: - type: object - properties: - message: - type: string - example: Request Timeout - status: - type: string - example: Failure - inputfieldmissing: - type: object - properties: - message: - type: string - example: Input Field Missing - status: - type: string - example: Failure - inputlimitexceeded: - type: object - properties: - message: - type: string - example: Input Limit Exceeded - status: - type: string - example: Failure - invalidinput: - type: object - properties: - message: - type: string - example: Invalid Input - status: - type: string - example: Failure - versions: - type: object - properties: - v0.1.0: - type: array - items: - oneOf: - - type: string - example: Published Date - Mar 24, 2020 - description: Initial version release - input: - type: object - required: - - filePath - properties: - filePath: - type: string - format: binary - default: true - example: sample.wav - description: Maximum file size up to 10 MB. - samplerate: - type: string - default: false - example: '16000' - description: Sample rate of the audio file in Hz - channel: - type: string - default: false - example: '1' - description: Indicates the type of audio channel. Value must be 1 for mono or 2 for Stereo. Default is 2(Stereo) - bitrate: - type: string - default: false - example: '4' - description: Indicates the bit resolution. Value must be 1(8bit) or 2 (16 bit) or 4(32bit) - normalize: - type: string - default: false - example: yes or no - description: A boolean value that indicates whether to normalize the audio or not. Values must be either “yes” or “no” - trim_start_time: - type: string - default: false - example: '1' - description: Indicates the start in seconds between which the audio is extracted - trim_stop_time: - type: string - default: false - example: '5' - description: Indicates the end time in seconds between which the audio is extracted - securitySchemes: - APIAuthorizer: - type: apiKey - name: x-api-key - in: header - x-amazon-apigateway-authtype: custom - description: Authentication is done using the x-api-key in the request header diff --git a/yaml/automatic_speech_recognition_chi_sg.yaml b/yaml/automatic_speech_recognition_chi_sg.yaml deleted file mode 100644 index a5c9ba89e..000000000 --- a/yaml/automatic_speech_recognition_chi_sg.yaml +++ /dev/null @@ -1,244 +0,0 @@ -openapi: 3.0.1 -info: - title: Automatic Speech Recognition CHI (SG) - description: |+ - This Voice microservice takes in the input audio file (in WAV format at 16kHz) and transcribes Mandarin speech content within the input file into text. - - This microservice works best when the audio file consists of mostly speech with no long pauses in between. - x-additionalinfo: |+ - Suggested Use Cases: - - Extraction of text from voice ( from sound files), especially with Singaporean accented Mandarin. - - - Extraction of text from video, especially with Singaporean accented Mandarin. - - - Improve customer service - empower a customer service system by adding IVR (interactive voice response) and agent conversations to call centers. Perform analytics on conversation data to gain more insights into the calls and customers. - - - Enable voice control services - e.g. implement voice commands such as “turn the volume up,” and voice search such as saying “what is the temperature in Paris?” - - - Transcribe multimedia content - transcribe audio and video to include captions and improve audience reach and experience. For example, this microservice can be used for indexing or subtitling video and/or multispeaker content; similar to video captioning on YouTube. - version: '0.1.1' - x-subscribelink: automatic_speech_recognition_chi_sg -servers: - - url: 'https://apis.sentient.io' -tags: -- name: "v0.1.1" - description: "Published Date - Sep 28, 2018" -paths: - /microservices/voice/asrsch/v0.1/getpredictions: - post: - tags: - - v0.1.1 - responses: - '200': - description: success response - content: - application/json: - schema: - $ref: '#/components/schemas/success' - example: - message: "各位同学朋友老师教授大家好我叫墓园" - status: success - '401': - description: Unauthorized - content: - application/json: - schema: - $ref: '#/components/schemas/unauthorized' - '402': - description: Payment Required - content: - application/json: - schema: - $ref: '#/components/schemas/paymentrequired' - '403': - description: Forbidden - content: - application/json: - schema: - $ref: '#/components/schemas/forbidden' - '404': - description: Not Found - content: - application/json: - schema: - $ref: '#/components/schemas/notfound' - '419': - description: Input Field Missing - content: - application/json: - schema: - $ref: '#/components/schemas/inputfieldmissing' - '413': - description: Input Limit Exceeded - content: - application/json: - schema: - $ref: '#/components/schemas/inputlimitexceeded' - '415': - description: Invalid Input - content: - application/json: - schema: - $ref: '#/components/schemas/invalidinput' - '500': - description: Internal Server Error - content: - application/json: - schema: - $ref: '#/components/schemas/servererror' - '504': - description: Gateway Timeout - content: - application/json: - schema: - $ref: '#/components/schemas/gatewaytimeout' - security: - - APIAuthorizer: [] - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/input' - required: true -components: - schemas: - success: - type: object - properties: - message: - type: string - example: 各位同学朋友老师教授大家好我叫墓园 - description: Converted Text - status: - type: string - example: success - description: The status of the API call success/failure - unauthorized: - type: object - properties: - message: - type: string - example: Missing Authentication Token - status: - type: string - example: Failure - forbidden: - type: object - properties: - message: - type: string - example: Access Denied Unauthorized User - status: - type: string - example: Failure - paymentrequired: - type: object - properties: - message: - type: string - example: Insufficient Credits Kindly Top Up - status: - type: string - example: Failure - notfound: - type: object - properties: - message: - type: string - example: Invalid Request URL - status: - type: string - example: Failure - servererror: - type: object - properties: - message: - type: string - example: Internal Server Error - status: - type: string - example: Failure - gatewaytimeout: - type: object - properties: - message: - type: string - example: Request Timeout - status: - type: string - example: Failure - inputfieldmissing: - type: object - properties: - message: - type: string - example: Input Field Missing - status: - type: string - example: Failure - inputlimitexceeded: - type: object - properties: - message: - type: string - example: Input Limit Exceeded - status: - type: string - example: Failure - invalidinput: - type: object - properties: - message: - type: string - example: Invalid Input - status: - type: string - example: Failure - input: - type: object - required: - - audio - properties: - audio: - x-name: audio - type: string - default: true - example: data:audio/wav;base64,UklGRkbiBABXQVZFZm10IBAAAAABA... - description: |+ - Input audio file in base64 format. - - Input file needs to be prefixed by the data type and encoding. - - Data:audio/wav;base64, - language: - x-name: language - type: string - default: true - example: 1 - description: |+ - Language setting: - 1 Mandarin - versions: - type: object - properties: - v0.1.1: - type: array - items: - oneOf: - - type: string - example: Published Date - Sep 28,2018 - description: Patch update on bug fixes - v0.1.0: - type: array - items: - oneOf: - - type: string - example: Published Date - Jun 21,2018 - description: Initial version release - securitySchemes: - APIAuthorizer: - type: apiKey - name: x-api-key - in: header - x-amazon-apigateway-authtype: custom - description: Authentication is done using the x-api-key in the request header diff --git a/yaml/automatic_speech_recognition_eng.yaml b/yaml/automatic_speech_recognition_eng.yaml deleted file mode 100644 index 8e447ccfe..000000000 --- a/yaml/automatic_speech_recognition_eng.yaml +++ /dev/null @@ -1,203 +0,0 @@ -openapi: 3.0.1 -info: - title: Automatic Speech Recognition ENG - description: |+ - This Voice microservice takes in an audio file (in WAV format at 16kHz) and transcribes English speech content within the input file into text. - - The Automatic Speech Recognition (ASR) AI model is employed to understand the mapping of sound features to actual words in English. - - Use this microservice if the audio file consists of mostly speech with no long pauses in between. - version: '0.1' -servers: - - url: 'https://apis.sentient.io' -tags: -- name: "v0.1" - description: "Published Date - Jun 18, 2018" -paths: - /microservices/voice/asreng/v0.1/getpredictions: - post: - tags: - - v0.1 - responses: - '200': - description: success response - content: - application/json: - schema: - $ref: '#/components/schemas/success' - example: - message: Hi there - status: success - '401': - description: Unauthorized - content: - application/json: - schema: - $ref: '#/components/schemas/unauthorized' - '402': - description: Payment Required - content: - application/json: - schema: - $ref: '#/components/schemas/paymentrequired' - '403': - description: Forbidden - content: - application/json: - schema: - $ref: '#/components/schemas/forbidden' - '404': - description: Not Found - content: - application/json: - schema: - $ref: '#/components/schemas/notfound' - '419': - description: Input Field Missing - content: - application/json: - schema: - $ref: '#/components/schemas/inputfieldmissing' - '420': - description: Input Limit Exceeded - content: - application/json: - schema: - $ref: '#/components/schemas/inputlimitexceeded' - '500': - description: Internal Server Error - content: - application/json: - schema: - $ref: '#/components/schemas/servererror' - '504': - description: Gateway Timeout - content: - application/json: - schema: - $ref: '#/components/schemas/gatewaytimeout' - security: - - APIAuthorizer: [] - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/input' - required: true -components: - schemas: - success: - type: object - properties: - message: - x-name: message - type: string - example: Hi there - description: Converted Text - status: - x-name: status - type: string - example: success - description: The status of the API call success/failure - unauthorized: - type: object - properties: - message: - type: string - example: Missing Authentication Token - status: - type: string - example: Failure - forbidden: - type: object - properties: - message: - type: string - example: Access Denied Unauthorized User - status: - type: string - example: Failure - paymentrequired: - type: object - properties: - message: - type: string - example: Insufficient Credits Kindly Top Up - status: - type: string - example: Failure - notfound: - type: object - properties: - message: - type: string - example: Invalid Request URL - status: - type: string - example: Failure - servererror: - type: object - properties: - message: - type: string - example: Internal Server Error - status: - type: string - example: Failure - gatewaytimeout: - type: object - properties: - message: - type: string - example: Request Timeout - status: - type: string - example: Failure - inputfieldmissing: - type: object - properties: - message: - type: string - example: Input Field Missing - status: - type: string - example: Failure - inputlimitexceeded: - type: object - properties: - message: - type: string - example: Input Limit Exceeded - status: - type: string - example: Failure - input: - type: object - required: - - audio - properties: - audio: - x-name: audio - type: string - default: true - example: data:audio/wav;base64,UklGRkbiBABXQVZFZm10IBAAAAABA... - description: |+ - Input file in base64 format and needs to be prefixed by the data type and encoding - data:audio/wav;base64, - versions: - type: object - properties: - v0.1: - type: array - items: - oneOf: - - type: string - example: Published Date - Jun 18,2018 - description: Initial version release - securitySchemes: - APIAuthorizer: - type: apiKey - name: x-api-key - in: header - x-amazon-apigateway-authtype: custom - description: Authentication is done using the x-api-key in the request header diff --git a/yaml/automatic_speech_recognition_eng_sg.yaml b/yaml/automatic_speech_recognition_eng_sg.yaml deleted file mode 100644 index 0fcc4431a..000000000 --- a/yaml/automatic_speech_recognition_eng_sg.yaml +++ /dev/null @@ -1,287 +0,0 @@ -openapi: 3.0.1 -info: - title: Automatic Speech Recognition ENG (SG) - description: |+ - This Voice microservice transcribes the input audio stream into text. - - This microservice performs well on Singaporean-accented English speech. For best performance, select the model which best matches the use-case: news_parliament, nsc_parliament and nscfull_8k. - - The size of your audio file should be **between 3 KB to 10 MB**. - version: '0.1.0' - x-additionalinfo: |+ - Suggested Use Cases: - - Combine this with the Text-to-Speech API to deliver voice-enabled experiences in IoT (Internet of Things) applications, such as implementing voice commands. - x-subscribelink: automatic_speech_recognition_eng_sg -servers: - - url: 'https://apis.sentient.io' -tags: -- name: "v0.1.0" - description: "Published Date - Jul 03, 2020" -paths: - /microservices/voice/asr/v0.1/getpredictions: - post: - tags: - - v0.1.0 - responses: - '200': - description: success response - content: - application/json: - schema: - $ref: '#/components/schemas/success' - example: - results: - - seqNum: 1 - start: 1.0 - end: 4.0 - text: HELLO WORLD - '401': - description: Unauthorized - content: - application/json: - schema: - $ref: '#/components/schemas/unauthorized' - '402': - description: Payment Required - content: - application/json: - schema: - $ref: '#/components/schemas/paymentrequired' - '403': - description: Forbidden - content: - application/json: - schema: - $ref: '#/components/schemas/forbidden' - '404': - description: Not Found - content: - application/json: - schema: - $ref: '#/components/schemas/notfound' - '419': - description: Input Field Missing - content: - application/json: - schema: - $ref: '#/components/schemas/inputfieldmissing' - '413': - description: Input Limit Exceeded - content: - application/json: - schema: - $ref: '#/components/schemas/inputlimitexceeded' - '415': - description: Invalid Input - content: - application/json: - schema: - $ref: '#/components/schemas/invalidinput' - '500': - description: Internal Server Error - content: - application/json: - schema: - $ref: '#/components/schemas/servererror' - '504': - description: Gateway Timeout - content: - application/json: - schema: - $ref: '#/components/schemas/gatewaytimeout' - security: - - APIAuthorizer: [] - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/input' - required: true -components: - schemas: - success: - type: object - properties: - results: - type: array - example: [{ "" }] - description: List of Json Objects - items: - oneOf: - - type: object - example: {seqNum: 1,start: 1.0,end: 4.0,text: HELLO WORLD} - properties: - end: - type: number - format: float - example: 23.72 - description: End time of utterance in seconds - seqNum: - type: number - example: 1 - description: Running sequence. Starts from 1. - start: - type: number - format: float - example: 0.64 - description: Start time of utterance in seconds - text: - type: string - description: Converted text from the input audio file - example: THE COMING YEAR LIFE FOR A REASON A CITIZEN OR A LIFETIME LIKE YOU WHEN SOMEONE IS IN YOUR LIFE A REASON IT USUALLY TO MEET IN NEED WITHIN YOU HAVE NEVER MET YOU BUT I LIKE YOU WHEN SOMEONE IS IN YOUR LIFE FOR A SEASON IS BECAUSE IT IS YOUR TURN TO SHARE LEARN AND GROW AND WANT SOMEONE IN YOUR LIFE FOR A LIFETIME IT CITY THROUGH LESSONS AND IF NOT WHAT THE PEOPLE - unauthorized: - type: object - properties: - message: - type: string - example: Missing Authentication Token - status: - type: string - example: Failure - forbidden: - type: object - properties: - message: - type: string - example: Access Denied Unauthorized User - status: - type: string - example: Failure - paymentrequired: - type: object - properties: - message: - type: string - example: Insufficient Credits Kindly Top Up - status: - type: string - example: Failure - notfound: - type: object - properties: - message: - type: string - example: Invalid Request URL - status: - type: string - example: Failure - servererror: - type: object - properties: - message: - type: string - example: Internal Server Error - status: - type: string - example: Failure - gatewaytimeout: - type: object - properties: - message: - type: string - example: Request Timeout - status: - type: string - example: Failure - inputfieldmissing: - type: object - properties: - message: - type: string - example: Input Field Missing - status: - type: string - example: Failure - inputlimitexceeded: - type: object - properties: - message: - type: string - example: Input Limit Exceeded - status: - type: string - example: Failure - invalidinput: - type: object - properties: - message: - type: string - example: Invalid Input - status: - type: string - example: Failure - input: - type: object - required: - - model - - wav_base64 - properties: - model: - x-name: model - type: string - default: true - example: nsc_parliament - description: |+ - Model selection. For best performance, select the model which best matches the use-case: - - 1. news_parliament - 16 kHz, mono channel, .wav format. Trained on Singapore news and parliament corpus. - 2. nsc_parliament - 16 kHz, mono channel, .wav format. Trained on National Speech Corpus and parliament corpus. - 3. nscfull_8k - 8 kHz, mono channel, .wav format. Trained on National Speech Corpus. Trained on Full National Speech Corpus corpus. - wav_base64: - x-name: wav_base64 - type: string - default: true - example: UklGRkbiBABXQVZFZm10IBAAAAABA... - description: |+ - Input wav file in base64 format. - srt: - x-name: srt - type: array - default: false - example: [{seqNum: 1,start: 1.0,end: 4.0}] - description: |+ - Optional. An ordered array of utterance struct. Used for time-coding. - items: - oneOf: - - type: object - properties: - end: - x-name: end - type: number - format: float - default: false - example: "4.0" - description: |+ - "End time of utterance, in seconds. Offset from the start of stream." - seqNum: - x-name: seqNum - type: number - default: false - example: "1" - description: |+ - "Running sequence. Starts from 1." - start: - x-name: start - type: number - format: float - default: false - example: "1.0" - description: |+ - "Start time of utterance, in seconds. Offset from the start of stream." - versions: - type: object - properties: - v0.1.0: - type: array - items: - oneOf: - - type: string - example: Published Date - Jul 03,2020 - description: Initial version release - securitySchemes: - APIAuthorizer: - type: apiKey - name: x-api-key - in: header - x-amazon-apigateway-authtype: custom - description: Authentication is done using the x-api-key in the request header. diff --git a/yaml/automatic_speech_recognition_eng_sg_v1.0.yaml b/yaml/automatic_speech_recognition_eng_sg_v1.0.yaml deleted file mode 100644 index 0ede6f6f7..000000000 --- a/yaml/automatic_speech_recognition_eng_sg_v1.0.yaml +++ /dev/null @@ -1,317 +0,0 @@ -openapi: 3.0.1 -info: - title: Automatic Speech Recognition ENG (SG) - description: |+ - This Voice microservice transcribes the input audio stream into text. - - This microservice performs well on Singaporean-accented English speech. For best performance, select the model which best matches the use-case, whether for prepared speech (16kHz) or telephony (8kHz). - - The size of your audio file should be **between 3 KB to 10 MB**. - version: '1.1.0' - x-additionalinfo: |+ - Suggested Use Cases: - - Combine this with the Text-to-Speech API to deliver voice-enabled experiences in IoT (Internet of Things) applications, such as implementing voice commands. - x-subscribelink: automatic_speech_recognition_eng_sg -servers: - - url: 'https://apis.sentient.io' -tags: -- name: "v1.1.0" - description: "Published Date - Jan 22, 2021" -paths: - /microservices/voice/asr/v1/getpredictions: - post: - tags: - - v1.1.0 - responses: - '200': - description: success response - content: - application/json: - schema: - $ref: '#/components/schemas/success' - example: - results: - output: - - seqNum: 1 - start: 0.64 - end: 23.72 - text: HELLO WORLD - message: Successfully Processed - status: Success - '401': - description: Unauthorized - content: - application/json: - schema: - $ref: '#/components/schemas/unauthorized' - '402': - description: Payment Required - content: - application/json: - schema: - $ref: '#/components/schemas/paymentrequired' - '403': - description: Forbidden - content: - application/json: - schema: - $ref: '#/components/schemas/forbidden' - '404': - description: Not Found - content: - application/json: - schema: - $ref: '#/components/schemas/notfound' - '419': - description: Input Field Missing - content: - application/json: - schema: - $ref: '#/components/schemas/inputfieldmissing' - '413': - description: Input Limit Exceeded - content: - application/json: - schema: - $ref: '#/components/schemas/inputlimitexceeded' - '415': - description: Invalid Input - content: - application/json: - schema: - $ref: '#/components/schemas/invalidinput' - '500': - description: Internal Server Error - content: - application/json: - schema: - $ref: '#/components/schemas/servererror' - '504': - description: Gateway Timeout - content: - application/json: - schema: - $ref: '#/components/schemas/gatewaytimeout' - security: - - APIAuthorizer: [] - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/input' - required: true -components: - schemas: - success: - type: object - properties: - results: - type: object - description: The result of the API call. - example: { "" } - properties: - output: - type: array - example: [{ "" }] - description: List of Json Objects - items: - oneOf: - - type: object - example: {seqNum: 1,start: 1.0,end: 4.0,text: HELLO WORLD} - properties: - end: - type: number - format: float - example: 23.72 - description: End time of utterance in seconds - seqNum: - type: number - example: 1 - description: Running sequence. Starts from 1. - start: - type: number - format: float - example: 0.64 - description: Start time of utterance in seconds - text: - type: string - description: Converted text from the input audio file - example: THE COMING YEAR LIFE FOR A REASON A CITIZEN OR A LIFETIME LIKE YOU WHEN SOMEONE IS IN YOUR LIFE A REASON IT USUALLY TO MEET IN NEED WITHIN YOU HAVE NEVER MET YOU BUT I LIKE YOU WHEN SOMEONE IS IN YOUR LIFE FOR A SEASON IS BECAUSE IT IS YOUR TURN TO SHARE LEARN AND GROW AND WANT SOMEONE IN YOUR LIFE FOR A LIFETIME IT CITY THROUGH LESSONS AND IF NOT WHAT THE PEOPLE - message: - type: string - example: Successfully Processed - description: Detail description on the API status - status: - type: string - example: Success - description: The status of the API call success/failure - unauthorized: - type: object - properties: - message: - type: string - example: Missing Authentication Token - status: - type: string - example: Failure - forbidden: - type: object - properties: - message: - type: string - example: Access Denied Unauthorized User - status: - type: string - example: Failure - paymentrequired: - type: object - properties: - message: - type: string - example: Insufficient Credits Kindly Top Up - status: - type: string - example: Failure - notfound: - type: object - properties: - message: - type: string - example: Invalid Request URL - status: - type: string - example: Failure - servererror: - type: object - properties: - message: - type: string - example: Internal Server Error - status: - type: string - example: Failure - gatewaytimeout: - type: object - properties: - message: - type: string - example: Request Timeout - status: - type: string - example: Failure - inputfieldmissing: - type: object - properties: - message: - type: string - example: Input Field Missing - status: - type: string - example: Failure - inputlimitexceeded: - type: object - properties: - message: - type: string - example: Input Limit Exceeded - status: - type: string - example: Failure - invalidinput: - type: object - properties: - message: - type: string - example: Invalid Input - status: - type: string - example: Failure - input: - type: object - required: - - model - - wav_base64 - properties: - model: - x-name: model - type: string - default: true - example: prepared_speech - description: |+ - Model selection. For best performance, select the model which best matches the use-case: - - 1. prepared_speech - Better suited for transcribing prepared / formal speech (e.g. news or parliamentary speeches). 16 kHz, mono channel, .wav format. - 2. telephony - Better suited for conversational speech or telephony use cases. 8 kHz, mono channel, .wav format. - wav_base64: - x-name: wav_base64 - type: string - default: true - example: UklGRkbiBABXQVZFZm10IBAAAAABA... - description: |+ - Input wav file in base64 format. - srt: - x-name: srt - type: array - default: false - example: [{seqNum: 1,start: 1.0,end: 4.0}] - description: |+ - Optional. An ordered array of utterance struct. Used for time-coding. - items: - oneOf: - - type: object - properties: - end: - x-name: end - type: number - format: float - default: false - example: "4.0" - description: |+ - "End time of utterance, in seconds. Offset from the start of stream." - seqNum: - x-name: seqNum - type: number - default: false - example: "1" - description: |+ - "Running sequence. Starts from 1." - start: - x-name: start - type: number - format: float - default: false - example: "1.0" - description: |+ - "Start time of utterance, in seconds. Offset from the start of stream." - versions: - type: object - properties: - v1.1.0: - type: array - items: - oneOf: - - type: string - example: Published Date - Jan 22, 2021 - description: Model name update - v1.0.0: - type: array - items: - oneOf: - - type: string - example: Published Date - Dec 09, 2020 - description: Standardizing Output JSON - - v0.1.0: - type: array - items: - oneOf: - - type: string - example: Published Date - Jul 03,2020 - description: Initial version release - securitySchemes: - APIAuthorizer: - type: apiKey - name: x-api-key - in: header - x-amazon-apigateway-authtype: custom - description: Authentication is done using the x-api-key in the request header. diff --git a/yaml/automatic_voice_recognition_eng.yaml b/yaml/automatic_voice_recognition_eng.yaml deleted file mode 100644 index 94fbad094..000000000 --- a/yaml/automatic_voice_recognition_eng.yaml +++ /dev/null @@ -1,219 +0,0 @@ -openapi: 3.0.1 -info: - title: Automatic Voice Recognition ENG - description: |+ - This Voice microservice takes in an audio file (in WAV format at 16kHz) and transcribes English speech content within the input file into text. - - The Automatic Speech Recognition (ASR) AI model is employed to understand the mapping of sound features to actual words in English. - - Use this microservice if the audio file consists of mostly speech with no long pauses in between. - version: '0.1.0' -servers: - - url: 'https://apis.sentient.io' -tags: -- name: "v0.1.0" - description: "Published Date - Jun 18, 2018" -paths: - /microservices/voice/asreng/v0.1/getpredictions: - post: - tags: - - v0.1.0 - responses: - '200': - description: success response - content: - application/json: - schema: - $ref: '#/components/schemas/success' - example: - message: Hi there - status: success - '401': - description: Unauthorized - content: - application/json: - schema: - $ref: '#/components/schemas/unauthorized' - '402': - description: Payment Required - content: - application/json: - schema: - $ref: '#/components/schemas/paymentrequired' - '403': - description: Forbidden - content: - application/json: - schema: - $ref: '#/components/schemas/forbidden' - '404': - description: Not Found - content: - application/json: - schema: - $ref: '#/components/schemas/notfound' - '419': - description: Input Field Missing - content: - application/json: - schema: - $ref: '#/components/schemas/inputfieldmissing' - '420': - description: Input Limit Exceeded - content: - application/json: - schema: - $ref: '#/components/schemas/inputlimitexceeded' - '422': - description: Invalid Input - content: - application/json: - schema: - $ref: '#/components/schemas/invalidinput' - '500': - description: Internal Server Error - content: - application/json: - schema: - $ref: '#/components/schemas/servererror' - '504': - description: Gateway Timeout - content: - application/json: - schema: - $ref: '#/components/schemas/gatewaytimeout' - security: - - APIAuthorizer: [] - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/input' - required: true -components: - schemas: - success: - type: object - properties: - message: - x-name: message - type: string - example: Hi there - description: Converted Text - status: - x-name: status - type: string - example: success - description: The status of the API call success/failure - unauthorized: - type: object - properties: - message: - type: string - example: Missing Authentication Token - status: - type: string - example: Failure - forbidden: - type: object - properties: - message: - type: string - example: Access Denied Unauthorized User - status: - type: string - example: Failure - paymentrequired: - type: object - properties: - message: - type: string - example: Insufficient Credits Kindly Top Up - status: - type: string - example: Failure - notfound: - type: object - properties: - message: - type: string - example: Invalid Request URL - status: - type: string - example: Failure - servererror: - type: object - properties: - message: - type: string - example: Internal Server Error - status: - type: string - example: Failure - gatewaytimeout: - type: object - properties: - message: - type: string - example: Request Timeout - status: - type: string - example: Failure - inputfieldmissing: - type: object - properties: - message: - type: string - example: Input Field Missing - status: - type: string - example: Failure - inputlimitexceeded: - type: object - properties: - message: - type: string - example: Input Limit Exceeded - status: - type: string - example: Failure - invalidinput: - type: object - properties: - message: - type: string - example: Invalid Input - status: - type: string - example: Failure - input: - type: object - required: - - audio - properties: - audio: - x-name: audio - type: string - default: true - example: data:audio/wav;base64,UklGRkbiBABXQVZFZm10IBAAAAABA... - description: |+ - Input audio file in base64 format. It also needs to be prefixed by the data type and encoding. - - data:audio/wav;base64, - versions: - type: object - properties: - v0.1.0: - type: array - items: - oneOf: - - type: string - example: Published Date - Jun 18,2018 - description: Initial version release - securitySchemes: - APIAuthorizer: - type: apiKey - name: x-api-key - in: header - x-amazon-apigateway-authtype: custom - description: Authentication is done using the x-api-key in the request header diff --git a/yaml/base64-decoder.yaml b/yaml/base64-decoder.yaml deleted file mode 100644 index 88700c389..000000000 --- a/yaml/base64-decoder.yaml +++ /dev/null @@ -1,220 +0,0 @@ -openapi: 3.0.1 -info: - title: Base64 Decoder - description: |+ - This Utility microservice converts a Base64 encoded text string to a binary file.

For the reverse process (convert binary file to Base64 encoded text string), check out the Base64 File Encode microservice. - x-additionalinfo: |+ - Suggested Use Cases: - - As a post-processor for microservices that only outputs Base64 encoded text - version: '0.0.1' - x-subscribelink: base64_decoder -servers: - - url: 'https://apis.sentient.io' -tags: -- name: "v0.0.1" - description: "Published Date - Oct 30, 2020" -paths: - /microservices/utility/base64decode/v0/getresults: - post: - tags: - - "0.0.1" - responses: - '200': - description: success response - content: - application/json: - schema: - $ref: '#/components/schemas/success' - example: - url: https://storage.googleapis.com/base64decode_dev/24f03729131e469181a2fc22eb3a627a.zip?X-Goog-Algorithm=GOOG4-RSA-SHA256&X-Goog-Credential=sentient-dev-bigquery%40sentient-207310.iam.gserviceaccount.com%2F20201015%2Fa... - message: Successfully Processed - status: Success - '401': - description: Unauthorized - content: - application/json: - schema: - $ref: '#/components/schemas/unauthorized' - '402': - description: Payment Required - content: - application/json: - schema: - $ref: '#/components/schemas/paymentrequired' - '403': - description: Forbidden - content: - application/json: - schema: - $ref: '#/components/schemas/forbidden' - '404': - description: Not Found - content: - application/json: - schema: - $ref: '#/components/schemas/notfound' - '419': - description: Input Field Missing - content: - application/json: - schema: - $ref: '#/components/schemas/inputfieldmissing' - '413': - description: Input Limit Exceeded - content: - application/json: - schema: - $ref: '#/components/schemas/inputlimitexceeded' - '415': - description: Invalid Input - content: - application/json: - schema: - $ref: '#/components/schemas/invalidinput' - '500': - description: Internal Server Error - content: - application/json: - schema: - $ref: '#/components/schemas/servererror' - '504': - description: Gateway Timeout - content: - application/json: - schema: - $ref: '#/components/schemas/gatewaytimeout' - security: - - APIAuthorizer: [] - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/input' - required: true -components: - schemas: - success: - type: object - properties: - message: - type: string - example: Successfully Processed - description: Detail description on the api status - status: - type: string - example: Success - description: The status of the API call success/failure - url: - type: string - example: https://storage.googleapis.com/base64decode/24f03729131e469181a2fc22eb3a627a.zip?X-Goog-Algorithm=GOOG4-RSA-SHA256&X-Goog-Credential=sentient-dev-bigquery%40sentient-207310.iam.gserviceaccount.com%2F20201015%2Fauto%2Fstora... - description: Pre-signed URL to download the file - unauthorized: - type: object - properties: - message: - type: string - example: Missing Authentication Token - status: - type: string - example: Failure - forbidden: - type: object - properties: - message: - type: string - example: Access Denied Unauthorized User - status: - type: string - example: Failure - paymentrequired: - type: object - properties: - message: - type: string - example: Insufficient Credits Kindly Top Up - status: - type: string - example: Failure - notfound: - type: object - properties: - message: - type: string - example: Invalid Request URL - status: - type: string - example: Failure - servererror: - type: object - properties: - message: - type: string - example: Internal Server Error - status: - type: string - example: Failure - gatewaytimeout: - type: object - properties: - message: - type: string - example: Request Timeout - status: - type: string - example: Failure - inputfieldmissing: - type: object - properties: - message: - type: string - example: Input Field Missing - status: - type: string - example: Failure - inputlimitexceeded: - type: object - properties: - message: - type: string - example: Input Limit Exceeded - status: - type: string - example: Failure - invalidinput: - type: object - properties: - message: - type: string - example: Invalid Input - status: - type: string - example: Failure - versions: - type: object - properties: - v0.0.1: - type: array - items: - oneOf: - - type: string - example: Published Date - Oct 30,2020 - description: Initial version release - input: - type: object - required: - - base64 - properties: - base64: - x-name: base64 - type: string - default: true - example: UklGRoboDgBXQVZFZm10IBAAAAABAAEAgD4AAAB9AAACABAATElTVBoAAABJTkZPSVNGVA4AAABMYXZmNTguMjAuMTAwAGRhdGFA6A4AAAAAAAAAAAAAAAAAAAAAAAAA... - description: |+ - Input base64 encoded string - securitySchemes: - APIAuthorizer: - type: apiKey - name: x-api-key - in: header - x-amazon-apigateway-authtype: custom - description: Authentication is done using the x-api-key in the request header diff --git a/yaml/base64-encoder.yaml b/yaml/base64-encoder.yaml deleted file mode 100644 index 7bf6b5c92..000000000 --- a/yaml/base64-encoder.yaml +++ /dev/null @@ -1,237 +0,0 @@ -openapi: 3.0.1 -info: - title: Base64 Encoder - description: |+ - This Utility microservice converts an uploaded file to Base64 encoded text (also known as a binary file to text converter). This microservice supports most documents, images, audio, video, archive and font files. See documentation for the detailed list of supported file formats.

User can choose the output base64 text string in 5 different formats (plain text, JSON, hyperlink, datauri, XML).

For the reverse process (converting Base64 string back to binary file), check out the Base 64 File Decode microservice. - x-additionalinfo: |+ - Suggested Use Cases: - - As a pre-processor for microservices that only takes in Base64 inputs - version: '0.0.1' - x-subscribelink: base64_encoder -servers: - - url: 'https://apis.sentient.io' -tags: -- name: "v0.0.1" - description: "Published Date - Oct 30, 2020" -paths: - /microservices/utility/base64encode/v0/getresults: - post: - tags: - - v0.0.1 - responses: - '200': - description: success response - content: - application/json: - schema: - $ref: '#/components/schemas/success' - example: - results: - base64: /9j/4AAQSkZJRgABAQAAAQABAAD/2wCEAAMCAggIBQUICAUGBQUGBgYGBgUFBQYGBgYGBgYGBgYGBgYGBQYGBgYGBgYGBgoGBgcICQkJBgYLDgoIDQYICQgBAwQEBgUGCAYGCAgHBwcICAgICAgBAABAgMFBgcECP.... - message: Successfully Processed - status: Success - '401': - description: Unauthorized - content: - application/json: - schema: - $ref: '#/components/schemas/unauthorized' - '402': - description: Payment Required - content: - application/json: - schema: - $ref: '#/components/schemas/paymentrequired' - '403': - description: Forbidden - content: - application/json: - schema: - $ref: '#/components/schemas/forbidden' - '404': - description: Not Found - content: - application/json: - schema: - $ref: '#/components/schemas/notfound' - '419': - description: Input Field Missing - content: - application/json: - schema: - $ref: '#/components/schemas/inputfieldmissing' - '413': - description: Input Limit Exceeded - content: - application/json: - schema: - $ref: '#/components/schemas/inputlimitexceeded' - '415': - description: Invalid Input - content: - application/json: - schema: - $ref: '#/components/schemas/invalidinput' - '500': - description: Internal Server Error - content: - application/json: - schema: - $ref: '#/components/schemas/servererror' - '504': - description: Gateway Timeout - content: - application/json: - schema: - $ref: '#/components/schemas/gatewaytimeout' - security: - - APIAuthorizer: [] - requestBody: - description: Input parameters

FieldType Description
filePathFileRequired. The file object
typeStringOptional. type of return data as xml/hyperlink/json/datauri/plaintext. plaintext is default if none selected


- content: - multipart/form-data: - schema: - $ref: '#/components/schemas/input' - # required: true -components: - schemas: - success: - type: object - properties: - results: - type: object - example: { "" } - description: Json Object of returned results - properties: - base64: - type: string - description: Converted base64 encoded text in the requested output format - example: /9j/4AAQSkZJRgABAQAAAQABAAD/2wCEAAMCAggIBQUICAUGBQUGBgYGBgUFBQYGBgYGBgYGBgYGBgYGBQYGBgYGBgYGBgoGBgcICQkJBgYLDgoIDQYICQgBAwQEBgUGCAYGCAgHBwcICAgICAgBAABAgMFBgcECP.... - message: - type: string - example: Successfully Processed - description: Detail description on the API status - status: - type: string - example: Success - description: The status of the API call success/failure - unauthorized: - type: object - properties: - message: - type: string - example: Missing Authentication Token - status: - type: string - example: Failure - forbidden: - type: object - properties: - message: - type: string - example: Access Denied Unauthorized User - status: - type: string - example: Failure - paymentrequired: - type: object - properties: - message: - type: string - example: Insufficient Credits Kindly Top Up - status: - type: string - example: Failure - notfound: - type: object - properties: - message: - type: string - example: Invalid Request URL - status: - type: string - example: Failure - servererror: - type: object - properties: - message: - type: string - example: Internal Server Error - status: - type: string - example: Failure - gatewaytimeout: - type: object - properties: - message: - type: string - example: Request Timeout - status: - type: string - example: Failure - inputfieldmissing: - type: object - properties: - message: - type: string - example: Input Field Missing - status: - type: string - example: Failure - inputlimitexceeded: - type: object - properties: - message: - type: string - example: Input Limit Exceeded - status: - type: string - example: Failure - invalidinput: - type: object - properties: - message: - type: string - example: Invalid Input - status: - type: string - example: Failure - input: - type: object - required: - - filePath - properties: - filePath: - type: string - format: binary - example: sample.txt - default: true - description: The file object. - format: - type: string - example: "xml" - default: false - description: |+ - The output format. Possible values are: - 1. plaintext (default) - 2. json - 3. hyperlink - 4. datauri - 5. xml - versions: - type: object - properties: - v0.0.1: - type: array - items: - oneOf: - - type: string - example: Published Date - Oct 30, 2020 - description: Initial version release - securitySchemes: - APIAuthorizer: - type: apiKey - name: x-api-key - in: header - x-amazon-apigateway-authtype: custom - description: Authentication is done using the x-api-key in the request header diff --git a/yaml/base64-file-decode.yaml b/yaml/base64-file-decode.yaml deleted file mode 100644 index 92842bbc8..000000000 --- a/yaml/base64-file-decode.yaml +++ /dev/null @@ -1,220 +0,0 @@ -openapi: 3.0.1 -info: - title: Base64 Decoder - description: |+ - This Utility microservice converts a Base64 encoded text string to a binary file.

For the reverse process (convert binary file to Base64 encoded text string), check out the Base64 File Encode microservice. - x-additionalinfo: |+ - Suggested Use Cases: - - As a post-processor for microservices that only outputs Base64 encoded text - version: '0.0.1' - x-subscribelink: base64_decoder -servers: - - url: 'https://apis.sentient.io' -tags: -- name: "v0.0.1" - description: "Published Date - Oct 30, 2020" -paths: - /microservices/utility/base64decode/v0/getresults: - post: - tags: - - "0.0.1" - responses: - '200': - description: success response - content: - application/json: - schema: - $ref: '#/components/schemas/success' - example: - url: https://storage.googleapis.com/base64decode_dev/24f03729131e469181a2fc22eb3a627a.zip?X-Goog-Algorithm=GOOG4-RSA-SHA256&X-Goog-Credential=sentient-dev-bigquery%40sentient-207310.iam.gserviceaccount.com%2F20201015%2Fa... - message: Successfully Processed - status: Success - '401': - description: Unauthorized - content: - application/json: - schema: - $ref: '#/components/schemas/unauthorized' - '402': - description: Payment Required - content: - application/json: - schema: - $ref: '#/components/schemas/paymentrequired' - '403': - description: Forbidden - content: - application/json: - schema: - $ref: '#/components/schemas/forbidden' - '404': - description: Not Found - content: - application/json: - schema: - $ref: '#/components/schemas/notfound' - '419': - description: Input Field Missing - content: - application/json: - schema: - $ref: '#/components/schemas/inputfieldmissing' - '420': - description: Input Limit Exceeded - content: - application/json: - schema: - $ref: '#/components/schemas/inputlimitexceeded' - '422': - description: Invalid Input - content: - application/json: - schema: - $ref: '#/components/schemas/invalidinput' - '500': - description: Internal Server Error - content: - application/json: - schema: - $ref: '#/components/schemas/servererror' - '504': - description: Gateway Timeout - content: - application/json: - schema: - $ref: '#/components/schemas/gatewaytimeout' - security: - - APIAuthorizer: [] - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/input' - required: true -components: - schemas: - success: - type: object - properties: - message: - type: string - example: Successfully Processed - description: Detail description on the api status - status: - type: string - example: Success - description: The status of the API call success/failure - url: - type: string - example: https://storage.googleapis.com/base64decode/24f03729131e469181a2fc22eb3a627a.zip?X-Goog-Algorithm=GOOG4-RSA-SHA256&X-Goog-Credential=sentient-dev-bigquery%40sentient-207310.iam.gserviceaccount.com%2F20201015%2Fauto%2Fstora... - description: Pre-signed URL to download the file - unauthorized: - type: object - properties: - message: - type: string - example: Missing Authentication Token - status: - type: string - example: Failure - forbidden: - type: object - properties: - message: - type: string - example: Access Denied Unauthorized User - status: - type: string - example: Failure - paymentrequired: - type: object - properties: - message: - type: string - example: Insufficient Credits Kindly Top Up - status: - type: string - example: Failure - notfound: - type: object - properties: - message: - type: string - example: Invalid Request URL - status: - type: string - example: Failure - servererror: - type: object - properties: - message: - type: string - example: Internal Server Error - status: - type: string - example: Failure - gatewaytimeout: - type: object - properties: - message: - type: string - example: Request Timeout - status: - type: string - example: Failure - inputfieldmissing: - type: object - properties: - message: - type: string - example: Input Field Missing - status: - type: string - example: Failure - inputlimitexceeded: - type: object - properties: - message: - type: string - example: Input Limit Exceeded - status: - type: string - example: Failure - invalidinput: - type: object - properties: - message: - type: string - example: Invalid Input - status: - type: string - example: Failure - versions: - type: object - properties: - v0.0.1: - type: array - items: - oneOf: - - type: string - example: Published Date - Oct 30,2020 - description: Initial version release - input: - type: object - required: - - base64 - properties: - base64: - x-name: base64 - type: string - default: true - example: UklGRoboDgBXQVZFZm10IBAAAAABAAEAgD4AAAB9AAACABAATElTVBoAAABJTkZPSVNGVA4AAABMYXZmNTguMjAuMTAwAGRhdGFA6A4AAAAAAAAAAAAAAAAAAAAAAAAA... - description: |+ - Input a base64 encoded string. - securitySchemes: - APIAuthorizer: - type: apiKey - name: x-api-key - in: header - x-amazon-apigateway-authtype: custom - description: Authentication is done using the x-api-key in the request header diff --git a/yaml/base64-file-encode.yaml b/yaml/base64-file-encode.yaml deleted file mode 100644 index 932e76d0b..000000000 --- a/yaml/base64-file-encode.yaml +++ /dev/null @@ -1,237 +0,0 @@ -openapi: 3.0.1 -info: - title: Base64 Encoder - description: |+ - This Utility microservice converts an uploaded file to Base64 encoded text (also known as a binary file to text converter). This microservice supports most documents, images, audio, video, archive and font files. See documentation for the detailed list of supported file formats.

User can choose the output base64 text string in 5 different formats (plain text, JSON, hyperlink, datauri, XML).

For the reverse process (converting Base64 string back to binary file), check out the Base 64 File Decode microservice. - x-additionalinfo: |+ - Suggested Use Cases: - - As a pre-processor for microservices that only takes in Base64 inputs - version: '0.0.1' - x-subscribelink: base64_encoder -servers: - - url: 'https://apis.sentient.io' -tags: -- name: "v0.0.1" - description: "Published Date - Oct 30, 2020" -paths: - /microservices/utility/base64encode/v0/getresults: - post: - tags: - - v0.0.1 - responses: - '200': - description: success response - content: - application/json: - schema: - $ref: '#/components/schemas/success' - example: - results: - base64: /9j/4AAQSkZJRgABAQAAAQABAAD/2wCEAAMCAggIBQUICAUGBQUGBgYGBgUFBQYGBgYGBgYGBgYGBgYGBQYGBgYGBgYGBgoGBgcICQkJBgYLDgoIDQYICQgBAwQEBgUGCAYGCAgHBwcICAgICAgBAABAgMFBgcECP.... - message: Successfully Processed - status: Success - '401': - description: Unauthorized - content: - application/json: - schema: - $ref: '#/components/schemas/unauthorized' - '402': - description: Payment Required - content: - application/json: - schema: - $ref: '#/components/schemas/paymentrequired' - '403': - description: Forbidden - content: - application/json: - schema: - $ref: '#/components/schemas/forbidden' - '404': - description: Not Found - content: - application/json: - schema: - $ref: '#/components/schemas/notfound' - '419': - description: Input Field Missing - content: - application/json: - schema: - $ref: '#/components/schemas/inputfieldmissing' - '420': - description: Input Limit Exceeded - content: - application/json: - schema: - $ref: '#/components/schemas/inputlimitexceeded' - '422': - description: Invalid Input - content: - application/json: - schema: - $ref: '#/components/schemas/invalidinput' - '500': - description: Internal Server Error - content: - application/json: - schema: - $ref: '#/components/schemas/servererror' - '504': - description: Gateway Timeout - content: - application/json: - schema: - $ref: '#/components/schemas/gatewaytimeout' - security: - - APIAuthorizer: [] - requestBody: - description: Input parameters

FieldType Description
filePathFileRequired. The file object
typeStringOptional. type of return data as xml/hyperlink/json/datauri/plaintext. plaintext is default if none selected


- content: - multipart/form-data: - schema: - $ref: '#/components/schemas/input' - # required: true -components: - schemas: - success: - type: object - properties: - results: - type: object - example: { "" } - description: Json Object of returned results - properties: - base64: - type: string - description: Base64 encoded text converted to the requested output format. - example: /9j/4AAQSkZJRgABAQAAAQABAAD/2wCEAAMCAggIBQUICAUGBQUGBgYGBgUFBQYGBgYGBgYGBgYGBgYGBQYGBgYGBgYGBgoGBgcICQkJBgYLDgoIDQYICQgBAwQEBgUGCAYGCAgHBwcICAgICAgBAABAgMFBgcECP.... - message: - type: string - example: Successfully Processed - description: Detail description on the API status - status: - type: string - example: Success - description: The status of the API call success/failure - unauthorized: - type: object - properties: - message: - type: string - example: Missing Authentication Token - status: - type: string - example: Failure - forbidden: - type: object - properties: - message: - type: string - example: Access Denied Unauthorized User - status: - type: string - example: Failure - paymentrequired: - type: object - properties: - message: - type: string - example: Insufficient Credits Kindly Top Up - status: - type: string - example: Failure - notfound: - type: object - properties: - message: - type: string - example: Invalid Request URL - status: - type: string - example: Failure - servererror: - type: object - properties: - message: - type: string - example: Internal Server Error - status: - type: string - example: Failure - gatewaytimeout: - type: object - properties: - message: - type: string - example: Request Timeout - status: - type: string - example: Failure - inputfieldmissing: - type: object - properties: - message: - type: string - example: Input Field Missing - status: - type: string - example: Failure - inputlimitexceeded: - type: object - properties: - message: - type: string - example: Input Limit Exceeded - status: - type: string - example: Failure - invalidinput: - type: object - properties: - message: - type: string - example: Invalid Input - status: - type: string - example: Failure - input: - type: object - required: - - filePath - properties: - filePath: - type: string - format: binary - example: sample.txt - default: true - description: The file object. - format: - type: string - example: "xml" - default: false - description: |+ - The output format. Possible values are: - 1. plaintext (default) - 2. json - 3. hyperlink - 4. datauri - 5. xml - versions: - type: object - properties: - v0.0.1: - type: array - items: - oneOf: - - type: string - example: Published Date - Oct 30, 2020 - description: Initial version release - securitySchemes: - APIAuthorizer: - type: apiKey - name: x-api-key - in: header - x-amazon-apigateway-authtype: custom - description: Authentication is done using the x-api-key in the request header diff --git a/yaml/building_addresses_hdb_sg.yaml b/yaml/building_addresses_hdb_sg.yaml deleted file mode 100644 index 78aeb1ee9..000000000 --- a/yaml/building_addresses_hdb_sg.yaml +++ /dev/null @@ -1,415 +0,0 @@ -openapi: 3.0.1 -info: - title: HDB Block Coordinates (SG) - x-subscribelink: building_addresses_hdb_sg - description: |+ - This Data microservice retrieves information on the Singapore Housing Development Board building blocks in Singapore that includes addresses, postal code, latitude and longitude coordinates. Updated monthly - - The HDB POTH programme makes selected public and non-public datasets available to developers and companies to improve their service offerings to benefit the lives of Singapore citizens. Sentient.io is proud to partner with HDB to manage and facilitate the sharing of data for the POTH Programme. - - **Note:** As this microservice uses the GET method, developers using this microservice must remember to have their app encode all the input values to be URL friendly (i.e. all spaces and special characters must be replaced). Here’s a reference on [URL encoding](https://www.w3schools.com/tags/ref_urlencode.ASP). - - x-additionalinfo : |+ - Suggested Use Cases: - - Information from this microservice can be used to build a geo-targeting app with precise map features. - - **Refining queries in the filterdata field using filter types and match types** - - The filterdata fields use elasticsearch’s syntax (specifically filter types and match types) to help further refine search results and provide greater flexibility in structuring more sophisticated queries. - - **Filter Types:** - - A filter type is a logic operator to which the search results must fulfill certain logical conditions to be returned. The supported match types are: - - * **must** - All of the stated conditions must match. Equivalent to an AND operator. - - > {"must":[{"range":{"block":{"gte":100}}}]} - - * **must_not** - All of the stated conditions must not match. Equivalent to a NOT operator. - > {"must_not":[{"match":{"street":"avenue 3"}}]} - - * **should** - At least one of the stated conditions should match. Equivalent to an OR operator. - > {"should":[{"range":{"block":{"lte":200}}}]} - - * **filter** - All of the stated conditions that must match. However, results are not scored unlike the other filter types which returns results based on how well the conditions are met. - > {"filter":[{"match_phrase":{"street":"ang mo kio"}}]} - - For a more detailed guide on filter types, [refer to this](https://www.elastic.co/guide/en/elasticsearch/reference/6.8/query-dsl-bool-query.html). - - Filter types cannot be used alone and must be used in conjunction with a match type to complete the query. - - **Match Types:** - - A match type is a match operator nested within a filter type that fine-tunes the matching condition of the text search. The supported match types are: - - * **match** - Search within a full text field for a single word - - > {"match":{"street":"serangoon"}} - - * **match_phrase** - Search within a full text field - - > {"match_phrase":{"street":"ang mo kio street"}} - - * **match_phrase_prefix** - Search within a full text field with prefix - - > {"match_phrase_prefix":{"street":"ang mo kio"}} - - * **term** - Returns results that contain an exact term in a provided field - - > {"term":{"postalcode":"550151"}} - - * **terms** - Returns results that contain one or more exact terms in a provided field - - > {"terms":{"postalcode":["550151","550152"]}} - - * **range** - Returns results that contain terms within a stipulated range - > {"range":{"postalcode":{"lte":650347}}} - > {"range":{"postalcode":{"gte":650347}}} - > {"range":{"postalcode":{"gte":650347,"lte":760415}}} - - * **exists** - Returns results that contain any indexed value for a field - > {"exists":{ "field": "postalcode"}} - - For a more detailed guide to match types, [refer to this](https://www.elastic.co/guide/en/elasticsearch/reference/7.9/term-level-queries.html). - - **Forming sophisticated queries using combinations of filter types (in JSON)** - - Multiple filter types can be combined together in one query (written in JSON format) to form a very sophisticated query. Here’s one example below: - - > { - > "must":[{"range":{"block":{"gte":100}}}], - > "should":[{"range":{"block":{"lte":200}}}], - > "filter":[{"match_phrase":{"street":"ang mo kio"}}], - > "must_not":[{"match":{"street":"avenue 3"}}] - > } - - - **Sample Queries Based on Use Cases** - 1. **Search the latitude and longitude coordinates for 442 Pasir Ris Drive 6** - - Using a filterdata only: - > filterdata = {"filter":[{"geo_distance": {"distance": "1km","location": "1.368960,103.957980"}}]} - - version: '0.1.0' -servers: - - url: 'https://api.sentient.io' -tags: -- name: "v0.1.0" - description: "Published Date - Nov 25, 2019" -paths: - /DaaS/prod/directories/searchbranch: - get: - tags: - - v0.1.0 - parameters: - - in: query - name: querystring - schema: - type: string - description: |+ - Simple keyword search for matches in all searchable fields. Keywords separated by spaces will return results containing any of those keywords. For exact phrase match, put entire phrase in double quotes (" "). - - If this field is set to null, by default the microservice will return all buildings (within the stated limit), which can be further refined through the filterdata field for more sophisticated queries. - - example: "serangoon" - default: false - - in: query - name: offset - schema: - type: integer - description: The offset of the record list ie the starting index - example: "0" - default: false - - in: query - name: limit - schema: - type: integer - description: The max records to return for the request. Default - 10, Max - 10000 - example: "10" - default: false - - in: query - name: filterdata - schema: - type: string - description: |+ - Refine the search further on any of the possible through the 4 filter types : - * must - * must_not - * should - * filter - default: false - example: |+ - {"must":[{"range":{"block":{"gte":100}}}],"should":[{"range":{"block":{"lte":200}}}],"filter":[{"match_phrase":{"street":"ang mo kio"}}],"must_not":[{"match":{"street":"avenue 3"}}]} - responses: - '200': - description: success response - content: - application/json: - schema: - $ref: '#/components/schemas/success' - example: - results: - total: 1 - max_score: 12.08503 - hits: - - _index: sentient_directory_building_index - _type: dir_doc - _id: uLxcqWgBv3dNEHq2Dznn - _score: 12.08503 - _source: - buildingname: nex - postalcode: '556083' - block: '23' - street: serangoon central - location: - lat: 1.350748 - lon: 103.872798 - source: starhub - createddate: '2019-02-01' - message: Successfully Processed - status: Success - '401': - description: Unauthorized - content: - application/json: - schema: - $ref: '#/components/schemas/unauthorized' - '402': - description: Payment Required - content: - application/json: - schema: - $ref: '#/components/schemas/paymentrequired' - '403': - description: Forbidden - content: - application/json: - schema: - $ref: '#/components/schemas/forbidden' - '404': - description: Not Found - content: - application/json: - schema: - $ref: '#/components/schemas/notfound' - '419': - description: Input Field Missing - content: - application/json: - schema: - $ref: '#/components/schemas/inputfieldmissing' - '413': - description: Input Limit Exceeded - content: - application/json: - schema: - $ref: '#/components/schemas/inputlimitexceeded' - '415': - description: Invalid Input - content: - application/json: - schema: - $ref: '#/components/schemas/invalidinput' - '500': - description: Internal Server Error - content: - application/json: - schema: - $ref: '#/components/schemas/servererror' - '504': - description: Gateway Timeout - content: - application/json: - schema: - $ref: '#/components/schemas/gatewaytimeout' - security: - - APIAuthorizer: [] -components: - schemas: - success: - type: object - properties: - results: - type: object - example: {} - description: Json Object of returned results - properties: - total: - type: number - example: 1 - description: Total number of records - max_score: - type: number - example: 17.995623 - description: The highest score value - hits: - type: array - example: [{} - description: Json Object of returned hits - properties: - buildingname: - type: string - description: Building Name - example: "nex" - street: - type: string - description: Street Name of Building - example: "serangoon central" - postalcode: - type: string - description: Postal code - example: "556083" - block: - type: string - description: Block Number - example: "23" - location: - type: object - description: WGS84 coordinates lat/long - example: {"lat":1.350748,"lon":103.872798} - properties: - lat: - type: string - description: WGS84 latitude - example: 1.350748 - lon: - type: string - description: WGS84 longitude - example: 103.872798 - source: - type: string - description: Dataset source - example: "hdb" - createddate: - type: string - description: Record first released date on Sentient.io - example: "2019-02-01" - message: - type: string - example: Successfully Processed - description: The detail description on the status - status: - type: string - example: Success - description: The status of the API call Success/Failure - unauthorized: - type: object - properties: - message: - type: string - example: Missing Authentication Token - status: - type: string - example: Failure - forbidden: - type: object - properties: - message: - type: string - example: Access Denied Unauthorized User - status: - type: string - example: Failure - paymentrequired: - type: object - properties: - message: - type: string - example: Insufficient Credits Kindly Top Up - status: - type: string - example: Failure - notfound: - type: object - properties: - message: - type: string - example: Invalid Request URL - status: - type: string - example: Failure - servererror: - type: object - properties: - message: - type: string - example: Internal Server Error - status: - type: string - example: Failure - gatewaytimeout: - type: object - properties: - message: - type: string - example: Request Timeout - status: - type: string - example: Failure - inputfieldmissing: - type: object - properties: - message: - type: string - example: Input Field Missing - status: - type: string - example: Failure - inputlimitexceeded: - type: object - properties: - message: - type: string - example: Input Limit Exceeded - status: - type: string - example: Failure - invalidinput: - type: object - properties: - message: - type: string - example: Invalid Input - status: - type: string - example: Failure - versions: - type: object - properties: - v0.1.0: - type: array - items: - oneOf: - - type: string - example: Published Date - Nov 25,2019 - description: Initial version release - securitySchemes: - APIAuthorizer: - type: apiKey - name: x-api-key - in: header - x-amazon-apigateway-authtype: custom - description: Authentication is done using the x-api-key in the request header. diff --git a/yaml/carpark_hdb_sg.yaml b/yaml/carpark_hdb_sg.yaml deleted file mode 100644 index e3f0a2708..000000000 --- a/yaml/carpark_hdb_sg.yaml +++ /dev/null @@ -1,506 +0,0 @@ -openapi: 3.0.1 -info: - title: HDB Carpark Locations (SG) - x-subscribelink: carpark_hdb_sg - description: |+ - This Data microservice retrieves the Singapore Housing Development Board's carpark information within Singapore HDB estates and includes the location address, postal code and parking lot capacity for different types of vehicle by carpark location. Updated monthly. - - The HDB POTH programme makes selected public and non-public datasets available to developers and companies to improve their service offerings to benefit the lives of Singapore citizens. Sentient.io is proud to partner with HDB to manage and facilitate the sharing of data for the POTH Programme. - - **Note:** As this microservice uses the GET method, developers using this microservice must remember to have their app encode all the input values to be URL friendly (i.e. all spaces and special characters must be replaced). Here’s a reference on [URL encoding](https://www.w3schools.com/tags/ref_urlencode.ASP). - - x-additionalinfo : |+ - Suggested Use Cases: - - Geo-targeting app with map feature, property development planning resource, or planning for vehicle-sharing app. - - - Real estate services - can be used as a background check solution to extract information related to the types and number of carparks present in an area for people with certain preferences when buying or renting a HDB home. - - - Can also be integrated into apps related to maps or parking for more detailed carpark information within Singapore HDB estates - - **Refining queries in the filterdata field using filter types and match types** - - The filterdata fields use elasticsearch’s syntax (specifically filter types and match types) to help further refine search results and provide greater flexibility in structuring more sophisticated queries. - - **Filter Types:** - - A filter type is a logic operator to which the search results must fulfill certain logical conditions to be returned. The supported match types are: - - * **must** - All of the stated conditions must match. Equivalent to an AND operator. - - > {"must":[{"match":{"mc":0}}]} - - * **must_not** - All of the stated conditions must not match. Equivalent to a NOT operator. - - > {"must_not":[{"match":{"postalcode":"570251"}}]} - - * **should** - At least one of the stated conditions should match. Equivalent to an OR operator. - - > {"should":[{"match_phrase":{"street":"ang mo kio"}}]} - - * **filter** - All of the stated conditions that must match. However, results are not scored unlike the other filter types which returns results based on how well the conditions are met. - - > {"filter":[{"match":{"street":"bishan"}}]} - - For a more detailed guide on filter types, [refer to this](https://www.elastic.co/guide/en/elasticsearch/reference/6.8/query-dsl-bool-query.html). - - Filter types cannot be used alone and must be used in conjunction with a match type to complete the query. - - **Match Types:** - - A match type is a match operator nested within a filter type that fine-tunes the matching condition of the text search. The supported match types are: - - * **match** - Search within a full text field for a single word - - > {"match":{"street":"bishan"}} - - * **match_phrase** - Search within a full text field - - > {"match_phrase":{"street":"bishan street 24"}} - - * **match_phrase_prefix** - Search within a full text field with prefix - - > {"match_phrase_prefix":{"street":"bishan street 24"}} - - * **term** - Returns results that contain an exact term in a provided field - - > {"term":{"cpk_no":"ak19"}} - - * **terms** - Returns results that contain one or more exact terms in a provided field - - > {"terms":{"cpk_no":["ak19","be33"]}} - - * **range** - Returns results that contain terms within a stipulated range - - > {"range":{"car":{"gte":100}}} - > {"range":{"car":{"lte":500}}} - > {"range":{"car":{"gte":100,"lte":500}}} - - * **exists** - Returns results that contain any indexed value for a field - - > {"exists":{ "field": "postalcode"}} - - For a more detailed guide to match types, [refer to this](https://www.elastic.co/guide/en/elasticsearch/reference/7.9/term-level-queries.html). - - **Forming sophisticated queries using combinations of filter types (in JSON)** - - Multiple filter types can be combined together in one query (written in JSON format) to form a very sophisticated query. Here’s one example below: - - > { - > "must":[{"match":{"mc":0}}], - > "filter":[{"match":{"street":"bishan"}}], - > "should":[{"match_phrase":{"street":"ang mo kio"}}], - > "must_not":[{"match":{"postalcode":"570251"}}] - > } - - **Sample Queries Based on Use Cases** - - 1. **Search for all carparks around 414 Bedok North Road** - - Using a querystring only: - - > querystring = "414 bedok north road" - - 2. **Search for all carparks within a 1KM radius from Tampines Mall** - - Using a filterdata only: - - > filterdata = {"filter":[{"geo_distance": {"distance": "1km","location": "1.3525,103.9447"}}]} - - 3. **Search for all carparks around Tampines with motorcycle parking** - - Using both querystring + filterdata: - - > querystring = tampines - > filterdata = {"filter":[ {"range":{"mc":{"gte":1}}} ]} - - 4. **Search for all lorry parking lots for Bishan Street 22** - - Using both querystring + filterdata: - - > querystring = "bishan street 22" - > filterdata = {"filter":[ {"range":{"lorry":{"gte":1}}} ]} - - version: '0.2.0' -servers: - - url: 'https://api.sentient.io' -tags: -- name: "v0.2.0" - description: "Published Date - Sep 15, 2020" -paths: - /DaaS/prod/hdb/carpark: - get: - tags: - - v0.2.0 - parameters: - - in: query - name: querystring - schema: - type: string - description: |+ - Simple keyword search for matches in all searchable fields. Keywords separated by spaces will return results containing any of those keywords. For exact phrase match, put entire phrase in double quotes (" "). - - If this field is set to null, by default the microservice will return all carparks (within the stated limit), which can be further refined through the filterdata field for more sophisticated queries. - - example: BE33 - default: false - - in: query - name: offset - schema: - type: integer - description: The offset of the record list ie the starting index - example: "0" - default: false - - in: query - name: limit - schema: - type: integer - description: The max records to return for the request. Default - 10, Max - 10000 - example: "10" - default: false - - in: query - name: filterdata - schema: - type: string - description: |+ - Refine the search further on any of the possible through the 4 filter types : - - * must - * must_not - * should - * filter - - default: false - example: |+ - {"must":[{"match":{"mc":0}}],"filter":[{"match":{"street":"bishan"}}],"should":[{"match_phrase":{"street":"ang mo kio"}}],"must_not":[{"match":{"postalcode":"570251"}}]} - responses: - '200': - description: success response - content: - application/json: - schema: - $ref: '#/components/schemas/success' - example: - results: - total: 1 - max_score: 7.510164 - hits: - - _index: sentient_carpark_hdb_index - _type: dir_doc - _id: BE37 - _score: 7.510164 - _source: - cpk_no: BE37 - block: BLK 282 - street: BISHAN STREET 22 - address: BLK 282 BISHAN STREET 22 - source: hdb - xcoord: '29235.553' - ycoord: '37787.1371' - car: 402 - lorry: 40 - mc: 0 - createddate: '2020-09-11' - lastupdated: '2020-09-11' - location: - lat: 1.3580079412271227 - lon: 103.84442083770412 - postalcode: - - '570278' - - '570279' - - '570280' - - '570281' - - '570282' - - '570283' - - '570284' - - '570285' - - '570286' - - '570287' - message: Successfully Processed - status: Success - '401': - description: Unauthorized - content: - application/json: - schema: - $ref: '#/components/schemas/unauthorized' - '402': - description: Payment Required - content: - application/json: - schema: - $ref: '#/components/schemas/paymentrequired' - '403': - description: Forbidden - content: - application/json: - schema: - $ref: '#/components/schemas/forbidden' - '404': - description: Not Found - content: - application/json: - schema: - $ref: '#/components/schemas/notfound' - '419': - description: Input Field Missing - content: - application/json: - schema: - $ref: '#/components/schemas/inputfieldmissing' - '413': - description: Input Limit Exceeded - content: - application/json: - schema: - $ref: '#/components/schemas/inputlimitexceeded' - '415': - description: Invalid Input - content: - application/json: - schema: - $ref: '#/components/schemas/invalidinput' - '500': - description: Internal Server Error - content: - application/json: - schema: - $ref: '#/components/schemas/servererror' - '504': - description: Gateway Timeout - content: - application/json: - schema: - $ref: '#/components/schemas/gatewaytimeout' - security: - - APIAuthorizer: [] -components: - schemas: - success: - type: object - properties: - results: - type: object - example: {} - description: Json Object of returned results - properties: - total: - type: number - example: 986 - description: Total number of records - max_score: - type: number - example: 17.995623 - description: The highest score value - hits: - type: array - example: [{} - description: Json Object of returned hits - properties: - cpk_no: - type: string - description: Carpark Number - example: AK19 - block: - type: string - description: Address block no - example: "BLOCK 253" - street: - type: string - description: Address street or building name - example: "ANG MO KIO STREET 21" - address: - type: string - description: Address full address - example: "BLOCK 253 ANG MO KIO STREET 21" - source: - type: string - description: Dataset source - example: "hdb" - postalcode: - type: array - description: List of postal code - example: ["570253", "570254"] - items: - type: string - description: postal code - example: "570253" - xcoord: - type: string - description: SVY21 X coordinates (Note, SVY21 is a localised plane coordinate system used specifically by Singapore. For global GPS lat/long coordinates, refer to "location" object) - example: 28185.4359 - ycoord: - type: string - description: SVY21 Y coordinates (Note, SVY21 is a localised plane coordinate system used specifically by Singapore. For global GPS lat/long coordinates, refer to "location" object) - example: 39012.6664 - location: - type: object - description: WGS84 (World Geodetic System) lat/long coordinates. This is the standard coordinate system used Global Positioning System (GPS). - example: {"lat":1.364299477060462,"lon":103.8350609414261} - properties: - lat: - type: string - description: WGS84 (GPS) latitude - example: 1.37179535 - lon: - type: string - description: WGS84 (GPS) longitude - example: 103.8469821 - car: - type: number - description: Number of car parking lots - example: 18 - lorry: - type: number - description: Number of lorry parking lots - example: 6 - mc: - type: number - description: Number of motorcycle parking lots - example: 0 - createddate: - type: string - description: Record first release date on sentient - example: "2019-10-17" - lastupdated: - type: string - description: Record last updated date on sentient - example: "2019-10-17" - message: - type: string - example: Successfully Processed - description: The detail description on the status - status: - type: string - example: Success - description: The status of the API call Success/Failure - unauthorized: - type: object - properties: - message: - type: string - example: Missing Authentication Token - status: - type: string - example: Failure - forbidden: - type: object - properties: - message: - type: string - example: Access Denied Unauthorized User - status: - type: string - example: Failure - paymentrequired: - type: object - properties: - message: - type: string - example: Insufficient Credits Kindly Top Up - status: - type: string - example: Failure - notfound: - type: object - properties: - message: - type: string - example: Invalid Request URL - status: - type: string - example: Failure - servererror: - type: object - properties: - message: - type: string - example: Internal Server Error - status: - type: string - example: Failure - gatewaytimeout: - type: object - properties: - message: - type: string - example: Request Timeout - status: - type: string - example: Failure - inputfieldmissing: - type: object - properties: - message: - type: string - example: Input Field Missing - status: - type: string - example: Failure - inputlimitexceeded: - type: object - properties: - message: - type: string - example: Input Limit Exceeded - status: - type: string - example: Failure - invalidinput: - type: object - properties: - message: - type: string - example: Invalid Input - status: - type: string - example: Failure - versions: - type: object - properties: - v0.2.0: - type: array - items: - oneOf: - - type: string - example: Published Date - Sep 15,2020 - description: |+ - The following additional fields are added: - 1. postalcode - list of postal code - 2. location - lat / log of the carpark park - v0.1.0: - type: array - items: - oneOf: - - type: string - example: Published Date - Nov 25,2019 - description: Initial version release - securitySchemes: - APIAuthorizer: - type: apiKey - name: x-api-key - in: header - x-amazon-apigateway-authtype: custom - description: Authentication is done using the x-api-key in the request header. diff --git a/yaml/commercial_directories_hdb_sg.yaml b/yaml/commercial_directories_hdb_sg.yaml deleted file mode 100644 index 8de02e396..000000000 --- a/yaml/commercial_directories_hdb_sg.yaml +++ /dev/null @@ -1,520 +0,0 @@ -openapi: 3.0.1 -info: - title: HDB Commercial Directories (SG) - x-subscribelink: commercial_directories_hdb_sg - description: |+ - This Data microservice retrieves the list of all retail shops within Singapore HDBs and allows you to search for a shop by its name, address, building name, postal code, latitude and longitude coordinates type of business. The resultant dataset offers useful information like the shop operating hours and contact number. Updated weekly. - - The HDB POTH programme makes selected public and non-public datasets available to developers and companies to improve their service offerings to benefit the lives of Singapore citizens. Sentient.io is proud to partner with HDB to manage and facilitate the sharing of data for the POTH Programme. - - **Note:** As this microservice uses the GET method, developers using this microservice must remember to have their app encode all the input values to be URL friendly (i.e. all spaces and special characters must be replaced). Here’s a reference on [URL encoding](https://www.w3schools.com/tags/ref_urlencode.ASP). - - x-additionalinfo : |+ - Suggested Use Cases: - - Build a resident community mobile app with e-commerce collection and estate directory features. To illustrate, the app can: - Name retail shops in HDBs based on their GPS location. - - **Refining queries in the filterdata field using filter types and match types** - - The filterdata fields use elasticsearch’s syntax (specifically filter types and match types) to help further refine search results and provide greater flexibility in structuring more sophisticated queries. - - **Filter Types:** - - A filter type is a logic operator to which the search results must fulfill certain logical conditions to be returned. The supported match types are: - - * **must** - All of the stated conditions must match. Equivalent to an AND operator. - - > {"must":[{"match_phrase":{"name":"ang mo kio"}}]} - - * **must_not** - All of the stated conditions must not match. Equivalent to a NOT operator. - - > {"must_not":[{"match":{"trade":"shop"}}]} - - * **should** - At least one of the stated conditions should match. Equivalent to an OR operator. - - > {"should":[{"match":{"postalcode":"650633"}}]} - - * **filter** - All of the stated conditions that must match. However, results are not scored unlike the other filter types which returns results based on how well the conditions are met. - - > {"filter":[{"match":{"trade":"retail"}}]} - - For a more detailed guide on filter types, [refer to this](https://www.elastic.co/guide/en/elasticsearch/reference/6.8/query-dsl-bool-query.html). - - Filter types cannot be used alone and must be used in conjunction with a match type to complete the query. - - **Match Types:** - - A match type is a match operator nested within a filter type that fine-tunes the matching condition of the text search. The supported match types are: - - * **match** - Search within a full text field for a single word - - > {"match":{"street":"bishan"}} - - * **match_phrase** - Search within a full text field - - > {"match_phrase":{ "street":bishan street 24"}} - - * **match_phrase_prefix** - Search within a full text field with prefix - - > {"match_phrase_prefix":{"street":"bishan street"}} - - * **term** - Returns results that contain an exact term in a provided field - - > {"term":{"postalcode":"560720"}} - - * **terms** - Returns results that contain one or more exact terms in a provided field - - > {"terms":{"postalcode":["560720","560721"]}} - - * **range** - Returns results that contain terms within a stipulated range - - > {"range":{"postalcode":{"lte":650347}}} - > {"range":{"postalcode":{"gte":650347}}} - > {"range":{"postalcode":{"gte":650347,"lte":760415}}} - - * **exists** - Returns results that contain any indexed value for a field - - > {"exists":{ "field": "postalcode"}} - - For a more detailed guide to match types, [refer to this](https://www.elastic.co/guide/en/elasticsearch/reference/7.9/term-level-queries.html). - - **Forming sophisticated queries using combinations of filter types (in JSON)** - - Multiple filter types can be combined together in one query (written in JSON format) to form a very sophisticated query. Here’s one example below: - - > { - > "must":[{"match_phrase":{"street":"ang mo kio avenue 6"}}], - > "filter":[{"match":{"trade":"shop"}}], - > "should":[{"match":{"postalcode":"650633"}}], - > "must_not":[{"match":{"trade":"betting"}}] - > } - - **Sample Queries Based on Use Cases** - - 1. **Search for all commercial directories around ang mo kio street 21** - - Using a querystring only: - - > querystring = "ang mo kio street 21" - - 2. **Search for all commercial directories within a 1KM radius from Tampines Mall** - - Using a filterdata only: - - > filterdata = {"filter":[{"geo_distance": {"distance": "1km","location": "1.3525,103.9447"}}]} - - 3. **Search for all cake shop shops at Blk 122, Bukit Merah Lane 1** - - Using a filterdata only: - - > filterdata = {"filter":[{"match_phrase": {"trade":"cake shop"}},{"match": {"block":"122"}},{"match_phrase": {"street":"bukit merah lane 1"}}]} - - version: '0.1.0' -servers: - - url: 'https://api.sentient.io' -tags: -- name: "v0.1.0" - description: "Published Date - Dec 26, 2018" -paths: - /DaaS/prod/directories/hdb/searchdir: - get: - tags: - - v0.1.0 - parameters: - - in: query - name: querystring - schema: - type: string - description: |+ - Simple keyword search for matches in all searchable fields. Keywords separated by spaces will return results containing any of those keywords. For exact phrase match, put entire phrase in double quotes (" "). - - If this field is set to null, by default the microservice will return all retail shops (within the stated limit), which can be further refined through the filterdata field for more sophisticated queries. - - example: "retail" - default: false - - in: query - name: offset - schema: - type: integer - description: The offset of the record list ie the starting index - example: "0" - default: false - - in: query - name: limit - schema: - type: integer - description: The max records to return for the request. Default - 10, Max - 10000 - example: "10" - default: false - - in: query - name: filterdata - schema: - type: string - description: |+ - Refine the search further on any of the possible through the 4 filter types : - * must - * must_not - * should - * filter - default: false - example: |+ - {"must":[{"match_phrase":{"street":"ang mo kio avenue 6"}}],"filter":[{"match":{"trade":"shop"}}],"should":[{"match":{"postalcode":"650633"}}],"must_not":[{"match":{"trade":"betting"}}]} - - responses: - '200': - description: success response - content: - application/json: - schema: - $ref: '#/components/schemas/success' - example: - results: - total: 3735 - max_score: 17.995623 - hits: - - _index: sentient_directory_hdb_index - _type: dir_doc - _id: K7scqWgBv3dNEHq2WvMo - _score: 17.995623 - _source: - id: '201902011250341437360' - postalcode: '560720' - unit: '4102' - level: '01' - source: hdb - name: Ang Mo Kio Polyclinic - phonenumber: '63553000' - email: '' - operatinghours: mon - fri 8am - 4.30pm sat 8am - 12.30pm - trade: shop/retail - createddate: '2019-02-01' - type: shop - block: '720' - street: ang mo kio avenue 6 - xcoord: 29520.58 - ycoord: 39311.68 - location: - lat: 1.37179535 - lon: 103.8469821 - message: Successfully Processed - status: Success - '401': - description: Unauthorized - content: - application/json: - schema: - $ref: '#/components/schemas/unauthorized' - '402': - description: Payment Required - content: - application/json: - schema: - $ref: '#/components/schemas/paymentrequired' - '403': - description: Forbidden - content: - application/json: - schema: - $ref: '#/components/schemas/forbidden' - '404': - description: Not Found - content: - application/json: - schema: - $ref: '#/components/schemas/notfound' - '419': - description: Input Field Missing - content: - application/json: - schema: - $ref: '#/components/schemas/inputfieldmissing' - '413': - description: Input Limit Exceeded - content: - application/json: - schema: - $ref: '#/components/schemas/inputlimitexceeded' - '415': - description: Invalid Input - content: - application/json: - schema: - $ref: '#/components/schemas/invalidinput' - '500': - description: Internal Server Error - content: - application/json: - schema: - $ref: '#/components/schemas/servererror' - '504': - description: Gateway Timeout - content: - application/json: - schema: - $ref: '#/components/schemas/gatewaytimeout' - security: - - APIAuthorizer: [] -components: - schemas: - success: - type: object - properties: - results: - type: object - example: {} - description: Json Object of returned results - properties: - total: - type: number - example: 986 - description: Total number of records - max_score: - type: number - example: 17.995623 - description: The highest score value - hits: - type: array - example: [{} - description: Json Object of returned hits - properties: - id: - type: string - description: Unique Id - example: "201902011250341437360" - postalcode: - type: string - description: Postal code of a block - example: "560720" - unit: - type: string - description: Unit number - example: "4102" - level: - type: string - description: Floor level - example: "01" - source: - type: string - description: Dataset source - example: "hdb" - name: - type: string - description: Business name - example: "Ang Mo Kio Polyclinic" - phonenumber: - type: string - description: Contact number - example: "63553000" - email: - type: string - description: Email address - example: "amk128@renalteam.org" - operatinghours: - type: string - description: Business operating hours. Multiple values are separated using ‘;’ - example: "mon - fri 8am - 4.30pm sat 8am - 12.30pm" - trade: - type: string - description: |+ - Business trade type. Trade List are: - commercial school - shop/retail - childcare centre - confectionery - office - betting - eating house/fast food restaurant/food court - family restaurant - health centre and amusement ctr - laundry shop - showroom - pet shop - social com - supermarket - specific use - health & fitness - home - fashion & accessories - groceries - schools & centres - business - pets - dining - food products - beauty - cake shop - shopping - finance - entertainment & leisure - hobbies & interests - travel and tourism - light industrial - sports and recreation building - others - example: "shop/retail" - createddate: - type: string - description: Record created date - example: "2019-02-01" - type: - type: string - description: Record type - example: "shop" - block: - type: string - description: Block number - example: "720" - street: - type: string - description: Full street name - example: "ang mo kio avenue 6" - xcoord: - type: string - description: SVY21 X coordinates - example: 29520.58 - ycoord: - type: string - description: SVY21 Y coordinates - example: 39311.68 - location: - type: object - description: WGS84 coordinates lat/long - example: {"lat":1.364299477060462,"lon":103.8350609414261} - properties: - lat: - type: string - description: WGS84 latitude - example: 1.37179535 - lon: - type: string - description: WGS84 longitude - example: 103.8469821 - message: - type: string - example: Successfully Processed - description: The detail description on the status - status: - type: string - example: Success - description: The status of the API call Success/Failure - unauthorized: - type: object - properties: - message: - type: string - example: Missing Authentication Token - status: - type: string - example: Failure - forbidden: - type: object - properties: - message: - type: string - example: Access Denied Unauthorized User - status: - type: string - example: Failure - paymentrequired: - type: object - properties: - message: - type: string - example: Insufficient Credits Kindly Top Up - status: - type: string - example: Failure - notfound: - type: object - properties: - message: - type: string - example: Invalid Request URL - status: - type: string - example: Failure - servererror: - type: object - properties: - message: - type: string - example: Internal Server Error - status: - type: string - example: Failure - gatewaytimeout: - type: object - properties: - message: - type: string - example: Request Timeout - status: - type: string - example: Failure - inputfieldmissing: - type: object - properties: - message: - type: string - example: Input Field Missing - status: - type: string - example: Failure - inputlimitexceeded: - type: object - properties: - message: - type: string - example: Input Limit Exceeded - status: - type: string - example: Failure - invalidinput: - type: object - properties: - message: - type: string - example: Invalid Input - status: - type: string - example: Failure - versions: - type: object - properties: - v0.1.0: - type: array - items: - oneOf: - - type: string - example: Published Date - Dec 26,2018 - description: Initial version release - securitySchemes: - APIAuthorizer: - type: apiKey - name: x-api-key - in: header - x-amazon-apigateway-authtype: custom - description: Authentication is done using the x-api-key in the request header. diff --git a/yaml/csv-json_convertor.yaml b/yaml/csv-json_convertor.yaml deleted file mode 100644 index fd4177318..000000000 --- a/yaml/csv-json_convertor.yaml +++ /dev/null @@ -1,232 +0,0 @@ -openapi: 3.0.1 -info: - title: CSV-JSON Convertor - description: |+ - This Utility microservice converts the input CSV to JSON format. The headers should be the keywords and columns should be the value of proper keywords. - - The size of your file should **not exceed 3.5 MB**. - x-additionalinfo: |+ - Suggested Use Cases: - - For users who would like to combine data into useful spreadsheets for others to analyze, update, or refer to. This microservice can convert a collection of CSV spreadsheets like Google Sheets or Excel into JSON to analyze data without programming. - version: '1.0.0' - x-subscribelink: csv-json_convertor -servers: - - url: 'https://apis.sentient.io' -tags: -- name: "v1.0.0" - description: "Published Date - May 15, 2020" -paths: - /microservices/utility/csvtojson/v1.0/getresults: - post: - tags: - - v1.0.0 - responses: - '200': - description: success response - content: - application/json: - schema: - $ref: '#/components/schemas/success' - example: - message: Successfully Converted and stored in Google Cloud Storage - results: - jsondata: [] - url: https://storage.googleapis.com/json_csv/data.json?X-Goog-Algorithm=GOOG4-RSA-SHA256&X-Goog-Credential=sentient-bigquery%40sentient-231509.iam.gserviceaccount.com%2F20200617%2Fauto%2Fstorage%2Fgoog4_request&X-Goog-Date=20200617T125854Z&X-Goog-Expires=6000&X-Goog-SignedHeaders=host&X-Goog-Signature=b66fb7b978a78d702e099b44ce7575de8a29834c23a6d365368022d7b1ab815e154100aa1648650e8b9ff9c038f0a61ac7d6d22b04195f18dfbf365e2050a7cbb29d9f87eb860fbe36f10573c941856341fa3117bbfee92bbd7e189ceca0a62fa8b78cb62647c4fc47e60e972c7c107088698924a7217571fee1900888c987fd80bdc078d4d765f6a4a65f4ff792c42344e07caf39b73961bee0d4b83407fda54e0d6b90fe528f62908ea54e3b07d8fba8098859330d6e9cc698f6cede40bdc05f1ec4efb29f1afc93572de52fe531d3b67fbdd035844a97b310e16eec17a4edeabdabb076b29bee9b1d44e0b90951c070046534f660d2fb291a1e1bae98ddc3 - status: Success - '401': - description: Unauthorized - content: - application/json: - schema: - $ref: '#/components/schemas/unauthorized' - '402': - description: Payment Required - content: - application/json: - schema: - $ref: '#/components/schemas/paymentrequired' - '403': - description: Forbidden - content: - application/json: - schema: - $ref: '#/components/schemas/forbidden' - '404': - description: Not Found - content: - application/json: - schema: - $ref: '#/components/schemas/notfound' - '419': - description: Input Field Missing - content: - application/json: - schema: - $ref: '#/components/schemas/inputfieldmissing' - '413': - description: Input Limit Exceeded - content: - application/json: - schema: - $ref: '#/components/schemas/inputlimitexceeded' - '415': - description: Invalid Input - content: - application/json: - schema: - $ref: '#/components/schemas/invalidinput' - '500': - description: Internal Server Error - content: - application/json: - schema: - $ref: '#/components/schemas/servererror' - '504': - description: Gateway Timeout - content: - application/json: - schema: - $ref: '#/components/schemas/gatewaytimeout' - security: - - APIAuthorizer: [] - requestBody: - content: - multipart/form-data: - schema: - $ref: '#/components/schemas/input' - required: true -components: - schemas: - success: - type: object - properties: - message: - type: string - description: Successfully Converted and stored in Google Cloud Storage - example: Successfully Converted and stored in Google Cloud Storage - results: - type: object - example: { "" } - description: List of items - properties: - jsondata: - type: string - example: [{"emp_name":"xxxxx","email":"xxxxx@sentient.io","job":"developer"}] - description: converted json object - url: - type: string - description: converted json object - example: https://storage.googleapis.com/json_csv/data.json?X-Goog-Algorithm=GOOG4-RSA-SHA256&X-Goog-Credential=sentient-bigquery%40sentient-231509.iam.gserviceaccount.com%2F20200617%2Fauto%2Fstorage%2Fgoog4_request&X-Goog-Date=20200617T125854Z&X-Goog-Expires=6000&X-Goog-SignedHeaders=host&X-Goog-Signature=b66fb7b978a78d702e099b44ce7575de8a29834c23a6d365368022d7b1ab815e154100aa1648650e8b9ff9c038f0a61ac7d6d22b04195f18dfbf365e2050a7cbb29d9f87eb860fbe36f10573c941856341fa3117bbfee92bbd7e189ceca0a62fa8b78cb62647c4fc47e60e972c7c107088698924a7217571fee1900888c987fd80bdc078d4d765f6a4a65f4ff792c42344e07caf39b73961bee0d4b83407fda54e0d6b90fe528f62908ea54e3b07d8fba8098859330d6e9cc698f6cede40bdc05f1ec4efb29f1afc93572de52fe531d3b67fbdd035844a97b310e16eec17a4edeabdabb076b29bee9b1d44e0b90951c070046534f660d2fb291a1e1bae98ddc3 - status: - type: string - example: Success - description: The status of the API call. success/failure - unauthorized: - type: object - properties: - message: - type: string - example: Missing Authentication Token - status: - type: string - example: Failure - forbidden: - type: object - properties: - message: - type: string - example: Access Denied Unauthorized User - status: - type: string - example: Failure - paymentrequired: - type: object - properties: - message: - type: string - example: Insufficient Credits Kindly Top Up - status: - type: string - example: Failure - notfound: - type: object - properties: - message: - type: string - example: Invalid Request URL - status: - type: string - example: Failure - servererror: - type: object - properties: - message: - type: string - example: Internal Server Error - status: - type: string - example: Failure - gatewaytimeout: - type: object - properties: - message: - type: string - example: Request Timeout - status: - type: string - example: Failure - inputfieldmissing: - type: object - properties: - message: - type: string - example: Input Field Missing - status: - type: string - example: Failure - inputlimitexceeded: - type: object - properties: - message: - type: string - example: Input Limit Exceeded - status: - type: string - example: Failure - versions: - type: object - properties: - v1.0.0: - type: array - items: - oneOf: - - type: string - example: Published Date - May 15, 2020 - description: Initial version release - invalidinput: - type: object - properties: - message: - type: string - example: Invalid Input - status: - type: string - example: Failure - input: - type: object - required: - - csvfile - properties: - csvfile: - type: string - format: binary - default: true - example: sample.csv - description: The file object. - securitySchemes: - APIAuthorizer: - type: apiKey - name: x-api-key - in: header - x-amazon-apigateway-authtype: custom - description: Authentication is done using the x-api-key in the request header diff --git a/yaml/d&b_basic_individual_search_sg.yaml b/yaml/d&b_basic_individual_search_sg.yaml deleted file mode 100644 index 768d48d54..000000000 --- a/yaml/d&b_basic_individual_search_sg.yaml +++ /dev/null @@ -1,1307 +0,0 @@ -openapi: 3.0.1 -info: - title: D&B Basic Individual Search (SG) - description: |+ - This Data microservice provides the information on the (Singapore-registered) business interest of an individual that includes the individual’s actual name, residential address, business and shareholding in businesses, current & previous ownership, litigation against individual and businesses, bankruptcy record and count on the times this individual has been searched on. Updated daily. - x-additionalinfo: |+ - Suggested Use Cases: - - Software solutions that require personal checks, e.g. in the appointment of Board Members, Directorship or C-suite level hiring, where the appointee’s background is paramount to the Company and its reputation. - - - Swift pre-employment screening solution - information provided by the microservice can be used to protect one's company's reputation from potential negative publicity by conducting background checks on individuals prior to hiring. - version: '0.1.0' - x-subscribelink: d&b_basic_individual_search_sg -servers: - - url: 'https://api.sentient.io' -tags: -- name: "v0.1.0" - description: "Published Date - Aug 15, 2019" -paths: - /dnb/prod/sbis: - post: - tags: - - v0.1.0 - summary: Adds a new user - requestBody: - content: - application/xml: - schema: - $ref: '#/components/schemas/REQUEST' - responses: - '200': - description: success response - content: - application/xml: - schema: - $ref: '#/components/schemas/success' - example: |+ - - 25/02/2009 17:31:44.678 - - - - - - 25/02/2009 17:31:44 - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - S7250163B - - - - - S7250163B - - - - - - 1 1 1 1 1 1 1 1 1 1 1 1 2017 1 - - 0 0 0 0 0 0 0 0 0 0 0 0 2016 1 - - 0 0 0 0 0 0 0 0 0 0 0 0 2015 1 - - 0 0 0 0 0 0 0 0 0 0 0 0 2017 0 - - 0 0 0 0 0 0 0 0 0 0 0 0 2016 0 - - 0 0 0 0 0 0 0 0 0 0 0 - 0 2015 0 - - - '401': - description: Unauthorized - content: - application/json: - schema: - $ref: '#/components/schemas/unauthorized' - '402': - description: Payment Required - content: - application/json: - schema: - $ref: '#/components/schemas/paymentrequired' - '403': - description: Forbidden - content: - application/json: - schema: - $ref: '#/components/schemas/forbidden' - '404': - description: Not Found - content: - application/json: - schema: - $ref: '#/components/schemas/notfound' - '419': - description: Input Field Missing - content: - application/json: - schema: - $ref: '#/components/schemas/inputfieldmissing' - '413': - description: Input Limit Exceeded - content: - application/json: - schema: - $ref: '#/components/schemas/inputlimitexceeded' - '415': - description: Invalid Input - content: - application/json: - schema: - $ref: '#/components/schemas/invalidinput' - '500': - description: Internal Server Error - content: - application/json: - schema: - $ref: '#/components/schemas/servererror' - '504': - description: Gateway Timeout - content: - application/json: - schema: - $ref: '#/components/schemas/gatewaytimeout' - security: - - APIAuthorizer: [] -components: - schemas: - success: - type: object - properties: - REPORT: - type: object - example: - description: |+ - Report details with following children: - [META_INFO] - [BASIC_INFO] - [LIT_SEARCH_INFO] - [LIST_CURRENT_COMP] - [LIST_PREVIOUS_COMP] - [LIST_BANKRUPTCY] - [LIST_LIT] - [LIST_LIT_DTL] - properties: - META_INFO: - type: object - example: |+ - - - - 25/02/2009 17:31:44.678 - - - description: |+ - Meta Information details with following children: - SERVICE - SYSTEM_ID - CREATION_DATE - USER_ID - properties: - SERVICE: - type: string - example: "BIS" - description: Report Requested - SYSTEM_ID : - type: string - example: "DDP" - description: System ID - CREATION_DATE: - type: datetime - example: "25/02/2009 17:31:44.678" - description: Report Request Date - USER_ID : - type: string - example: N/A - description: Valid user id in DDP system. It is for (For internal use) - BASIC_INFO : - type: object - description: |+ - Basic Information with following children: - PA_REG_NO - ADDRESS1 - ADDRESS2 - ADDRESS3 - example: |+ - - - - - - - properties: - PA_REG_NO: - type: string - description: Public Accountant Registration No. - example: "00091" - ADDRESS1: - type: string - description: Address 1 - example: "137" - ADDRESS2: - type: string - description: Address 2 - example: "vvvvv" - ADDRESS3: - type: string - description: Address 3 - example: "470137, SINGAPORE" - LIT_SEARCH_INFO : - type: object - example: |+ - - - - - 25/02/2009 17:31:44 - - - - - description: |+ - Litigation search information with following children: - COMP_NAME - REG_NO - REPORT_TYPE - REQ_DATE - REQ_REG_NO - REQ_NAME - REQ_DATE_STR - properties: - COMP_NAME: - type: string - description: Company Name - example: "ENG YICK HOLDINGS PTE LTD" - REG_NO: - type: string - description: Company Registration No - example: "197803191K" - REPORT_TYPE: - type: string - description: Report Type - example: "BIS" - REQ_DATE: - type: datetime - description: Requested Date - example: "25/02/2009 17:31:44" - REQ_REG_NO: - type: string - description: Request Registration Number - example: "197803191K" - REQ_NAME: - type: string - description: Request Name - example: "LOY KOK TOON" - REQ_DATE_STR: - type: string - description: Request Date String - example: "25/02/2009 15:04:14" - LIST_CURRENT_COMP : - type: array - description: |+ - List of current companies with following children: - [CURRENT_COMP] - example: |+ - - - - - - - - - - - - - - - - - - - items: - properties: - CURRENT_COMP: - type: object - description: |+ - Current companies detail with following children: - POSITION - APPOINTMENT_DATE - COMP_NAME - SEQ_NO - SHARE_VALUE1 - COMP_STATUS - PROFIT_VALUE - SHARE_VALUE - TEL - FAX - SIC - SIC_DESC - example: |+ - - - - - - - - - - - - - - - - - properties: - POSITION: - type: string - description: Position - example: "OWNER" - APPOINTMENT_DATE: - type: string - description: Appointment Date - example: "01/09/1971" - COMP_NAME: - type: string - description: Company Name - example: "BAN HOE LEONG COMPANY" - SEQ_NO: - type: string - description: Company Registration No. - example: "03647300J" - SHARE_VALUE1: - type: string - description: Share Percentage - example: "15.00" - COMP_STATUS: - type: string - description: Company Status - example: "LIVE" - PROFIT_VALUE1: - type: string - description: Profit Making 1 - example: "2008 = -" - PROFIT_VALUE2: - type: string - description: Profit Making 2 - example: "2007 = -" - PROFIT_VALUE3: - type: string - description: Profit Making 3 - example: "2006 = -" - SHARE_VALUE: - type: string - description: Number Of Shares - example: "150000" - TEL: - type: string - description: Telephone Number - example: "62994842" - FAX: - type: string - description: Fax Number - example: "62992797" - SIC: - type: string - description: SIC Code - example: "5012" - SIC_DESC: - type: string - description: SIC Description - example: "Automobiles and other Motor Vehicles" - LIST_PREVIOUS_COMP: - type: array - example: |+ - - - - - - - - - - - - - - - - - description: |+ - List of previous companies with following children: - [PREVIOUS_COMP] - items: - properties: - PREVIOUS_COMP : - type: object - description: |+ - Previous companies detail with following children: - POSITION - APPOINTMENT_DATE - COMP_NAME - SEQ_NO - SHARE_VALUE1 - COMP_STATUS - CESSATION_DATE - SHARE_VALUE - TEL - FAX - SIC - SIC_DESC - example: |+ - - - - - - - - - - - - - - - properties: - POSITION : - type: string - description: Position - example: "SHAREHOLDER" - APPOINTMENT_DATE: - type: string - description: Appointment Date - example: "30/06/1988" - COMP_NAME: - type: string - description: Company Name - example: "ENG YICK INDUSTRIES PTE LTD" - SEQ_NO: - type: string - description: Company Registration No. - example: "198101820Z" - SHARE_VALUE1: - type: string - description: Share Value Percentage - example: "100.00" - COMP_STATUS: - type: string - description: Company Status - example: "DISSOLVED - COMPULSORY WINDING UP (INSOLVENCY)" - CESSATION_DATE : - type: string - description: Cessation Date - example: "22/09/1992" - SHARE_VALUE: - type: string - description: Number Of Shares - example: "390002" - TEL: - type: string - description: Telephone Number - example: "62994842" - FAX: - type: string - description: Fax Number - example: "67467646" - SIC: - type: string - description: SIC Code - example: "2325" - SIC_DESC: - type: string - description: SIC Description - example: "Men’s and Boys’ Separate Trousers and Slacks" - LIST_BANKRUPTCY: - type: array - description: |+ - Bankruptcy/ Winding up with following children: - [BANKRUPTCY] - example: |+ - - - - - - - - - - - - - - - - - - - - - - - - - - - items: - properties: - BANKRUPTCY : - type: object - description: |+ - Bankruptcy/Winding up detail with following children: - SUBJECT_NAME - COURT_CODE - CASE_CODE - CASE_YEAR - ACTION_DATE - BANKRUPTCY_ACT - HEARING_DATE - CURRENCY1 - AMOUNT1 - CURRENCY2 - AMOUNT2 - CURRENCY3 - AMOUNT3 - BANKRUPTCY_TYPE - [LIST_PLAINTIFF] - example: |+ - - - - - - - - - - - - - - - - - - - - - - - - - properties: - SUBJECT_NAME : - type: string - description: Subject Name - example: - COURT_CODE: - type: string - description: Court Code - example: "CWU" - CASE_CODE: - type: string - description: Case Code - example: "381" - CASE_YEAR: - type: string - description: Case Year - example: "2000" - ACTION_DATE: - type: string - description: Action Date - example: "22/12/2000" - BANKRUPTCY_ACT: - type: string - description: Act of Bankruptcy - example: "Petition for Winding Up" - HEARING_DATE : - type: string - description: Hearing Date - example: "26/03/2009" - CURRENCY1: - type: string - description: Currency - example: - AMOUNT1: - type: string - description: Amount - example: "334,616.00" - CURRENCY2: - type: string - description: Currency - example: - AMOUNT2: - type: string - description: Amount - example: "0.00" - CURRENCY3: - type: string - description: Currency - example: - AMOUNT3: - type: string - description: Amount - example: "0.00" - BANKRUPTCY_TYPE: - type: string - description: Bankruptcy Type - example: "COMPANY WINDING UP PETITION" - LIST_PLAINTIFF: - type: array - description: |+ - List of Plaintiff with following children: - [PLAINTIFF] - example: |+ - - - - - - - - - items: - properties: - PLAINTIFF: - type: object - description: |+ - Plaintiff detail with following children: - PLA_NAME - PLA_SOLICITOR - PLA_SOLICITOR_ID - PLA_FILE_REF - example: |+ - - - - - - - properties: - PLA_NAME: - type: string - description: Pla. Name - example: "B 2003 P1" - PLA_SOLICITOR: - type: string - description: Pla. Solicitor - example: "PATRICK KHOO ENG HOCK" - PLA_SOLICITOR_ID: - type: string - description: Pla. Solicitor ID - example: - PLA_FILE_REF: - type: string - description: Pla. File Ref. - example: "RSP/292668/1" - LIST_LIT: - type: array - description: |+ - List of litigation with following children: - [LIT] - example: |+ - - - - - - - - items: - properties: - LIT: - type: object - description: |+ - Basic litigation info with following children: - SUBJECT_NAME - SEQ_NO - FORMATTED_ID - [LIST_LIT_DTL] - example: |+ - - - - - - properties: - SUBJECT_NAME: - type: string - description: Name - example: "ENG YICK HOLDINGS PTE LTD" - SEQ_NO: - type: integer - description: Sequence No. - example: 1 - FORMATTED_ID: - type: string - description: Formatted ID - example: "197803191K" - LIST_LIT_DTL: - type: array - description: |+ - List of litigation detail with following children: - [LIT_DTL] - example: |+ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - S7250163B - - - - - - - - - - - - - S7250163B - - - - - - - - - - - - - items: - properties: - LIT_DTL: - type: object - description: |+ - Litigation detail with following children: - NATURE_OF_CLAIM - STATUS_DATE - CASE_NO - FORMATTED_ID - DOC_REMARKS - CURRENCY1 - CURRENCY2 - CURRENCY3 - CURRENCY4 - CURRENCY5 - CASE_STATUS - AMOUNT1 - AMOUNT2 - AMOUNT3 - AMOUNT4 - AMOUNT5 - [LIST_PLAINTIFF] - [LIST_DEFENDANT] - example: |+ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - S7250163B - - - - - - - - - - - - - S7250163B - - - - - - - - - - - - properties: - NATURE_OF_CLAIM: - type: string - description: Nature of Claim - example: "CONTRACTS-WORK DONE & SERVICES RENDERED" - STATUS_DATE: - type: string - description: Status Date - example: "13/08/2001" - CASE_NO: - type: string - description: Case No. - example: "MC 23631 / 2001" - FORMATTED_ID: - type: string - description: Formatted ID - example: "197803191K" - DOC_REMARKS: - type: string - description: Document Remark - example: "WRIT OF SUMMONS" - CURRENCY1: - type: string - description: Currency 1 - example: "SIN" - CURRENCY2: - type: string - description: Currency 2 - example: - CURRENCY3: - type: string - description: Currency 3 - example: - CURRENCY4: - type: string - description: Currency 4 - example: - CURRENCY5: - type: string - description: Currency 5 - example: - CASE_STATUS: - type: string - description: Status - example: "PENDING AS AT STATUS DATE" - AMOUNT1: - type: string - description: Amount 1 - example: "36,196.00" - AMOUNT2: - type: string - description: Amount 2 - example: "0.00" - AMOUNT3: - type: string - description: Amount 3 - example: "0.00" - AMOUNT4: - type: string - description: Amount 4 - example: "0.00" - AMOUNT5: - type: string - description: Amount 5 - example: "0.00" - LIST_PLAINTIFF: - type: array - description: |+ - List of plaintiff with following children: - [PLAINTIFF] - example: |+ - - - - - - - - - - - - - S7250163B - - - items: - properties: - PLAINTIFF: - type: object - description: |+ - Plaintiff detail with following children: - PLA_NAME - LAW_FIRM - WRITE_DATE - PLA_SOLICITOR - PLA_SOLICITOR_ID - PLA_FILE_REF - PLA_STATUS - PLA_STATUS_DATE - PLA_ID - example: |+ - - - - - - - - - - - - S7250163B - - properties: - PLA_NAME: - type: string - description: Plaintiff Name - example: "ROTARY PILING PTE LTD" - LAW_FIRM: - type: string - description: Pla. Law Firm - example: "JOSEPH HOO MORRIS & KUMAR" - WRITE_DATE: - type: string - description: Writ date - example: "13/08/2001" - PLA_SOLICITOR: - type: string - description: Plaintiff Solicitor - example: "HOO JOSEPH" - PLA_SOLICITOR_ID: - type: string - description: Plaintiff Solicitor ID - example: "ORS" - PLA_FILE_REF: - type: string - description: Pla. File Ref. - example: "CHH 6253 D27" - PLA_STATUS: - type: string - description: Plaintiff Status - example: - PLA_STATUS_DATE: - type: string - description: Plaintiff Status Date - example: - PLA_ID: - type: string - description: Plaintiff ID - example: "S7250163B" - LIST_DEFENDANT: - type: array - description: |+ - List of defendant with following children: - [DEFENDANT] - example: |+ - - - - - - - - - items: - properties: - DEFENDANT: - type: object - description: |+ - Defendant detail with following children: - DEF_SOLICITOR - DEF_SOLICITOR_ID - DEF_LAW_FIRM - DEF_FILE_REF - example: |+ - - - - - - - properties: - DEF_SOLICITOR: - type: string - description: Def. Solicitor - example: - DEF_SOLICITOR_ID: - type: string - description: Def. Solicitor ID - example: N/A - DEF_LAW_FIRM: - type: string - description: Def. Law Firm - example: - DEF_FILE_REF: - type: string - description: Def. File Ref. - example: - LIST_Ddrptcount: - type: array - description: |+ - List of Search By Financial Sectors and Search By Non-Financial Sectors with following children: - [Ddrptcount] - example: |+ - - - 1 - 1 - 1 - 1 - 1 - 1 - 1 - 1 - 1 - 1 - 1 - 1 - 2017 - 1 - - - items: - properties: - Ddrptcount: - type: object - description: |+ - 6 XML tags (open then close) displays Search By Financial Sectors (counts for 3 recent years).Search By Non-Financial Sectors (counts for 3 recent years) with following children: - Rcjan - Rcfeb - Rcmar - Rcapr - Rcmay - Rcjun - Rcjul - Rcaug - Rcsep - Rcoct - Rcnov - Rcdec - Rcyear - Rcsecflag - example: |+ - - 1 - 1 - 1 - 1 - 1 - 1 - 1 - 1 - 1 - 1 - 1 - 1 - 2017 - 1 - - properties: - Rcjan: - type: integer - description: Count for January - example: "1" - Rcfeb: - type: integer - description: Count for February - example: "1" - Rcmar: - type: integer - description: Count for March - example: "1" - Rcapr: - type: integer - description: Count for April - example: "1" - Rcmay: - type: integer - description: Count for May - example: "1" - Rcjun: - type: integer - description: Count for June - example: "1" - Rcjul: - type: integer - description: Count for July - example: "1" - Rcaug: - type: integer - description: Count for August - example: "1" - Rcsep: - type: integer - description: Count for September - example: "1" - Rcoct: - type: integer - description: Count for October - example: "1" - Rcnov: - type: integer - description: Count for November - example: "1" - Rcdec: - type: integer - description: Count for December - example: "1" - Rcyear: - type: integer - description: To show the year - example: "1" - Rcsecflag: - type: integer - description: Differentiate Search By Financial Sectors and Search By Non-Financial Sectors - example: "1" - unauthorized: - type: object - properties: - message: - type: string - example: Missing Authentication Token - status: - type: string - example: Failure - forbidden: - type: object - properties: - message: - type: string - example: Access Denied Unauthorized User - status: - type: string - example: Failure - paymentrequired: - type: object - properties: - message: - type: string - example: Insufficient Credits Kindly Top Up - status: - type: string - example: Failure - notfound: - type: object - properties: - message: - type: string - example: Invalid Request URL - status: - type: string - example: Failure - servererror: - type: object - properties: - message: - type: string - example: Internal Server Error - status: - type: string - example: Failure - gatewaytimeout: - type: object - properties: - message: - type: string - example: Request Timeout - status: - type: string - example: Failure - inputfieldmissing: - type: object - properties: - message: - type: string - example: Input Field Missing - status: - type: string - example: Failure - inputlimitexceeded: - type: object - properties: - message: - type: string - example: Input Limit Exceeded - status: - type: string - example: Failure - invalidinput: - type: object - properties: - message: - type: string - example: Invalid Input - status: - type: string - example: Failure - REQUEST: - type: object - properties: - TOT_ITEMS: - type: number - example: 1 - description: Number of subjects being enquired relating to the Run - default: false - ENQUIRY: - type: object - example: |+ - 197601887ETRANSTAR TRAVEL PTE LTD - description: Contains information of each request details - default: true - properties: - SUBJECT_IDNO: - type: string - example: 199707714C - description: "Subject’s ID Number (individual) or Registration Number (company/business) as captured in DDP" - default: true - SUBJECT_NAME: - type: string - example: GPS INDUSTRIES PTE LTD - description: Subjects Name as captured in DDP - default: false - versions: - type: object - properties: - v0.1.0: - type: array - items: - oneOf: - - type: string - example: Published Date - Aug 15, 2019 - description: Initial version release - securitySchemes: - APIAuthorizer: - type: apiKey - name: x-api-key - in: header - x-amazon-apigateway-authtype: custom - description: Authentication is done using the x-api-key in the request header diff --git a/yaml/d&b_brief_financial_information_sg.yaml b/yaml/d&b_brief_financial_information_sg.yaml deleted file mode 100644 index 22143c37a..000000000 --- a/yaml/d&b_brief_financial_information_sg.yaml +++ /dev/null @@ -1,1404 +0,0 @@ -openapi: 3.0.1 -info: - title: D&B Brief Financial Information (SG) - description: This Data microservice provides the annual financial information of Singapore-registered businesses, inclusive of annual profit and loss and financial ratios. Updated daily. - x-additionalinfo: |+ - Suggested Use Cases: - - Software solutions with functions for personal credit checks, e.g. for parties who have a vested interest (e.g. banks, investors) in the company’s performance and to evaluate the company’s gearing and acid ratios. - - - Information from this microservice can be used for financial analysis - one can build models based on historical behavior. Continually update fraud patterns and compare with real-time transactions. Store and consolidate market data, trade activity, and other data, such as social and transactional data. - version: '0.1.0' - x-subscribelink: d&b_brief_financial_information_sg -servers: - - url: 'https://api.sentient.io' -tags: -- name: "v0.1.0" - description: "Published Date - Aug 15, 2019" -paths: - /dnb/prod/sbfe: - post: - tags: - - v0.1.0 - summary: Adds a new user - requestBody: - content: - application/xml: - schema: - $ref: '#/components/schemas/REQUEST' - responses: - '200': - description: success response - content: - application/xml: - schema: - $ref: '#/components/schemas/success' - example: |+ - - 25/02/2009 17:31:44> - - - 2009-04-21 10:56:06.716 - 2004 2003 2002 2005 - 2006 2007 2008 2009 2008 2007 2006 2005 2004 - - 9403795.00 8617168.00 7807393.00 31467.00 162620.00 1281387.00 31467.00 162620.00 1281387.00 0.00 0.00 60318.00> 31467.00 162620.00 1341705.00 3889213.00 3395740.00 4374368.00 3359007.00 2855754.00 3546381.00 530206.00 539986.00 827987.00> 7370430.00 6845490.00 7661498.00 6739073.00 6157560.00 6435365.00 631357.00 687930.00 122133.00 -3481217.00 -3449750.00 -3287130.00 2000000.00 2000000.00 2000000.00 0.00 0.00 0.00 5481217.00 5449750.00 5287130.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 - 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 - - 10877254.00 9982533.00 1121483.00 262632.00 1347380.00 262632.00 6562990.00 5424551.00 6283449.00 4948821.00 279541.00 475730.00 8434195.00 8643136.00 8434195.00 7933013.00 0.00 710123.00 -1871205.00 -3218585.00 2000000.00 2000000.00 0.00 0.00 -3,871,205.00 -5,218,585.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 - 0.00 0.00 0.00 0.00 - - 12.39 2.63 0.00 0.00 0.00 20.53 4.84 0.00 0.00 0.00 -72.01 -8.16 -0.00 -0.00 -0.00 1.66 1.84 2.42 2.54 1.78 0.74 0.62 0.50 0.46 0.55 -28.51 -59.33 -89.51 -101.59 -75.15 128.51 168.27 189.51 201.59 175.15 - - 1121483.0 10877254 2008 - - 262632.0> 9982533 2007 - - -31467.0 9403795 2006 - - -162620.0 8617168 2005 - - -1281387.0 7807393 2004 - - - '401': - description: Unauthorized - content: - application/json: - schema: - $ref: '#/components/schemas/unauthorized' - '402': - description: Payment Required - content: - application/json: - schema: - $ref: '#/components/schemas/paymentrequired' - '403': - description: Forbidden - content: - application/json: - schema: - $ref: '#/components/schemas/forbidden' - '404': - description: Not Found - content: - application/json: - schema: - $ref: '#/components/schemas/notfound' - '419': - description: Input Field Missing - content: - application/json: - schema: - $ref: '#/components/schemas/inputfieldmissing' - '413': - description: Input Limit Exceeded - content: - application/json: - schema: - $ref: '#/components/schemas/inputlimitexceeded' - '415': - description: Invalid Input - content: - application/json: - schema: - $ref: '#/components/schemas/invalidinput' - '500': - description: Internal Server Error - content: - application/json: - schema: - $ref: '#/components/schemas/servererror' - '504': - description: Gateway Timeout - content: - application/json: - schema: - $ref: '#/components/schemas/gatewaytimeout' - security: - - APIAuthorizer: [] -components: - schemas: - success: - type: object - properties: - REPORT: - type: object - description: |+ - Report details with following children: - [META_INFO] - [FH_SEARCH_INFO] - [FH_DTL] - [XBRL_DTL] - [FH_RATIO_DTL] - [LIST_FH_CHART_INFO] - example: - properties: - META_INFO: - type: object - description: |+ - Meta Information details with following children: - SERVICE - SYSTEM_ID - CREATION_DATE - USER_ID - example: |+ - - - - 25/02/2009 17:31:44> - - - properties: - SERVICE: - type: string - description: Report Requested - example: "BFE" - SYSTEM_ID : - type: string - description: System ID - example: "DDP" - CREATION_DATE: - type: string - description: Report Request Date - example: "25/02/2009 17:31:44" - USER_ID : - type: string - description: Valid user id in DDP system. It is for (For internal use) - example: N/A - FH_SEARCH_INFO: - type: object - description: |+ - FH search information with following children: - COMP_NAME - REG_NO - REQ_DATE - REQ_REG_NO - REQ_NAME - REQ_DATE_STR - FH_BEFORE_YR1 - FH_BEFORE_YR2 - FH_BEFORE_YR3 - FH_BEFORE_YR4 - FH_BEFORE_YR5 - FH_AFTER_YR1 - FH_AFTER_YR2 - FH_AFTER_YR3 - FH_AFTER_YR4 - FH_AFTER_YR5 - AC_RATIOS_YR1 - AC_RATIOS_YR2 - AC_RATIOS_YR3 - AC_RATIOS_YR4 - AC_RATIOS_YR5 - example: |+ - - - - 2009-04-21 10:56:06.716 - - - - 2004 - 2003 - 2002 - 2005 - 2006 - 2007 - 2008 - 2009 - 2008 - 2007 - 2006 - 2005 - 2004 - - properties: - COMP_NAME : - type: string - description: Company Name - example: "DUN & BRADSTREET (SINGAPORE) PTE. LTD." - REG_NO : - type: string - description: Company Registration No - example: "200003058W" - REQ_DATE : - type: datetime - description: Requested Date - example: "2009-04-21 10:56:06.716" - REQ_REG_NO : - type: string - description: Request Registration Number - example: "200003058W" - REQ_NAME : - type: string - description: Request Name - example: "DUN & BRADSTREET (SINGAPORE) PTE. LTD." - REQ_DATE_STR : - type: string - description: Request Date String - example: "21/04/2009 10:56:06" - FH_BEFORE_YR1 : - type: string - description: Financial Highlight filed before year 1 - example: "2004" - FH_BEFORE_YR2 : - type: string - description: Financial Highlight filed before year 2 - example: "2003" - FH_BEFORE_YR3 : - type: string - description: Financial Highlight filed before year 3 - example: "2002" - FH_AFTER_YR1: - type: string - description: Financial Highlight filed after year 1 - example: "2005" - FH_AFTER_YR2 : - type: string - description: Financial Highlight filed after year 2 - example: "2006" - FH_AFTER_YR3 : - type: string - description: Financial Highlight filed after year 3 - example: "2007" - FH_AFTER_YR4: - type: string - description: Financial Highlight filed after year 4 - example: "2008" - FH_AFTER_YR5: - type: string - description: Financial Highlight filed after year 5 - example: "2009" - AC_RATIOS_YR1 : - type: string - description: Account Ratio year 1 - example: "2008" - AC_RATIOS_YR2 : - type: string - description: Account Ratio year 2 - example: "2007" - AC_RATIOS_YR3 : - type: string - description: Account Ratio year 3 - example: "2006" - AC_RATIOS_YR4 : - type: string - description: Account Ratio year 4 - example: "2005" - AC_RATIOS_YR5 : - type: string - description: Account Ratio year 5 - example: "2004" - FH_DTL: - type: object - description: |+ - Financial Highlight with following children: - FH_YR1_CURR - TURNOVER1 - PL_BEF_TAX1 - PL_AFT_TAX1 - NETINC_NON_EXT1 - PL_AFT_TAX_EXT1 - TOT_ASSETS1 - TA_CURRENT1 - TA_FIXED1 - TOT_LIABILITIES1 - TL_CURRENT1 - TL_NON_CURRENT1 - SH_FUNDS1 - SH_PAIDUP_CAPITAL1 - SH_RESERVES1 - SH_ACCUM_LOSS1 - GRP_TURNOVER1 - GRP_PL_BEF_TAX1 - GRP_PL_AFT_TAX1 - GRP_NETINC_NON_EXT1 - GRP_PL_AFT_TAX_EXT1 - GRP_TOT_ASSETS1 - GRP_TA_CURRENT1 - GRP_TA_FIXED1 - GRP_TOT_LIABILITIES1 - GRP_TL_CURRENT1 - GRP_TL_NON_CURRENT1 - GRP_SH_FUNDS1 - GRP_SH_PAIDUP_CAPITAL1 - GRP_SH_RESERVES1 - GRP_SH_ACCUM_LOSS1 - GRP_INDICATOR1 - - Note: Each tag will consist of maximum 5 sets with suffix 1 to 5. But it is optional, depending on how many years of FH data displayed in the report. - example: |+ - - - - - 9403795.00 - 8617168.00 - 7807393.00 - 31467.00 - 162620.00 - 1281387.00 - 31467.00 - 162620.00 - 1281387.00 - 0.00 - 0.00 - 60318.00> - 31467.00 - 162620.00 - 1341705.00 - 3889213.00 - 3395740.00 - 4374368.00 - 3359007.00 - 2855754.00 - 3546381.00 - 530206.00 - 539986.00 - 827987.00> - 7370430.00 - 6845490.00 - 7661498.00 - 6739073.00 - 6157560.00 - 6435365.00 - 631357.00 - 687930.00 - 122133.00 - -3481217.00 - -3449750.00 - -3287130.00 - 2000000.00 - 2000000.00 - 2000000.00 - 0.00 - 0.00 - 0.00 - 5481217.00 - 5449750.00 - 5287130.00 - 0.00 - 0.00 - 0.00 - 0.00 - 0.00 - 0.00 - 0.00 - 0.00 - 0.00 - 0.00 - 0.00 - 0.00 - 0.00 - 0.00 - 0.00 - 0.00 - 0.00 - 0.00 - 0.00 - 0.00 - 0.00 - 0.00 - 0.00 - 0.00 - 0.00 - 0.00 - 0.00 - 0.00 - 0.00 - 0.00 - 0.00 - 0.00 - 0.00 - 0.00 - 0.00 - 0.00 - 0.00 - 0.00 - 0.00 - 0.00 - 0.00 - 0.00 - 0.00 - 0.00 - 0.00 - - - - - properties: - FH_YR1_CURR : - type: string - description: |+ - FH Before Year 1 Currency - Subsequent Years: - FH_YR2_CURR - FH_YR3_CURR - FH_YR4_CURR - FH_YR5_CURR - example: "(SGD)" - TURNOVER1 : - type: string - description: |+ - Turnover / Sales And Other Operating Revenues - Subsequent Years: - TURNOVER2 - TURNOVER3 - TURNOVER4 - TURNOVER5 - example: "9403795.00" - PL_BEF_TAX1 : - type: string - description: |+ - Profit / Loss Before Tax - Subsequent Years: - PL_BEF_TAX2 - PL_BEF_TAX3 - PL_BEF_TAX4 - PL_BEF_TAX5 - example: "31467.00" - PL_AFT_TAX1: - type: string - description: |+ - Profit / Loss After Tax - Subsequent Years: - PL_AFT_TAX2 - PL_AFT_TAX3 - PL_AFT_TAX4 - PL_AFT_TAX5 - example: "31467.00" - NETINC_NON_EXT1: - type: string - description: |+ - Net Income / Loss From Extraordinary And Non- Operating Items - Subsequent Years: - NETINC_NON_EXT2 - NETINC_NON_EXT3 - NETINC_NON_EXT4 - NETINC_NON_EXT5 - example: "0.00" - PL_AFT_TAX_EXT1 : - type: string - description: |+ - Profit / Loss After Tax and Extraordinary Items - Subsequent Years: - PL_AFT_TAX_EXT2 - PL_AFT_TAX_EXT3 - PL_AFT_TAX_EXT4 - PL_AFT_TAX_EXT5 - example: "31467.00" - TOT_ASSETS1 : - type: string - description: |+ - Total Assets - Subsequent Years: - TOT_ASSETS2 - TOT_ASSETS3 - TOT_ASSETS4 - TOT_ASSETS5 - example: "3889213.00" - TA_CURRENT1 : - type: string - description: |+ - Total Assets - Current - Subsequent Years: - TA_CURRENT2 - TA_CURRENT3 - TA_CURRENT4 - TA_CURRENT5 - example: "3359007.00" - TA_FIXED1 : - type: string - description: |+ - Total Assets – Fixed and Others - Subsequent Years: - TA_FIXED2 - TA_FIXED3 - TA_FIXED4 - TA_FIXED5 - example: "530206.00" - TOT_LIABILITIES1 : - type: string - description: |+ - Total Liabilities - Subsequent Years: - TOT_LIABILITIES2 - TOT_LIABILITIES3 - TOT_LIABILITIES4 - TOT_LIABILITIES5 - example: "7370430.00" - TL_CURRENT1 : - type: string - description: |+ - Total Liabilities - Current - Subsequent Years: - TL_CURRENT2 - TL_CURRENT3 - TL_CURRENT4 - TL_CURRENT5 - example: "6739073.00" - TL_NON_CURRENT1 : - type: string - description: |+ - Total Liabilities – Non- Current & Long Term - Subsequent Years: - TL_NON_CURRENT2 - TL_NON_CURRENT3 - TL_NON_CURRENT4 - TL_NON_CURRENT5 - example: "631357.00" - SH_FUNDS1: - type: string - description: |+ - Shareholder’s Fund - Subsequent Years: - SH_FUNDS2 - SH_FUNDS3 - SH_FUNDS4 - SH_FUNDS5 - example: "-3481217.00" - SH_PAIDUP_CAPITAL1 : - type: string - description: |+ - Shareholder’s Fund – Paid Up Capital - Subsequent Years: - SH_PAIDUP_CAPITAL2 - SH_PAIDUP_CAPITAL3 - SH_PAIDUP_CAPITAL4 - SH_PAIDUP_CAPITAL5 - example: "2000000.00" - SH_RESERVES1 : - type: string - description: |+ - Shareholder’s Fund - Reserves - Subsequent Years: - SH_RESERVES2 - SH_RESERVES3 - SH_RESERVES4 - SH_RESERVES5 - example: "0.00" - SH_ACCUM_LOSS1: - type: string - description: |+ - Shareholder’s Fund – Accumulated Loss - Subsequent Years: - SH_ACCUM_LOSS2 - SH_ACCUM_LOSS3 - SH_ACCUM_LOSS4 - SH_ACCUM_LOSS5 - example: "5481217.00" - GRP_TURNOVER1 : - type: string - description: |+ - Group Turnover / Sales and Other Operating Revenues - Subsequent Years: - GRP_TURNOVER2 - GRP_TURNOVER3 - GRP_TURNOVER4 - GRP_TURNOVER5 - example: "0.00" - GRP_PL_BEF_TAX1 : - type: string - description: |+ - Group Profit / Loss Before Tax - Subsequent Years: - GRP_PL_BEF_TAX2 - GRP_PL_BEF_TAX3 - GRP_PL_BEF_TAX4 - GRP_PL_BEF_TAX5 - example: "0.00" - GRP_PL_AFT_TAX1 : - type: string - description: |+ - Group Profit / Loss After Tax - Subsequent Years: - GRP_PL_AFT_TAX2 - GRP_PL_AFT_TAX3 - GRP_PL_AFT_TAX4 - GRP_PL_AFT_TAX5 - example: "0.00" - GRP_NETINC_NON_EXT1 : - type: string - description: |+ - Group Net Income / Loss From Extraordinary and Non-Operating Items - Subsequent Years: - GRP_NETINC_NON_EXT2 - GRP_NETINC_NON_EXT3 - GRP_NETINC_NON_EXT4 - GRP_NETINC_NON_EXT5 - example: "0.00" - GRP_PL_AFT_TAX_EXT1: - type: string - description: |+ - Group Profit / Loss After Tax and Extraordinary items - Subsequent Years: - GRP_ PL_AFT_TAX_EXT2 - GRP_ PL_AFT_TAX_EXT3 - GRP_ PL_AFT_TAX_EXT4 - GRP_ PL_AFT_TAX_EXT5 - example: "0.00" - GRP_TOT_ASSETS1: - type: string - description: |+ - Group Total Assets - Subsequent Years: - GRP_TOT_ASSETS2 - GRP_TOT_ASSETS3 - GRP_TOT_ASSETS4 - GRP_TOT_ASSETS5 - example: "0.00" - GRP_TA_CURRENT1 : - type: string - description: |+ - Group Total Assets – Current - Subsequent Years: - GRP_TA_CURRENT2 - GRP_TA_CURRENT3 - GRP_TA_CURRENT4 - GRP_TA_CURRENT5 - example: "0.00" - GRP_TA_FIXED1 : - type: string - description: |+ - Group Total Assets – Fixed and Others - Subsequent Years: - GRP_TA_FIXED2 - GRP_TA_FIXED3 - GRP_TA_FIXED4 - GRP_TA_FIXED5 - example: "0.00" - GRP_TOT_LIABILITIES1 : - type: string - description: |+ - Group Total Liabilities - Subsequent Years: - GRP_TOT_LIABILITIES2 - GRP_TOT_LIABILITIES3 - GRP_TOT_LIABILITIES4 - GRP_TOT_LIABILITIES5 - example: "0.00" - GRP_TL_CURRENT1 : - type: string - description: |+ - Group Total Liabilities - Current - Subsequent Years: - GRP_TL_CURRENT2 - GRP_TL_CURRENT3 - GRP_TL_CURRENT4 - GRP_TL_CURRENT5 - example: "0.00" - GRP_TL_NON_CURRENT1 : - type: string - description: |+ - Group Total Liabilities – Non-Current & Long Term - Subsequent Years: - GRP_TL_NON_CURRENT2 - GRP_TL_NON_CURRENT3 - GRP_TL_NON_CURRENT4 - GRP_TL_NON_CURRENT5 - example: "0.00" - GRP_SH_FUNDS1 : - type: string - description: |+ - Group Shareholder’s Fund - Subsequent Years: - GRP_ SH_FUNDS2 - GRP_ SH_FUNDS3 - GRP_ SH_FUNDS4 - GRP_ SH_FUNDS5 - example: "0.00" - GRP_SH_PAIDUP_CAPITAL1 : - type: string - description: |+ - Group Shareholder’s Fund – Paid Up Capital - Subsequent Years: - GRP_SH_PAIDUP_CAPITAL2 - GRP_SH_PAIDUP_CAPITAL3 - GRP_SH_PAIDUP_CAPITAL4 - GRP_SH_PAIDUP_CAPITAL5 - example: "0.00" - GRP_SH_RESERVES1: - type: string - description: |+ - Group Shareholder’s Fund - Reserves - Subsequent Years: - GRP_SH_RESERVES2 - GRP_SH_RESERVES3 - GRP_SH_RESERVES4 - GRP_SH_RESERVES5 - example: "0.00" - GRP_SH_ACCUM_LOSS1 : - type: string - description: |+ - Group Shareholder’s Fund – Accumulated Loss - Subsequent Years: - GRP_SH_ACCUM_LOSS2 - GRP_SH_ACCUM_LOSS3 - GRP_SH_ACCUM_LOSS4 - GRP_SH_ACCUM_LOSS5 - example: "0.00" - GRP_INDICATOR1 : - type: string - description: |+ - Company Financial Highlights Group Indicator - Subsequent Years: - GRP_INDICATOR2 - GRP_INDICATOR3 - GRP_INDICATOR4 - GRP_INDICATOR5 - example: "B" - XBRL_DTL: - type: object - description: |+ - XBRL filed after 1 Nov 2007 with following children: - XBRL_YR1_CURR - REVENUE1 - PL_BEF_TAX1 - PL_AFT_TAX1 - TOT_ASSETS1 - TA_CURRENT1 - TA_NON_CURRENT1 - TOT_LIABILITIES1 - TL_CURRENT1 - TL_NON_CURRENT1 - TOT_EQUITY1 - EQ_SH_CAPITAL1 - EQ_RESERVES1 - EQ_RETAINED_EARN1 - GRP_REVENUE1 - GRP_PL_BEF_TAX1 - GRP_PL_AFT_TAX1 - GRP_TOT_ASSETS1 - GRP_TA_CURRENT1 - GRP_TA_NON_CURRENT1 - GRP_TOT_LIABILITIES1 - GRP_TL_CURRENT1 - GRP_TL_NON_CURRENT1 - GRP_TOT_EQUITY1 - GRP_SH_CAPITAL1 - GRP_RESERVES1 - GRP_RETAINED_EARN1 - GRP_INDICATOR1 - - Note: Each tag will consist of maximum 5 sets with suffix 1 to 5. But it is optional, depending on how many years of XBRL data displayed in the report. - example: |+ - - - - 10877254.00 - 9982533.00 - 1121483.00 - 262632.00 - 1347380.00 - 262632.00 - 6562990.00 - 5424551.00 - 6283449.00 - 4948821.00 - 279541.00 - 475730.00 - 8434195.00 - 8643136.00 - 8434195.00 - 7933013.00 - 0.00 - 710123.00 - -1871205.00 - -3218585.00 - 2000000.00 - 2000000.00 - 0.00 - 0.00 - -3,871,205.00 - -5,218,585.00 - 0.00 - 0.00 - 0.00 - 0.00 - 0.00 - 0.00 - 0.00 - 0.00 - 0.00 - 0.00 - 0.00 - 0.00 - 0.00 - 0.00 - 0.00 - 0.00 - 0.00 - 0.00 - 0.00 - 0.00 - 0.00 - 0.00 - 0.00 - 0.00 - 0.00 - 0.00 - - - - - properties: - XBRL_YR1_CURR: - type: string - description: |+ - FH After Year 1 Currency - Subsequent Years: - XBRL_YR2_CURR - XBRL_YR3_CURR - XBRL_YR4_CURR - XBRL_YR5_CURR - example: "(SGD)" - REVENUE1 : - type: string - description: |+ - Revenue Amount - Subsequent Years: - REVENUE2 - REVENUE3 - REVENUE4 - REVENUE5 - example: "10877254.00" - PL_BEF_TAX1 : - type: string - description: |+ - Profit / Loss Before Tax from Continuing Operations - Subsequent Years: - PL_BEF_TAX2 - PL_BEF_TAX3 - PL_BEF_TAX4 - PL_BEF_TAX5 - example: "1121483.00" - PL_AFT_TAX1 : - type: string - description: |+ - Profit / Loss After Tax from Continuing Operations - Subsequent Years: - PL_AFT_TAX2 - PL_AFT_TAX3 - PL_AFT_TAX4 - PL_AFT_TAX5 - example: "1347380.00" - TOT_ASSETS1 : - type: string - description: |+ - Total Assets - Subsequent Years: - TOT_ASSETS2 - TOT_ASSETS3 - TOT_ASSETS4 - TOT_ASSETS5 - example: "6562990.00" - TA_CURRENT1 : - type: string - description: |+ - Total Current Assets (Only for Balance Sheet by Current / Non-Current) - Subsequent Years: - TA_CURRENT2 - TA_CURRENT3 - TA_CURRENT4 - TA_CURRENT5 - example: "6283449.00" - TA_NON_CURRENT1 : - type: string - description: |+ - Total Non-Current Assets (Only for Balance Sheet by Current / Non-Current) - Subsequent Years: - TA_NON_CURRENT2 - TA_NON_CURRENT3 - TA_NON_CURRENT4 - TA_NON_CURRENT5 - example: "279541.00" - TOT_LIABILITIES1 : - type: string - description: |+ - Total Liabilities - Subsequent Years: - TOT_LIABILITIES2 - TOT_LIABILITIES3 - TOT_LIABILITIES4 - TOT_LIABILITIES5 - example: "8434195.00" - TL_CURRENT1 : - type: string - description: |+ - Total Current Liabilities (Only for Balance Sheet by Current / Non-Current) - Subsequent Years: - TL_CURRENT2 - TL_CURRENT3 - TL_CURRENT4 - TL_CURRENT5 - example: "8434195.00" - TL_NON_CURRENT1 : - type: string - description: |+ - Total Non-Current Liabilities (Only for Balance Sheet by Current / Non- Current) - Subsequent Years: - TL_NON_CURRENT2 - TL_NON_CURRENT3 - TL_NON_CURRENT4 - TL_NON_CURRENT5 - example: "0.00" - TOT_EQUITY1 : - type: string - description: |+ - Total Equity (inclusive of Equity Attributable to Equity Holders of Parent and Minority Interest) - Subsequent Years: - TOT_EQUITY2 - TOT_EQUITY3 - TOT_EQUITY4 - TOT_EQUITY5 - example: "-1871205.00" - EQ_SH_CAPITAL1 : - type: string - description: |+ - Total Equity – Share Capital - Subsequent Years: - EQ_SH_CAPITAL2 - EQ_SH_CAPITAL3 - EQ_SH_CAPITAL4 - EQ_SH_CAPITAL5 - example: "2000000.00" - EQ_RESERVES1 : - type: string - description: |+ - Total Equity – Other Reserves - Subsequent Years: - EQ_RESERVES2 - EQ_RESERVES3 - EQ_RESERVES4 - EQ_RESERVES5 - example: "0.00" - EQ_RETAINED_EARN1 : - type: string - description: |+ - Total Equity – Retained Earnings (Accumulated Loss) - Subsequent Years: - EQ_RETAINED_EARN2 - EQ_RETAINED_EARN3 - EQ_RETAINED_EARN4 - EQ_RETAINED_EARN5 - example: "-3,871,205.00" - GRP_REVENUE1 : - type: string - description: |+ - Group’s Revenue Amount - Subsequent Years: - GRP_REVENUE2 - GRP_REVENUE3 - GRP_REVENUE4 - GRP_REVENUE5 - example: "0.00" - GRP_PL_BEF_TAX1 : - type: string - description: |+ - Group Profit / Loss Before Tax from Continuing Operations - Subsequent Years: - GRP_PL_BEF_TAX2 - GRP_PL_BEF_TAX3 - GRP_PL_BEF_TAX4 - GRP_PL_BEF_TAX5 - example: "0.00" - GRP_PL_AFT_TAX1 : - type: string - description: |+ - Group Profit / Loss After Tax from Continuing Operations - Subsequent Years: - GRP_PL_AFT_TAX2 - GRP_PL_AFT_TAX3 - GRP_PL_AFT_TAX4 - GRP_PL_AFT_TAX5 - example: "0.00" - GRP_TOT_ASSETS1 : - type: string - description: |+ - Group’s Total Assets - Subsequent Years: - GRP_TOT_ASSETS2 - GRP_TOT_ASSETS3 - GRP_TOT_ASSETS4 - GRP_TOT_ASSETS5 - example: "0.00" - GRP_TA_CURRENT1 : - type: string - description: |+ - Group’s Total Current Assets (Only for Balance Sheet by Current / Non- Current) - Subsequent Years: - GRP_TA_CURRENT2 - GRP_TA_CURRENT3 - GRP_TA_CURRENT4 - GRP_TA_CURRENT4 - example: "0.00" - GRP_TA_NON_CURRENT1 : - type: string - description: |+ - Group’s Total Non-Current Assets (Only for Balance Sheet by Current / Non- Current) - Subsequent Years: - GRP_TA_NON_CURRENT2 - GRP_TA_NON_CURRENT3 - GRP_TA_NON_CURRENT4 - GRP_TA_NON_CURRENT4 - example: "0.00" - GRP_TOT_LIABILITIES1 : - type: string - description: |+ - Group’s Total Liabilities - Subsequent Years: - GRP_TOT_LIABILITIES2 - GRP_TOT_LIABILITIES3 - GRP_TOT_LIABILITIES4 - GRP_TOT_LIABILITIES5 - example: "0.00" - GRP_TL_CURRENT1 : - type: string - description: |+ - Group’s Total Current Liabilities (Only for Balance Sheet by Current / Non- Current) - Subsequent Years: - GRP_TL_CURRENT2 - GRP_TL_CURRENT3 - GRP_TL_CURRENT4 - GRP_TL_CURRENT5 - example: "0.00" - GRP_TL_NON_CURRENT1 : - type: string - description: |+ - Group’s Total Non-Current Liabilities (Only for Balance Sheet by Current / Non- Current) - Subsequent Years: - GRP_TL_NON_CURRENT2 - GRP_TL_NON_CURRENT3 - GRP_TL_NON_CURRENT4 - GRP_TL_NON_CURRENT5 - example: "0.00" - GRP_TOT_EQUITY1 : - type: string - description: |+ - Group’s Total Equity (inclusive of Equity Attributable to Equity Holders of Parent and Minority Interest) - Subsequent Years: - GRP_TOT_EQUITY2 - GRP_TOT_EQUITY3 - GRP_TOT_EQUITY4 - GRP_TOT_EQUITY5 - example: "0.00" - GRP_SH_CAPITAL1 : - type: string - description: |+ - Group’s Share Capital - Subsequent Years: - GRP_SH_CAPITAL2 - GRP_SH_CAPITAL3 - GRP_SH_CAPITAL4 - GRP_SH_CAPITAL5 - example: "0.00" - GRP_RESERVES1 : - type: string - description: |+ - Group’s Other Reserves - Subsequent Years: - GRP_RESERVES2 - GRP_RESERVES3 - GRP_RESERVES4 - GRP_RESERVES5 - example: "0.00" - GRP_RETAINED_EARN1 : - type: string - description: |+ - Group’s – Retained Earnings (Accumulated Loss) - Subsequent Years: - GRP_RETAINED_EARN2 - GRP_RETAINED_EARN3 - GRP_RETAINED_EARN4 - GRP_RETAINED_EARN5 - example: "0.00" - GRP_INDICATOR1 : - type: string - description: |+ - XBRL Financial Highlights Group Indicator - Subsequent Years: - GRP_INDICATOR2 - GRP_INDICATOR3 - GRP_INDICATOR4 - GRP_INDICATOR5 - example: "B" - FH_RATIOS_DTL: - type: object - description: |+ - Accounting Ratios Details with following children: - RATE_NET_PROFIT1 - RET_INVESTMENT1 - RET_SH_FUNDS1 - TOT_ASSETS_TURNOVER1 - CURR_CAPITAL_RATIO1 - PROPRIETARY_RATIO1 - TOTAL_DEBT_RATIO1 - - Note: Each tag will consist of maximum 5 sets with suffix 1 to 5. But it is optional, depending on how many years of FH & XBRL data displayed in the report. - example: |+ - - 12.39 - 2.63 - 0.00 - 0.00 - 0.00 - 20.53 - 4.84 - 0.00 - 0.00 - 0.00 - -72.01 - -8.16 - -0.00 - -0.00 - -0.00 - 1.66 - 1.84 - 2.42 - 2.54 - 1.78 - 0.74 - 0.62 - 0.50 - 0.46 - 0.55 - -28.51 - -59.33 - -89.51 - -101.59 - -75.15 - 128.51 - 168.27 - 189.51 - 201.59 - 175.15 - - properties: - RATE_NET_PROFIT1 : - type: string - description: |+ - Rate of Net Profit On Sales (%) - Subsequent Years: - RATE_NET_PROFIT2 - RATE_NET_PROFIT3 - RATE_NET_PROFIT4 - RATE_NET_PROFIT5 - example: "12.39" - RET_INVESTMENT1 : - type: string - description: |+ - Return of Investment (%) - Subsequent Years: - RET_INVESTMENT2 - RET_INVESTMENT3 - RET_INVESTMENT4 - RET_INVESTMENT5 - example: "20.53" - RET_SH_FUNDS1 : - type: string - description: |+ - Return of Shareholder’s Funds (%) - Subsequent Years: - RET_SH_FUNDS2 - RET_SH_FUNDS3 - RET_SH_FUNDS4 - RET_SH_FUNDS4 - example: "-72.01" - TOT_ASSETS_TURNOVER1 : - type: string - description: |+ - Total Assets Turnover (%) - Subsequent Years: - TOT_ASSETS_TURNOVER2 - TOT_ASSETS_TURNOVER3 - TOT_ASSETS_TURNOVER4 - TOT_ASSETS_TURNOVER5 - example: "1.66" - CURR_CAPITAL_RATIO1: - type: string - description: |+ - Current / Working Capital Ratio (%) - Subsequent Years: - CURR_CAPITAL_RATIO2 - CURR_CAPITAL_RATIO3 - CURR_CAPITAL_RATIO4 - CURR_CAPITAL_RATIO5 - example: "0.74" - PROPRIETARY_RATIO1: - type: string - description: |+ - Proprietary Ratio (%) 1 - Subsequent Years: - PROPRIETARY_RATIO2 - PROPRIETARY_RATIO3 - PROPRIETARY_RATIO4 - PROPRIETARY_RATIO5 - example: "-28.51" - TOTAL_DEBT_RATIO1 : - type: string - description: |+ - Total Debt to Equity Ratio (%) 1 - Subsequent Years: - TOTAL_DEBT_RATIO2 - TOTAL_DEBT_RATIO3 - TOTAL_DEBT_RATIO4 - TOTAL_DEBT_RATIO5 - example: "128.51" - LIST_FH_CHART_INFO : - type: array - example: |+ - - - 1121483.0 - 10877254 - 2008 - - - description: |+ - List of chart info with following children: - [FH_CHART_INFO] - items: - properties: - FH_CHART_INFO: - type: object - description: |+ - Chart Info info with following children: - YEAR - REVENUE - PROFIT_LOSS - properties: - PROFIT_LOSS: - type: string - example: "1121483.0" - description: Profit / Loss Before Tax of the year - REVENUE: - type: string - example: "10877254" - description: Revenue Amount of the year - YEAR: - type: string - example: "2008" - description: Financial Year - unauthorized: - type: object - properties: - message: - type: string - example: Missing Authentication Token - status: - type: string - example: Failure - forbidden: - type: object - properties: - message: - type: string - example: Access Denied Unauthorized User - status: - type: string - example: Failure - paymentrequired: - type: object - properties: - message: - type: string - example: Insufficient Credits Kindly Top Up - status: - type: string - example: Failure - notfound: - type: object - properties: - message: - type: string - example: Invalid Request URL - status: - type: string - example: Failure - servererror: - type: object - properties: - message: - type: string - example: Internal Server Error - status: - type: string - example: Failure - gatewaytimeout: - type: object - properties: - message: - type: string - example: Request Timeout - status: - type: string - example: Failure - inputfieldmissing: - type: object - properties: - message: - type: string - example: Input Field Missing - status: - type: string - example: Failure - inputlimitexceeded: - type: object - properties: - message: - type: string - example: Input Limit Exceeded - status: - type: string - example: Failure - invalidinput: - type: object - properties: - message: - type: string - example: Invalid Input - status: - type: string - example: Failure - REQUEST: - type: object - properties: - TOT_ITEMS: - type: number - example: 1 - description: Number of subjects being enquired relating to the Run - default: false - ENQUIRY: - type: object - example: |+ - "197601887ETRANSTAR TRAVEL PTE LTD" - description: Contains information of each request details - default: true - properties: - SUBJECT_IDNO: - type: string - example: 199707714C - description: "Subject’s ID Number (individual) or Registration Number (company/business) as captured in DDP" - default: true - SUBJECT_NAME: - type: string - example: GPS INDUSTRIES PTE LTD - description: Subjects Name as captured in DDP - default: false - versions: - type: object - properties: - v0.1.0: - type: array - items: - oneOf: - - type: string - example: Published Date - Aug 15, 2019 - description: Initial version release - securitySchemes: - APIAuthorizer: - type: apiKey - name: x-api-key - in: header - x-amazon-apigateway-authtype: custom - description: Authentication is done using the x-api-key in the request header diff --git a/yaml/d&b_business_check_plus_sg.yaml b/yaml/d&b_business_check_plus_sg.yaml deleted file mode 100644 index a96609776..000000000 --- a/yaml/d&b_business_check_plus_sg.yaml +++ /dev/null @@ -1,1705 +0,0 @@ -openapi: 3.0.1 -info: - title: D&B Business Check Plus (SG) - description: The Data microservice provides key business information, litigation information (High and Subordinate Courts) and Winding Up Trace of a company including the Business name, registration number, registered address and date of change, company status, registered activities, shareholders details (i.e. date of commencement, residing address) capital amount and shares allocated to each shareholder, litigation information. Updated daily. - x-additionalinfo: |+ - Suggested Use Cases: - - Software solutions targeted at corporate finance and legal domains, e.g. in cases of mergers, joint ventures or partnerships. - - - Aside from being able to protect your business via litigation checks to safeguard against reputational risk by avoiding companies potentially involved in financial crimes, the information from this microservice can serve as a quick solution for analysts or lawyers in a company whom are looking to draft documents related to cooperate finance or legal domains with one quick search. - version: '0.1.0' - x-subscribelink: d&b_business_check_plus_sg -servers: - - url: 'https://api.sentient.io' -tags: -- name: "v0.1.0" - description: "Published Date - Aug 15, 2019" -paths: - /dnb/prod/sbcp: - post: - tags: - - v0.1.0 - summary: Adds a new user - requestBody: - content: - application/xml: - schema: - $ref: '#/components/schemas/REQUEST' - responses: - '200': - description: success response - content: - application/xml: - schema: - $ref: '#/components/schemas/success' - example: |+ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - 300 - - - - - - - - - - - - - - - - - - - - - - - ABUTHAHIR ABDUL GAFOOR S1676216D - Liquidator - EL TICI FINANCIAL ADVISORY SERVICES PTE. LTD. 1 RAFFLES PLACE #20-01 - OUB CENTRE SINGAPORE 048616 30/03/2009 - - ANGELA ANG - S1633336D - Liquidator - KING FINANCIAL ADVISORY SERVICES LEVEL 17 MLC CENTRE 19029 MARTIN PLACE SYDNEY NSW 2000 AUSTRALIA 18/02/2009 - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - -
- - - - - - - - - - - - - - - - - - - - - -
- - - - - - -
- - - - - - - - - 30000.00 - - 28000.00 - - 27,000.00 - - - '401': - description: Unauthorized - content: - application/json: - schema: - $ref: '#/components/schemas/unauthorized' - '402': - description: Payment Required - content: - application/json: - schema: - $ref: '#/components/schemas/paymentrequired' - '403': - description: Forbidden - content: - application/json: - schema: - $ref: '#/components/schemas/forbidden' - '404': - description: Not Found - content: - application/json: - schema: - $ref: '#/components/schemas/notfound' - '419': - description: Input Field Missing - content: - application/json: - schema: - $ref: '#/components/schemas/inputfieldmissing' - '413': - description: Input Limit Exceeded - content: - application/json: - schema: - $ref: '#/components/schemas/inputlimitexceeded' - '415': - description: Invalid Input - content: - application/json: - schema: - $ref: '#/components/schemas/invalidinput' - '500': - description: Internal Server Error - content: - application/json: - schema: - $ref: '#/components/schemas/servererror' - '504': - description: Gateway Timeout - content: - application/json: - schema: - $ref: '#/components/schemas/gatewaytimeout' - security: - - APIAuthorizer: [] -components: - schemas: - success: - type: object - properties: - REPORT: - type: object - example: - description: |+ - Report details with following children: - [META_INFO] - [REGISTRY_DETAIL] - [REQ_SEARCH_INFO] - [EMPLOYEE_SIZE] - [LIST_BIZ_BRANCH] - [LIST_REG_CHARGES] - [LIST_LIQUIDATOR] - [LIST_WINDING_UP] - [LIST_LITIGATION] - [LIST_SHARE_INTEREST_COMP] - [LIST_NAME_CHANGE] - [LIST_SHAREHOLDER] - [LIST_CAPITAL] - [LIST_OFFICER_OWNER] - [LIST_SALES_REVENUE_AMOUNT] - properties: - META_INFO: - type: object - example: |+ - - - - - - - description: |+ - Meta Information details with following children: - SERVICE - SYSTEM_ID - CREATION_DATE - USER_ID - CLASS - properties: - SERVICE: - type: string - description: Report requested - example: "BCP" - SYSTEM_ID : - type: string - description: System ID - example: "DDP" - CREATION_DATE: - type: datetime - description: Report request date - example: Wed Apr 08 11:37:51 MYT 2009 - USER_ID : - type: string - description: Valid user id in DDP system. It is for (For internal use) - example: N/A - CLASS: - type: string - description: Class location for metabean. It is for (For internal use) - example: N/A - REGISTRY_DETAIL : - type: object - example: |+ - - - - - - - - - - - - - - - - - - - - - - description: |+ - Registry Details with following children: - RENEWAL_DATE - ADDRESS1 - ADDRESS2 - ADDRESS3 - ADDRESS4 - COMP_TYPE_CODE - REG_DATE - REG_ACTIVITY1 - REG_ACTIVITY2 - ACC_DATE - STATUS_EFFECT_DATE - NAME_EFFECT_DATE - EXPIRY_DATE - COMP_TYPE - CHANGE_ADDR_DATE - COMP_STATUS - REG_ACTIVITY_DESC1 - REG_ACTIVITY_DESC2 - AUDITOR - AUDITOR_APPMT_DATE - LAST_AR_DATE - LAST_AGM_DATE - COUNTRY_INCORP - properties: - RENEWAL_DATE: - type: string - description: Renewal Date - example: "23/12/2008" - ADDRESS1: - type: string - description: Address Line 1 - example: "1 HARBOURFRONT AVENUE , 18 - 01" - ADDRESS2: - type: string - description: Address Line 2 - example: "KEPPEL BAY TOWER" - ADDRESS3: - type: string - description: Address Line 3 - example: "098632" - ADDRESS4: - type: string - description: Address Line 4 - example: "SINGAPORE" - COMP_TYPE_CODE: - type: string - example: CP - description: |+ - Report Code. Available values are: - 1. CP Corporate - 2. SP Sole Proprietor - REG_DATE: - type: string - description: Registration Date - example: "14/10/1974" - REG_ACTIVITY1: - type: string - description: Registered Activities 1 - example: "OTHER INVESTMENT HOLDING COMPANIES" - REG_ACTIVITY2: - type: string - description: Registered Activities 2 - example: "SHIP MANAGEMENT SERVICES" - ACC_DATE: - type: string - description: Account Date - example: "31/12/2007" - STATUS_EFFECT_DATE: - type: string - description: Status Effective Date - example: "14/10/1974" - NAME_EFFECT_DATE: - type: string - description: Name Effective Date - example: "14/10/1974" - EXPIRY_DATE: - type: string - description: Expiry Date - example: "25/10/2009" - COMP_TYPE: - type: string - description: Company Type - example: "LIMITED PRIVATE COMPANY" - CHANGE_ADDR_DATE: - type: string - description: Change Address Date - example: "09/05/2003" - COMP_STATUS: - type: string - description: Company Status - example: "Live Company" - REG_ACTIVITY_DESC1: - type: string - description: Registered Activities Description - example: - REG_ACTIVITY_DESC2: - type: string - description: Registered Activities Description - example: - AUDITOR: - type: string - description: Auditor Name - example: - AUDITOR_APPMT_DATE: - type: string - description: Auditor Appointment Date - example: "13/06/1990" - LAST_AR_DATE: - type: string - description: Date of Last AR - example: "30/06/2008" - LAST_AGM_DATE: - type: string - description: Date of Last AGM - example: "11/06/2008" - COUNTRY_INCORP: - type: string - description: Country Incorporated - example: "SINGAPORE" - REQ_SEARCH_INFO : - type: object - example: |+ - - - - - - - description: |+ - Request criteria & search record with following children: - COMP_NAME - REG_NO - REQ_DATE - REQ_REG_NO - REQ_NAME - REQ_DATE_STR - properties: - COMP_NAME: - type: string - description: Company Name - example: "KAPAL MANAGEMENT (PRIVATE) LIMITED" - REG_NO: - type: string - description: Subject’s ID Number (individual) or Registration Number (company/business) - example: "197401835M" - REQ_DATE: - type: datetime - description: Report Requested Date - example: 2009-04-08 11:36:03.611 - REQ_REG_NO: - type: string - description: Request Registration Number - example: "197401835M" - REQ_NAME: - type: string - description: Request Name - example: "KAPAL MANAGEMENT (PRIVATE) LIMITED" - REQ_DATE_STR: - type: string - description: Request Date String - example: "08/04/2009 11:36:03" - EMPLOYEE_SIZE : - type: object - description: |+ - Employee Size details with following children: - ELEMENTS - AMOUNT - example: |+ - - - 300 - - properties: - ELEMENTS: - type: string - description: Description - example: "Employee Size" - AMOUNT: - type: integer - description: Number of employee - example: 300 - LIST_BIZ_BRANCH : - type: array - description: |+ - List of Business Branches with following children: - [BIZ_BRANCH] - example: |+ - - - - - - - items: - properties: - BIZ_BRANCH : - type: object - description: |+ - Business Branches with following children: - ADDR_BUILDING - ADDR_POSTCODE - ADDR_ADDRESS1 - example: |+ - - - - - - properties: - ADDR_BUILDING: - type: string - description: Building Name - example: - ADDR_POSTCODE: - type: string - description: Postcode - example: 289848 - ADDR_ADDRESS1: - type: string - description: Address - example: 251A ARCADIA ROAD - LIST_REG_CHARGES: - type: array - description: |+ - List of Registered Charges with following children: - [REG_CHARGES] - example: |+ - - - - - - - - - - items: - properties: - REG_CHARGES : - type: object - description: |+ - Registered Charges details with following children: - CHARGE_NO - CHARGE_DATE - CHARGEE_COMP - CURRENCY - AMT_SECURED - STATUS_SATISFACTION - example: |+ - - - - - - - - - properties: - CHARGE_NO : - type: string - description: Charge No. - example: 8205117 - CHARGE_DATE: - type: string - description: Charge Date - example: 26/11/1982 - CHARGEE_COMP: - type: string - description: Charges Company - example: UNITED OVERSEAS BANK LIMITED - CURRENCY: - type: string - description: Currency - example: - AMT_SECURED: - type: string - description: Amount Secured - example: 1000.00 - STATUS_SATISFACTION: - type: string - description: Status of Satisfaction - example: - LIST_LIQUIDATOR: - type: array - description: |+ - List of Liquidator / Receiver / Judicial Manager with following children: - [LIQUIDATOR] - example: |+ - - - ABUTHAHIR ABDUL GAFOOR S1676216D - Liquidator - EL TICI FINANCIAL ADVISORY SERVICES PTE. LTD. 1 RAFFLES PLACE #20-01 - OUB CENTRE SINGAPORE 048616 30/03/2009 - - - items: - properties: - LIQUIDATOR : - type: object - description: |+ - Liquidator details with following children: - LIQ_POSITION - LIQ_ID - LIQ_NAME - LIQ_COMP - LIQ_ADDRESS1 - LIQ_ADDRESS2 - LIQ_ADDRESS3 - LIQ_ADDRESS4 - LIQ_APPOINTMENT_DATE - example: |+ - - ABUTHAHIR ABDUL GAFOOR - S1676216D - Liquidator - EL TICI FINANCIAL ADVISORY SERVICES PTE. LTD. - 1 RAFFLES PLACE - #20-01 - OUB CENTRE - SINGAPORE 048616 - 30/03/2009 - - properties: - LIQ_POSITION: - type: string - description: Liquidator / Receiver / Judicial Manager Position - example: Liquidator - LIQ_ID: - type: string - description: Liquidator / Receiver / Judicial Manager ID - example: S1676216D - LIQ_NAME : - type: string - description: Liquidator / Receiver / Judicial Manager Name - example: ABUTHAHIR ABDUL GAFOOR - LIQ_COMP: - type: string - description: Liquidator / Receiver / Judicial Manager Company Name - example: EL TICI FINANCIAL ADVISORY SERVICES PTE. LTD. - LIQ_ADDRESS1: - type: string - description: Liquidator / Receiver / Judicial Manager Address 1 - example: 1 RAFFLES PLACE - LIQ_ADDRESS2: - type: string - description: Liquidator / Receiver / Judicial Manager Address 2 - example: #20-01 - LIQ_ADDRESS3: - type: string - description: Liquidator / Receiver / Judicial Manager Address 3 - example: OUB CENTRE - LIQ_ADDRESS4: - type: string - description: Liquidator / Receiver / Judicial Manager Address 4 - example: SINGAPORE 048616 - LIQ_APPOINTMENT_DATE: - type: string - description: Liquidator / Receiver / Judicial Manager Appointment Date - example: 30/03/2009 - LIST_WINDING_UP : - type: array - description: |+ - List of Winding Up with following children: - [WINDING_UP] - example: |+ - - - - - - - - - - - - - - - - - - - - - items: - properties: - WINDING_UP : - type: object - description: |+ - Winding Up details with following children: - CASE_CODE - CASE_YEAR - PLAINTIFF - PLA_SOLICITOR_ID - PLA_FILE_REF - PLA_LAW_FIRM - SUBJECT_NAME - COURT_CODE - CASE_TYPE - CURRENCY1 - AMOUNT1 - CURRENCY2 - AMOUNT2 - CURRENCY3 - AMOUNT3 - ACTION_DATE - BANKRUPTCY_ACT - HEARING_DATE - PLA_SOLICITOR - example: |+ - - - - - - - - - - - - - - - - - - - - properties: - CASE_CODE : - type: string - description: Case Code - example: 40000 - CASE_YEAR : - type: string - description: Case Year - example: 1999 - PLAINTIFF : - type: string - description: Plaintiff Name - example: - PLA_SOLICITOR_ID : - type: string - description: Pla. Solicitor ID - example: - PLA_FILE_REF : - type: string - description: Pla. File Ref. - example: - PLA_LAW_FIRM : - type: string - description: Pla. Law Firm - example: NAME2 - SUBJECT_NAME : - type: string - description: Subject Name - example: PROACTIVE BUILDERS - COURT_CODE : - type: string - description: Court Code - example: CWU - CASE_TYPE : - type: string - description: Case Type - example: COMPANY WINDING UP PETITION - CURRENCY1 : - type: string - description: Currency 1 - example: SGD - AMOUNT1 : - type: string - description: Amount 1 - example: 41,424.52 - CURRENCY2 : - type: string - description: Currency 2 - example: MYR - AMOUNT2 : - type: string - description: Amount 2 - example: 0.00 - CURRENCY3 : - type: string - description: Currency 3 - example: - AMOUNT3 : - type: string - description: Amount 3 - example: 0.00 - ACTION_DATE : - type: string - description: Action Date - example: 11/05/2007 - BANKRUPTCY_ACT : - type: string - description: Act of Bankruptcy - example: Petition for Winding Up - HEARING_DATE : - type: string - description: Hearing Date - example: 15/12/2007 - PLA_SOLICITOR : - type: string - description: Pla. Solicitor - example: - LIST_LITIGATION : - type: array - description: |+ - List of Winding Up with following children: - [LITIGATION] - example: |+ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - items: - properties: - LITIGATION : - type: object - description: |+ - List of Winding Up with following children: - SUBJECT_NAME - NATURE_OF_CLAIM - STATUS_DATE - CASE_NO - DOC_REMARK - CURRENCY1 - CURRENCY2 - CURRENCY3 - CURRENCY4 - CURRENCY5 - DEF_SOLICITOR - DEF_SOLICITOR_ID - DEF_LAW_FIRM - DEF_FILE_REF - DATE_OF_WRIT - STATUS - AMOUNT1 - AMOUNT2 - AMOUNT3 - AMOUNT4 - AMOUNT5 - PLAINTIFF - PLA_SOLICITOR - PLA_SOLICITOR_ID - PLA_LAW_FIRM - PLA_FILE_REF - PLA_ID - PLA_STATUS - PLA_STATUS_DATE - example: |+ - - - - - - - - - - - - - - - - - - - - - - - - - - - - properties: - SUBJECT_NAME : - type: string - description: Subject Name - example: "SOON SOON SEAFOOD" - NATURE_OF_CLAIM : - type: string - example: "CONTRACT 3" - description: Nature of Claim - STATUS_DATE : - type: string - example: "01/05/2008" - description: Status Date - CASE_NO : - type: string - example: "MC 40001 / 1999" - description: Case No - DOC_REMARKS : - type: string - example: "NOTICE OF DISCONTINUANCE/WITHDRAWAL 3" - description: Document Remark - CURRENCY1 : - type: string - example: "SGD" - description: Currency 1 - CURRENCY2 : - type: string - example: "MYR" - description: Currency 2 - CURRENCY3 : - type: string - example: "USD" - description: Currency 3 - CURRENCY4 : - type: string - example: "-" - description: Currency 4 - CURRENCY5 : - type: string - example: "-" - description: Currency 5 - DEF_SOLICITOR : - type: string - example: "SOL2" - description: Def. Solicitor - DEF_SOLICITOR_ID : - type: string - example: "20000000" - description: Def. Solicitor ID - DEF_LAW_FIRM : - type: string - example: "NAME2" - description: Def. Law Firm - DEF_FILE_REF : - type: string - example: "FILE2" - description: Def. File Ref. - DATE_OF_WRIT : - type: string - example: "01/01/2008" - description: Date Writ - STATUS : - type: string - example: "CONCLUDED 3" - description: Status - AMOUNT1 : - type: string - example: "100.00" - description: Amount 1 - AMOUNT2 : - type: string - example: "200.00" - description: Amount 2 - AMOUNT3 : - type: string - example: "0.00" - description: Amount 3 - AMOUNT4 : - type: string - example: "400.00" - description: Amount 4 - AMOUNT5 : - type: string - example: "0.00" - description: Amount 5 - PLAINTIFF : - type: string - example: "MC 40001" - description: Plaintiff Name - PLA_SOLICITOR: - type: string - example: "SOL2" - description: plantiff Solicitor - PLA_SOLICITOR_ID: - type: string - example: "20000000" - description: plantiff Solicitor ID - PLA_LAW_FIRM : - type: string - example: "NAME2" - description: Pla. Law Firm - PLA_FILE_REF : - type: string - example: "FILE2" - description: Pla. File Ref. - PLA_ID: - type: string - example: "S0739038F" - description: Plaintiff ID - PLA_STATUS: - type: string - example: "SETTLED - BEFORE SET DOWN" - description: Plaintiff Status - PLA_STATUS_DATE : - type: string - example: "17/10/2016" - description: Plaintiff Status Date - LIST_SHARE_INTEREST_COMP : - type: array - description: |+ - List of Share Interest In Companies with following children: - [SHARE_INTEREST_COMP] - example: |+ - - - - - - - - - items: - properties: - SHARE_INTEREST_COMP : - type: object - description: |+ - Share Interest In Companies details with following children: - COMP_NAME - SHARE_OWNED_UNIT - SHARE_OWNED_PERCENT - STATUS - example: |+ - - - - - - - properties: - COMP_NAME : - type: string - description: Company Name - example: ORCHID (HOLDINGS) PTE. LTD. - SHARE_OWNED_UNIT : - type: string - description: Shares Owned Unit - example: 500000 - SHARE_OWNED_PERCENT : - type: string - description: Shares Owned Value (%) - example: 100.00 - STATUS : - type: string - description: Status - example: DISSOLVED - MEMBERS' VOLUNTARY WINDING UP - LIST_NAME_CHANGE : - type: array - description: |+ - List of Change of Company/Business Name(s) with following children: - [NAME_CHANGE] - example: |+ - - - - - - - items: - properties: - NAME_CHANGE : - type: object - description: |+ - Change of Company/Business Name(s) with following children: - PREV_NAME - EFFECT_DATE - example: |+ - - - - - properties: - PREV_NAME : - type: string - description: Previous Name - example: HUA XI EATING HOUSE - EFFECT_DATE : - type: string - description: Effective Date - example: 25/10/1997 00:00:00 - LIST_SHAREHOLDER : - type: array - description: |+ - List of Shareholders with following children: - [SHAREHOLDER] - example: |+ - - -
- - - - - - - - - - items: - properties: - SHAREHOLDER : - type: object - description: |+ - Shareholders details with following children: - ADDRESS - COMP_ID - NO_OF_SHARE - CURRENCY - SHAREHOLDER_TYPE - SHARE_TYPE - SHAREHOLDER_NAME - CHANGE_ADDR_DATE - ADDR_TYPE - NATIONALITY - example: |+ - -
- - - - - - - - - - - properties: - ADDRESS : - type: string - description: Address - example: 1 HARBOURFRONT AVENUE , 18 – 01; KEPPEL BAY TOWER; 098632, SINGAPORE - COMP_ID : - type: string - description: Company/ Identity No. - example: 198200406H - NO_OF_SHARE : - type: string - description: No. of Shares - example: 657 - CURRENCY : - type: string - description: Currency - example: UNITED STATES OF AMERICA, DOLLARS - SHAREHOLDER_TYPE : - type: string - description: |+ - Indicator for Shareholder type. - Possible values are: - 1 Individual - 2 Company - 3 Unregistered foreign company - 4 Unregistered local company - example: 2 - SHARE_TYPE : - type: string - description: Share Type - example: Preference - SHAREHOLDER_NAME : - type: string - description: Shareholder Name - example: KEPPEL COMMUNICATIONS PTE LTD - CHANGE_ADDR_DATE : - type: string - description: Change Address Date - example: 09/05/2003 - ADDR_TYPE : - type: string - description: |+ - Address Type, indicates if it is Singapore or foreign address. - Possible values are: - S Indicates Singapore address - - Indicates foreign address - example: S - NATIONALITY : - type: string - description: Nationality - example: SINGAPORE - LIST_CAPITAL : - type: array - description: |+ - List of Capital details with following children: - [CAPITAL] - example: |+ - - - - - - - - - - items: - properties: - CAPITAL : - type: object - description: |+ - Capital details with following children: - CAPITAL_CATEGORY - CAPITAL_TYPE - CURRENCY - CAPITAL_AMT - NO_OF_SHARES - example: |+ - - - - - - - - properties: - CAPITAL_CATEGORY : - type: string - description: Capital Category - example: Issued - CAPITAL_TYPE : - type: string - description: Capital Type - example: Ordinary - CURRENCY : - type: string - description: Currency - example: SINGAPORE, DOLLARS - CAPITAL_AMT : - type: string - description: Capital Amount - example: 100,000.00 - NO_OF_SHARES : - type: string - description: Nos. of Shares - example: 100,000 - LIST_OFFICER_OWNER : - type: array - description: |+ - List of Officer(s) / Owner(s) with following children: - [OFFICER_OWNER] - example: |+ - - -
- - - - - - - - items: - properties: - OFFICER_OWNER : - type: object - description: |+ - Officer(s) / Owner(s) details with following children: - ADDRESS - IDENTITY_ID - PA_REG_NO - POSITION - ADDR_TYPE - CESSATION_DATE - OFFICER_NAME - CHANGE_ADDR_DATE - APPMT_DATE - NATIONALITY - example: |+ - -
- - - - - - - - - - properties: - ADDRESS : - type: string - description: Address - example: 50A TOH TUCK ROAD, 04 - 08 ; SIGNATURE PARK; 596742, SINGAPORE - IDENTITY_ID : - type: string - description: Identity No. - example: S1674174D - PA_REG_NO : - type: string - description: Public Accountant Registration No. - example: 00091 - POSITION : - type: string - description: Position - example: DIRECTOR - ADDR_TYPE : - type: string - description: |+ - Address Type, indicates if it is Singapore or foreign address. - Possible values are: - S Indicates Singapore address - - Indicates foreign address - example: S - CESSATION_DATE : - type: string - description: Cessation Date - example: 30/10/2003 - OFFICER_NAME : - type: string - description: Officer Name - example: HENRY GOH - CHANGE_ADDR_DATE : - type: string - description: Change Address Date - example: 30/10/2003 - APPMT_DATE : - type: string - description: Appointment Date - example: 30/10/2003 - NATIONALITY : - type: string - description: Nationality - example: SINGAPORE P.R. - LIST_SALES_REVENUE_AMOUNT : - type: array - description: |+ - List of Sales Revenue Amount with following children: - [SALES_REVENUE_AMOUNT] - example: |+ - - - 30000.00 - - - items: - properties: - SALES_REVENUE_AMOUNT : - type: object - description: |+ - Sales Revenue Amount details with following children: - ELEMENTS - YEAR - CURRENCY - AMOUNT - example: |+ - - - - - 30000.00 - - properties: - ELEMENTS : - type: string - description: Description - example: Sales Revenue Amount - YEAR : - type: string - description: Year - example: 2008 - CURRENCY : - type: string - description: Currency - example: SGD - AMOUNT : - type: string - description: Amount. Amount values that higher than 1000 have a comma to delimit every 3 digits of the amount value. - example: 30000.00 - LIST_Ddrptcount : - type: array - description: |+ - List of Search By Financial Sectors and Search By Non- Financial Sectors with following children: - [Ddrptcount] - example: - items: - properties: - Ddrptcount : - type: object - description: |+ - 6 XML tags (open then close) displays - Search By Financial Sectors (counts for 3 recent years) - Search By Non- Financial Sectors (counts for 3 recent years) - Following children are: - Rcyear - RcFlag (only respond for the year exists) - Rcjan - Rcfeb - Rcmar - Rcapr - Rcmay - Rcjun - Rcjul - Rcaug - Rcsep - Rcoct - Rcnov - Rcdec - Rcid (only respond for the year exists) Rcreg (only respond for the year exists) Rcrptyid (only respond for the year exists) - Rcsecflag - LastUpdateDate (only respond for the year exists) - example: - properties: - Rcyear : - type: string - description: To show the year - example: 2017 - RcFlag : - type: string - description: Internal database value - example: N/A - Rcjan : - type: integer - description: Count for January - example: 1 - Rcfeb : - type: integer - description: Count for February - example: 1 - Rcmar : - type: integer - description: Count for March - example: 1 - Rcapr : - type: integer - description: Count for April - example: 1 - Rcmay : - type: integer - description: Count for May - example: 1 - Rcjun : - type: integer - description: Count for June - example: 1 - Rcjul : - type: integer - description: Count for July - example: 1 - Rcaug : - type: integer - description: Count for August - example: 1 - Rcsep : - type: integer - description: Count for September - example: 1 - Rcoct : - type: integer - description: Count for October - example: 1 - Rcnov : - type: integer - description: Count for November - example: 1 - Rcdec : - type: integer - description: Count for December - example: 1 - Rcid : - type: string - description: |+ - Internal database value, respond value from table Primary Key ID - It is for (For internal use) - example: N/A - Rcreg : - type: string - description: Company Registration Number - example: - Rcrptyid : - type: string - description: |+ - Product Type. Possible values are: - 1. Biz Check: 0001 - 2. Biz Check Plus: 0002 - example: 0001 - Rcsecflag : - type: integer - description: Differentiate Search By Financial Sectors and Search By Non- Financial Sectors - example: 1 - LastUpdateDate : - type: datetime - description: Last update date - example: YYYY-MM-DD 00:00:00.0 - unauthorized: - type: object - properties: - message: - type: string - example: Missing Authentication Token - status: - type: string - example: Failure - forbidden: - type: object - properties: - message: - type: string - example: Access Denied Unauthorized User - status: - type: string - example: Failure - paymentrequired: - type: object - properties: - message: - type: string - example: Insufficient Credits Kindly Top Up - status: - type: string - example: Failure - notfound: - type: object - properties: - message: - type: string - example: Invalid Request URL - status: - type: string - example: Failure - servererror: - type: object - properties: - message: - type: string - example: Internal Server Error - status: - type: string - example: Failure - gatewaytimeout: - type: object - properties: - message: - type: string - example: Request Timeout - status: - type: string - example: Failure - inputfieldmissing: - type: object - properties: - message: - type: string - example: Input Field Missing - status: - type: string - example: Failure - inputlimitexceeded: - type: object - properties: - message: - type: string - example: Input Limit Exceeded - status: - type: string - example: Failure - invalidinput: - type: object - properties: - message: - type: string - example: Invalid Input - status: - type: string - example: Failure - REQUEST: - type: object - properties: - TOT_ITEMS: - type: number - example: 1 - description: Number of subjects being enquired relating to the Run - default: false - ENQUIRY: - type: object - example: |+ - 197601887ETRANSTAR TRAVEL PTE LTD - description: Contains information of each request details - default: true - properties: - SUBJECT_IDNO: - type: string - example: 199707714C - description: "Subject’s ID Number (individual) or Registration Number (company/business) as captured in DDP" - default: true - SUBJECT_NAME: - type: string - example: GPS INDUSTRIES PTE LTD - description: Subjects Name as captured in DDP - default: false - versions: - type: object - properties: - v0.1.0: - type: array - items: - oneOf: - - type: string - example: Published Date - Aug 15, 2019 - description: Initial version release - securitySchemes: - APIAuthorizer: - type: apiKey - name: x-api-key - in: header - x-amazon-apigateway-authtype: custom - description: Authentication is done using the x-api-key in the request header diff --git a/yaml/d&b_business_check_sg.yaml b/yaml/d&b_business_check_sg.yaml deleted file mode 100644 index 3bcfe57af..000000000 --- a/yaml/d&b_business_check_sg.yaml +++ /dev/null @@ -1,1149 +0,0 @@ -openapi: 3.0.1 -info: - title: D&B Business Check (SG) - description: |+ - This Data microservice provides key business information of a Singapore-registered company and includes the business name, registration number, registered address and date of change, company status, registered activities, shareholders details (i.e. date of commencement, residing address) capital amount and shares allocated to each shareholders. Updated daily. - x-additionalinfo: |+ - Suggested Use Cases: - - For software solutions that require general background checks of a company. This microservice can provide a high level of scrutiny of potential business associates, and throw light on the risks that cannot be detected by geopolitical analysis or batch screening levels. - - - For example, this microservice can be used to check if a Singapore-registered company meets regulations, such as if the company complies with anti-money laundering, anti-bribery, and corruption regulations by looking at registered activities, shareholders details, and more. - - - It can also be used to simplify the due diligence process, by identify risk issues using a range of reports that meet different compliance requirements. - - - It can also be used to protect your business – safeguard against reputational risk by avoiding those involved in financial crime. - - - It can also be used for finance-related domains such as vehicle leasing, loans, enterprise credit terms and so on. Updated daily. - version: '0.1.0' - x-subscribelink: d&b_business_check_sg -servers: - - url: 'https://api.sentient.io' -tags: -- name: "v0.1.0" - description: "Published Date - Aug 15, 2019" -paths: - /dnb/prod/sbc: - post: - tags: - - v0.1.0 - summary: Adds a new user - requestBody: - content: - application/xml: - schema: - $ref: '#/components/schemas/REQUEST' - responses: - '200': - description: success response - content: - application/xml: - schema: - $ref: '#/components/schemas/success' - example: |+ - string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string 0
string
- - string string string string string string string string string string string string string
string
- - string string string string string string string string string string string string string string string - '401': - description: Unauthorized - content: - application/json: - schema: - $ref: '#/components/schemas/unauthorized' - '402': - description: Payment Required - content: - application/json: - schema: - $ref: '#/components/schemas/paymentrequired' - '403': - description: Forbidden - content: - application/json: - schema: - $ref: '#/components/schemas/forbidden' - '404': - description: Not Found - content: - application/json: - schema: - $ref: '#/components/schemas/notfound' - '419': - description: Input Field Missing - content: - application/json: - schema: - $ref: '#/components/schemas/inputfieldmissing' - '413': - description: Input Limit Exceeded - content: - application/json: - schema: - $ref: '#/components/schemas/inputlimitexceeded' - '415': - description: Invalid Input - content: - application/json: - schema: - $ref: '#/components/schemas/invalidinput' - '500': - description: Internal Server Error - content: - application/json: - schema: - $ref: '#/components/schemas/servererror' - '504': - description: Gateway Timeout - content: - application/json: - schema: - $ref: '#/components/schemas/gatewaytimeout' - security: - - APIAuthorizer: [] -components: - schemas: - success: - type: object - properties: - REPORT: - type: object - example: - description: |+ - Report details with following children: - [META_INFO] - [REGISTRY_DETAIL] - [REQ_SEARCH_INFO] - [EMPLOYEE_SIZE] - [LIST_BIZ_BRANCH] - [LIST_REG_CHARGES] - [LIST_LIQUIDATOR] - [LIST_SHARE_INTEREST_COMP] - [LIST_NAME_CHANGE] - [LIST_SHAREHOLDER] - [LIST_CAPITAL] - [LIST_OFFICER_OWNER] - [LIST_SALES_REVENUE_AMOUNT] - properties: - META_INFO: - type: object - example: |+ - - - - - - - - description: |+ - Meta Information details with following children: - SERVICE - SYSTEM_ID - CREATION_DATE - USER_ID - CLASS - properties: - SERVICE: - type: string - description: Report requested - example: "BC" - SYSTEM_ID : - type: string - description: System ID - example: "DDP" - CREATION_DATE: - type: datetime - description: Report request date - example: "Wed Apr 08 11:37:51 MYT 2009" - USER_ID : - type: string - description: Valid user id in DDP system. It is for (For internal use) - example: "N/A" - CLASS: - type: string - description: Class location for metabean. It is for (For internal use) - example: "N/A" - REGISTRY_DETAIL : - type: object - example: |+ - - - - - - - - - - - - - - - - - - - - - - - - - - description: |+ - Registry Details with following children: - RENEWAL_DATE - ADDRESS1 - ADDRESS2 - ADDRESS3 - ADDRESS4 - COMP_TYPE_CODE - REG_DATE - REG_ACTIVITY1 - REG_ACTIVITY2 - ACC_DATE - STATUS_EFFECT_DATE - NAME_EFFECT_DATE - EXPIRY_DATE - COMP_TYPE - CHANGE_ADDR_DATE - COMP_STATUS - REG_ACTIVITY_DESC1 - REG_ACTIVITY_DESC2 - AUDITOR - AUDITOR_APPMT_DATE - LAST_AR_DATE - LAST_AGM_DATE - COUNTRY_INCORP - properties: - RENEWAL_DATE: - type: string - description: Renewal Date - example: "23/12/2008" - ADDRESS1: - type: string - description: Address Line 1 - example: "1 HARBOURFRONT AVENUE , 18 - 01" - ADDRESS2: - type: string - description: Address Line 2 - example: "KEPPEL BAY TOWER" - ADDRESS3: - type: string - description: Address Line 3 - example: "098632" - ADDRESS4: - type: string - description: Address Line 4 - example: "SINGAPORE" - COMP_TYPE_CODE: - type: string - example: CP - description: |+ - Report Code. Available values are: - 1. CP Corporate - 2. SP Sole Proprietor - REG_DATE: - type: string - description: Registration Date - example: "14/10/1974" - REG_ACTIVITY1: - type: string - description: Registered Activities 1 - example: "OTHER INVESTMENT HOLDING COMPANIES" - REG_ACTIVITY2: - type: string - description: Registered Activities 2 - example: "SHIP MANAGEMENT SERVICES" - ACC_DATE: - type: string - description: Account Date - example: "31/12/2007" - STATUS_EFFECT_DATE: - type: string - description: Status Effective Date - example: "14/10/1974" - NAME_EFFECT_DATE: - type: string - description: Name Effective Date - example: "14/10/1974" - EXPIRY_DATE: - type: string - description: Expiry Date - example: "25/10/2009" - COMP_TYPE: - type: string - description: Company Type - example: "LIMITED PRIVATE COMPANY" - CHANGE_ADDR_DATE: - type: string - description: Change Address Date - example: "09/05/2003" - COMP_STATUS: - type: string - description: Company Status - example: "Live Company" - REG_ACTIVITY_DESC1: - type: string - description: Registered Activities Description - example: - REG_ACTIVITY_DESC2: - type: string - description: Registered Activities Description - example: - AUDITOR: - type: string - description: Auditor Name - example: - AUDITOR_APPMT_DATE: - type: string - description: Auditor Appointment Date - example: "13/06/1990" - LAST_AR_DATE: - type: string - description: Date of Last AR - example: "30/06/2008" - LAST_AGM_DATE: - type: string - description: Date of Last AGM - example: "11/06/2008" - COUNTRY_INCORP: - type: string - description: Country Incorporated - example: "SINGAPORE" - REQ_SEARCH_INFO : - type: object - example: |+ - - - - - - - - - description: |+ - Request criteria & search record with following children: - COMP_NAME - REG_NO - REQ_DATE - REQ_REG_NO - REQ_NAME - REQ_DATE_STR - properties: - COMP_NAME: - type: string - description: Company Name - example: "KAPAL MANAGEMENT (PRIVATE) LIMITED" - REG_NO: - type: string - description: Subject’s ID Number (individual) or Registration Number (company/business) - example: "197401835M" - REQ_DATE: - type: string - description: Report Requested Date - example: "2009-04-08 11:36:03.611" - REQ_REG_NO: - type: string - description: Request Registration Number - example: "197401835M" - REQ_NAME: - type: string - description: Request Name - example: "KAPAL MANAGEMENT (PRIVATE) LIMITED" - REQ_DATE_STR: - type: string - description: Request Date String - example: "08/04/2009 11:36:03" - EMPLOYEE_SIZE : - type: object - description: |+ - Employee Size details with following children: - ELEMENTS - AMOUNT - example: |+ - - - 300 - - properties: - ELEMENTS: - type: string - description: Description - example: "Employee Size" - AMOUNT: - type: string - description: Number of employee - example: "300" - LIST_BIZ_BRANCH : - type: array - description: |+ - List of Business Branches with following children: - [BIZ_BRANCH] - example: |+ - - - - - - - properties: - BIZ_BRANCH : - type: object - description: |+ - Business Branches with following children: - ADDR_BUILDING - ADDR_POSTCODE - ADDR_ADDRESS1 - example: |+ - - - - - - properties: - ADDR_BUILDING: - type: string - description: Building Name - example: - ADDR_POSTCODE: - type: string - description: Postcode - example: 289848 - ADDR_ADDRESS1: - type: string - description: Address - example: 251A ARCADIA ROAD - LIST_REG_CHARGES: - type: array - description: |+ - List of Registered Charges with following children: - [REG_CHARGES] - example: |+ - - - - - - - - - - - items: - properties: - REG_CHARGES : - type: object - description: |+ - Registered Charges details with following children: - CHARGE_NO - CHARGE_DATE - CHARGEE_COMP - CURRENCY - AMT_SECURED - STATUS_SATISFACTION - example: |+ - - - - - - - - - properties: - CHARGE_NO : - type: string - description: Charge No. - example: 8205117 - CHARGE_DATE: - type: string - description: Charge Date - example: 26/11/1982 - CHARGEE_COMP: - type: string - description: Charges Company - example: UNITED OVERSEAS BANK LIMITED - CURRENCY: - type: string - description: Currency - example: - AMT_SECURED: - type: string - description: Amount Secured - example: 0.00 - STATUS_SATISFACTION: - type: string - description: Status of Satisfaction - example: - LIST_LIQUIDATOR: - type: array - description: |+ - List of Liquidator / Receiver / Judicial Manager with following children: - [LIQUIDATOR] - example: |+ - - - ABUTHAHIR ABDUL GAFOOR S1676216D - Liquidator - EL TICI FINANCIAL ADVISORY SERVICES PTE. LTD. 1 RAFFLES PLACE #20-01 - OUB CENTRE SINGAPORE 048616 30/03/2009 - - - items: - properties: - LIQUIDATOR : - type: object - description: |+ - Liquidator details with following children: - LIQ_POSITION - LIQ_ID - LIQ_NAME - LIQ_COMP - LIQ_ADDRESS1 - LIQ_ADDRESS2 - LIQ_ADDRESS3 - LIQ_ADDRESS4 - LIQ_APPOINTMENT_DATE - example: |+ - - ABUTHAHIR ABDUL GAFOOR - S1676216D - Liquidator - EL TICI FINANCIAL ADVISORY SERVICES PTE. LTD. - 1 RAFFLES PLACE - #20-01 - OUB CENTRE - SINGAPORE 048616 - 30/03/2009 - - properties: - LIQ_POSITION: - type: string - description: Liquidator / Receiver / Judicial Manager Position - example: Liquidator - LIQ_ID: - type: string - description: Liquidator / Receiver / Judicial Manager ID - example: S1676216D - LIQ_NAME : - type: string - description: Liquidator / Receiver / Judicial Manager Name - example: ABUTHAHIR ABDUL GAFOOR - LIQ_COMP: - type: string - description: Liquidator / Receiver / Judicial Manager Company Name - example: EL TICI FINANCIAL ADVISORY SERVICES PTE. LTD. - LIQ_ADDRESS1: - type: string - description: Liquidator / Receiver / Judicial Manager Address 1 - example: 1 RAFFLES PLACE - LIQ_ADDRESS2: - type: string - description: Liquidator / Receiver / Judicial Manager Address 2 - example: #20-01 - LIQ_ADDRESS3: - type: string - description: Liquidator / Receiver / Judicial Manager Address 3 - example: OUB CENTRE - LIQ_ADDRESS4: - type: string - description: Liquidator / Receiver / Judicial Manager Address 4 - example: SINGAPORE 048616 - LIQ_APPOINTMENT_DATE: - type: string - description: Liquidator / Receiver / Judicial Manager Appointment Date - example: 30/03/2009 - LIST_SHARE_INTEREST_COMP : - type: array - description: |+ - List of Share Interest In Companies with following children: - [SHARE_INTEREST_COMP] - example: |+ - - - - - - - - - items: - properties: - SHARE_INTEREST_COMP : - type: object - description: |+ - Share Interest In Companies details with following children: - COMP_NAME - SHARE_OWNED_UNIT - SHARE_OWNED_PERCENT - STATUS - example: |+ - - - - - - - properties: - COMP_NAME : - type: string - description: Company Name - example: ORCHID (HOLDINGS) PTE. LTD. - SHARE_OWNED_UNIT : - type: string - description: Shares Owned Unit - example: 500000 - SHARE_OWNED_PERCENT : - type: string - description: Shares Owned Value (%) - example: 100.00 - STATUS : - type: string - description: Status - example: DISSOLVED - MEMBERS' VOLUNTARY WINDING UP - LIST_NAME_CHANGE : - type: array - description: |+ - List of Change of Company/Business Name(s) with following children: - [NAME_CHANGE] - example: |+ - - - - - - - items: - properties: - NAME_CHANGE : - type: object - description: |+ - Change of Company/Business Name(s) with following children: - PREV_NAME - EFFECT_DATE - example: |+ - - - - - properties: - PREV_NAME : - type: string - description: Previous Name - example: HUA XI EATING HOUSE - EFFECT_DATE : - type: string - description: Effective Date - example: 25/10/1997 00:00:00 - LIST_SHAREHOLDER : - type: array - description: |+ - List of Shareholders with following children: - [SHAREHOLDER] - example: |+ - - -
- - - - - - - - - - items: - properties: - SHAREHOLDER : - type: object - description: |+ - Shareholders details with following children: - ADDRESS - COMP_ID - NO_OF_SHARE - CURRENCY - SHAREHOLDER_TYPE - SHARE_TYPE - SHAREHOLDER_NAME - CHANGE_ADDR_DATE - ADDR_TYPE - NATIONALITY - example: |+ - -
- - - - - - - - - - - properties: - ADDRESS : - type: string - description: Address - example: 1 HARBOURFRONT AVENUE , 18 – 01; KEPPEL BAY TOWER; 098632, SINGAPORE - COMP_ID : - type: string - description: Company/ Identity No. - example: 198200406H - NO_OF_SHARE : - type: string - description: No. of Shares - example: 657 - CURRENCY : - type: string - description: Currency - example: UNITED STATES OF AMERICA, DOLLARS - SHAREHOLDER_TYPE : - type: string - description: Indicator for Shareholder type - example: 2 - SHARE_TYPE : - type: string - description: Share Type - example: Preference - SHAREHOLDER_NAME : - type: string - description: Shareholder Name - example: KEPPEL COMMUNICATIONS PTE LTD - CHANGE_ADDR_DATE : - type: string - description: Change Address Date - example: 09/05/2003 - ADDR_TYPE : - type: string - description: Address Type, indicates if it is Singapore or foreign address. - example: - NATIONALITY : - type: string - description: Nationality - example: SINGAPORE - LIST_CAPITAL : - type: array - description: |+ - List of Capital details with following children: - [CAPITAL] - example: |+ - - - - - - - - - - items: - properties: - CAPITAL : - type: object - description: |+ - Capital details with following children: - CAPITAL_CATEGORY - CAPITAL_TYPE - CURRENCY - CAPITAL_AMT - NO_OF_SHARES - example: |+ - - - - - - - - properties: - CAPITAL_CATEGORY : - type: string - description: Capital Category - example: Issued - CAPITAL_TYPE : - type: string - description: Capital Type - example: Ordinary - CURRENCY : - type: string - description: Currency - example: SINGAPORE, DOLLARS - CAPITAL_AMT : - type: string - description: Capital Amount - example: 100,000.00 - NO_OF_SHARES : - type: string - description: Nos. of Shares - example: 100,000 - LIST_OFFICER_OWNER : - type: array - description: |+ - List of Officer(s) / Owner(s) with following children: - [OFFICER_OWNER] - example: |+ - - -
- - - - - - - - items: - properties: - OFFICER_OWNER : - type: object - description: |+ - Officer(s) / Owner(s) details with following children: - ADDRESS - IDENTITY_ID - PA_REG_NO - POSITION - ADDR_TYPE - CESSATION_DATE - OFFICER_NAME - CHANGE_ADDR_DATE - APPMT_DATE - NATIONALITY - example: |+ - -
- - - - - - - - - - properties: - ADDRESS : - type: string - description: Address - example: 50A TOH TUCK ROAD, 04 - 08 ; SIGNATURE PARK; 596742, SINGAPORE - IDENTITY_ID : - type: string - description: Identity No. - example: S1674174D - PA_REG_NO : - type: string - description: Public Accountant Registration No. - example: 00091 - POSITION : - type: string - description: Position - example: DIRECTOR - ADDR_TYPE : - type: string - description: Address Type, indicates if it is Singapore or foreign address. - example: S - CESSATION_DATE : - type: string - description: Cessation Date - example: 30/10/2003 - OFFICER_NAME : - type: string - description: Officer Name - example: HENRY GOH - CHANGE_ADDR_DATE : - type: string - description: Change Address Date - example: 30/10/2003 - APPMT_DATE : - type: string - description: Appointment Date - example: 30/10/2003 - NATIONALITY : - type: string - description: Nationality - example: SINGAPORE P.R. - LIST_SALES_REVENUE_AMOUNT : - type: array - description: |+ - List of Sales Revenue Amount with following children: - [SALES_REVENUE_AMOUNT] - example: |+ - - - 30000.00 - - - items: - properties: - SALES_REVENUE_AMOUNT : - type: object - description: |+ - Sales Revenue Amount details with following children: - ELEMENTS - YEAR - CURRENCY - AMOUNT - example: |+ - - - - - 30000.00 - - properties: - ELEMENTS : - type: string - description: Description - example: Sales Revenue Amount - YEAR : - type: integer - description: Year - example: 2008 - CURRENCY : - type: string - description: Currency - example: SGD - AMOUNT : - type: integer - description: Amount - example: 30000.00 - LIST_Ddrptcount : - type: array - description: |+ - List of Search By Financial Sectors and Search By Non- Financial Sectors with following children: - [Ddrptcount] - example: - items: - properties: - Ddrptcount : - type: object - description: |+ - 6 XML tags (open then close) displays - Search By Financial Sectors (counts for 3 recent years) - Search By Non- Financial Sectors (counts for 3 recent years) - Following children are: - Rcyear - RcFlag (only respond for the year exists) - Rcjan - Rcfeb - Rcmar - Rcapr - Rcmay - Rcjun - Rcjul - Rcaug - Rcsep - Rcoct - Rcnov - Rcdec - Rcid (only respond for the year exists) Rcreg (only respond for the year exists) Rcrptyid (only respond for the year exists) - Rcsecflag - LastUpdateDate (only respond for the year exists) - example: - properties: - Rcyear : - type: string - description: To show the year - example: 2017 - RcFlag : - type: string - description: Internal database value - example: N/A - Rcjan : - type: integer - description: Count for January - example: 1 - Rcfeb : - type: integer - description: Count for February - example: 1 - Rcmar : - type: integer - description: Count for March - example: 1 - Rcapr : - type: integer - description: Count for April - example: 1 - Rcmay : - type: integer - description: Count for May - example: 1 - Rcjun : - type: integer - description: Count for June - example: 1 - Rcjul : - type: integer - description: Count for July - example: 1 - Rcaug : - type: integer - description: Count for August - example: 1 - Rcsep : - type: integer - description: Count for September - example: 1 - Rcoct : - type: integer - description: Count for October - example: 1 - Rcnov : - type: integer - description: Count for November - example: 1 - Rcdec : - type: integer - description: Count for December - example: 1 - Rcid : - type: integer - description: Internal database value - example: - Rcreg : - type: string - description: Company Registration Number - example: - Rcrptyid : - type: string - description: Product Type - example: - Rcsecflag : - type: integer - description: Differentiate Search By Financial Sectors and Search By Non- Financial Sectors - example: 1 - LastUpdateDate : - type: string - description: Last update date - example: - unauthorized: - type: object - properties: - message: - type: string - example: Missing Authentication Token - status: - type: string - example: Failure - forbidden: - type: object - properties: - message: - type: string - example: Access Denied Unauthorized User - status: - type: string - example: Failure - paymentrequired: - type: object - properties: - message: - type: string - example: Insufficient Credits Kindly Top Up - status: - type: string - example: Failure - notfound: - type: object - properties: - message: - type: string - example: Invalid Request URL - status: - type: string - example: Failure - servererror: - type: object - properties: - message: - type: string - example: Internal Server Error - status: - type: string - example: Failure - gatewaytimeout: - type: object - properties: - message: - type: string - example: Request Timeout - status: - type: string - example: Failure - inputfieldmissing: - type: object - properties: - message: - type: string - example: Input Field Missing - status: - type: string - example: Failure - inputlimitexceeded: - type: object - properties: - message: - type: string - example: Input Limit Exceeded - status: - type: string - example: Failure - invalidinput: - type: object - properties: - message: - type: string - example: Invalid Input - status: - type: string - example: Failure - REQUEST: - type: object - properties: - TOT_ITEMS: - type: number - example: 1 - description: Number of subjects being enquired relating to the Run - default: false - ENQUIRY: - type: object - example: |+ - 197601887ETRANSTAR TRAVEL PTE LTD - description: Contains information of each request details - default: true - properties: - SUBJECT_IDNO: - type: string - example: 199707714C - description: "Subject’s ID Number (individual) or Registration Number (company/business) as captured in DDP" - default: true - SUBJECT_NAME: - type: string - example: GPS INDUSTRIES PTE LTD - description: Subjects Name as captured in DDP - default: false - versions: - type: object - properties: - v0.1.0: - type: array - items: - oneOf: - - type: string - example: Published Date - Aug 15, 2019 - description: Initial version release - securitySchemes: - APIAuthorizer: - type: apiKey - name: x-api-key - in: header - x-amazon-apigateway-authtype: custom - description: Authentication is done using the x-api-key in the request header diff --git a/yaml/decryption_using_pki_key.yaml b/yaml/decryption_using_pki_key.yaml deleted file mode 100644 index 737ef9ce6..000000000 --- a/yaml/decryption_using_pki_key.yaml +++ /dev/null @@ -1,225 +0,0 @@ -openapi: 3.0.1 -info: - title: Decryption using PKI Key - description: |+ - This Utiltiy microservice decrypts the input text using the input key string. - - This can be use with PKI Key Generator. - - Do ensure that your text is **within 512 characters**. - x-additionalinfo: |+ - Suggested Use Cases: - - This microservice can be used to simplify the deployment, management, and security of one's enterprise PKI with a microservice that helps to automate time-consuming, risky, and error-prone infrastructure tasks, freeing users to focus on higher-value projects. - version: '0.1.0' - x-subscribelink: decryption_using_pki_key -servers: - - url: 'https://apis.sentient.io' -tags: -- name: "v0.1.0" - description: "Published Date - Aug 30, 2019" -paths: - /microservices/utility/rsa_decode/v0.1/getresults: - post: - tags: - - v0.1.0 - responses: - '200': - description: success response - content: - application/json: - schema: - $ref: '#/components/schemas/success' - example: - message: Successfully Processed - status: Success - result: hello - '401': - description: Unauthorized - content: - application/json: - schema: - $ref: '#/components/schemas/unauthorized' - '402': - description: Payment Required - content: - application/json: - schema: - $ref: '#/components/schemas/paymentrequired' - '403': - description: Forbidden - content: - application/json: - schema: - $ref: '#/components/schemas/forbidden' - '404': - description: Not Found - content: - application/json: - schema: - $ref: '#/components/schemas/notfound' - '419': - description: Input Field Missing - content: - application/json: - schema: - $ref: '#/components/schemas/inputfieldmissing' - '413': - description: Input Limit Exceeded - content: - application/json: - schema: - $ref: '#/components/schemas/inputlimitexceeded' - '415': - description: Invalid Input - content: - application/json: - schema: - $ref: '#/components/schemas/invalidinput' - '500': - description: Internal Server Error - content: - application/json: - schema: - $ref: '#/components/schemas/servererror' - '504': - description: Gateway Timeout - content: - application/json: - schema: - $ref: '#/components/schemas/gatewaytimeout' - security: - - APIAuthorizer: [] - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/input' - required: true -components: - schemas: - success: - type: object - properties: - message: - type: string - example: Successfully Processed - description: Detailed description on the API status - status: - type: string - example: Success - description: The status of the API call success/failure - result: - type: string - example: hello - description: Original text - unauthorized: - type: object - properties: - message: - type: string - example: Missing Authentication Token - status: - type: string - example: Failure - forbidden: - type: object - properties: - message: - type: string - example: Access Denied Unauthorized User - status: - type: string - example: Failure - paymentrequired: - type: object - properties: - message: - type: string - example: Insufficient Credits Kindly Top Up - status: - type: string - example: Failure - notfound: - type: object - properties: - message: - type: string - example: Invalid Request URL - status: - type: string - example: Failure - servererror: - type: object - properties: - message: - type: string - example: Internal Server Error - status: - type: string - example: Failure - gatewaytimeout: - type: object - properties: - message: - type: string - example: Request Timeout - status: - type: string - example: Failure - inputfieldmissing: - type: object - properties: - message: - type: string - example: Input Field Missing - status: - type: string - example: Failure - inputlimitexceeded: - type: object - properties: - message: - type: string - example: Input Limit Exceeded - status: - type: string - example: Failure - invalidinput: - type: object - properties: - message: - type: string - example: Invalid Input - status: - type: string - example: Failure - versions: - type: object - properties: - v0.1.0: - type: array - items: - oneOf: - - type: string - example: Published Date - Aug 30, 2019 - description: Initial version release - input: - type: object - properties: - encodeText: - type: string - default: true - example: 4bafe80478a11553a69... - description: Encrypted text - key: - type: string - default: true - example: MIIEowIBAAKCAQ... - description: Private key - securitySchemes: - APIAuthorizer: - type: apiKey - name: x-api-key - in: header - x-amazon-apigateway-authtype: custom - description: Authentication is done using the x-api-key in the request header diff --git a/yaml/demographics_classification.yaml b/yaml/demographics_classification.yaml deleted file mode 100644 index 6fa1083f6..000000000 --- a/yaml/demographics_classification.yaml +++ /dev/null @@ -1,293 +0,0 @@ -openapi: 3.0.1 -info: - title: Demographics Classification - description: |+ - This Computer Vision microservice detects for faces from an input image and predicts the demographics of each face (age, gender and race). The image is given as an input encoded using base64. The microservice will a face detector and subsequently models to predict age, gender and race. The results will then be returned back to the user as a JSON output together with bounding box coordinates for each face.Races include: Asian, Indian, White, Black, Middle Eastern and Latino Hispanic - The size of your image file should **not exceed 5 MB**, and the image dimension should be **at least 416x416 pixels**. - x-additionalinfo: |+ - Suggested Use Cases: - - This microservice can be used as a solution to help businesses better understand and connect with their customers, engage new prospects and increase revenue. For example, it can be used to improve visitor experience and optimize operations in retail, leisure, and other sectors by identifying the type of demogrpahic that frequents a certain place the most. It can also be used to create intelligent prospect lists that ensure one is always maximizing their marketing investment. - version: v0.1.0 - x-subscribelink: demographics_classification -servers: - - url: 'https://apis.sentient.io' -tags: -- name: "v0.1.0" - description: "Published Date - Dec 09, 2020" -paths: - /microservices/cv/democlass/v0/getpredictions: - post: - tags: - - v0.1.0 - responses: - '200': - description: success response - content: - application/json: - schema: - $ref: '#/components/schemas/success' - example: - results: - persons: - - age: 33.21062944528088 - bbox: - bottom: 459 - left: 82 - right: 393 - top: 0 - gender: Man - race: white - - message: Successfully Processed - status: Success - '401': - description: Unauthorized - content: - application/json: - schema: - $ref: '#/components/schemas/unauthorized' - '402': - description: Payment Required - content: - application/json: - schema: - $ref: '#/components/schemas/paymentrequired' - '403': - description: Forbidden - content: - application/json: - schema: - $ref: '#/components/schemas/forbidden' - '404': - description: Not Found - content: - application/json: - schema: - $ref: '#/components/schemas/notfound' - '419': - description: Input Field Missing - content: - application/json: - schema: - $ref: '#/components/schemas/inputfieldmissing' - '413': - description: Input Limit Exceeded - content: - application/json: - schema: - $ref: '#/components/schemas/inputlimitexceeded' - '415': - description: Invalid Input - content: - application/json: - schema: - $ref: '#/components/schemas/invalidinput' - '500': - description: Internal Server error - content: - application/json: - schema: - $ref: '#/components/schemas/servererror' - '504': - description: Gateway Timeout - content: - application/json: - schema: - $ref: '#/components/schemas/gatewaytimeout' - security: - - APIAuthorizer: [] - - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/input' - required: true - - -components: - schemas: - success: - type: object - properties: - results: - type: object - description: The result of the API call. - example: { "" } - properties: - persons: - description: Demographic details of the detected person - example: - age: 33.21062944528088 - bbox: - bottom: 459 - left: 82 - right: 393 - top: 0 - gender: Man - race: white - items: - properties: - description: Demographic details of the detected person - example: ' ' - properties: - age: - description: Age of the detected person in the input image - example: 33.21062944528088 - type: float - bbox: - description: Bounding box of the detected person in the input image - example: ' ' - properties: - bottom: - description: Bottom coordinate of the box - example: 459 - type: integer - left: - description: Left coordinate of the box - example: 82 - type: integer - right: - description: Right coordinate of the box - example: 393 - type: integer - top: - description: Top coordinate of the box - example: 0 - type: integer - type: object - gender: - description: Gender of the detected person in the input image - example: Man - type: string - race: - description: Race of the detected person in the input image - example: white - type: string - type: object - type: object - type: array - - message: - type: string - example: Successfully Processed - description: Detail description on the API status - status: - type: string - example: Success - description: The status of the API call success/failure - - unauthorized: - type: object - properties: - message: - type: string - example: Missing Authentication Token - status: - type: string - example: Failure - forbidden: - type: object - properties: - message: - type: string - example: Access Denied Unauthorized User - status: - type: string - example: Failure - paymentrequired: - type: object - properties: - message: - type: string - example: Insufficient Credits Kindly Top Up - status: - type: string - example: Failure - notfound: - type: object - properties: - message: - type: string - example: Invalid Request - status: - type: string - example: Failure - servererror: - type: object - properties: - message: - type: string - example: Internal Server error - status: - type: string - example: Failure - gatewaytimeout: - type: object - properties: - message: - type: string - example: Request Timeout - status: - type: string - example: Failure - inputfieldmissing: - type: object - properties: - message: - type: string - example: Input Field Missing - status: - type: string - example: Failure - inputlimitexceeded: - type: object - properties: - message: - type: string - example: Input Limit Exceeded - status: - type: string - example: Failure - invalidinput: - type: object - properties: - message: - type: string - example: Invalid Input - status: - type: string - example: Failure - versions: - type: object - properties: - v0.1.0: - type: array - items: - oneOf: - - type: string - example: Published Date - Dec 09, 2020 - description: Initial version release - input: - type: object - required: - - - image_base64 - - properties: - image_base64: - x-name: image_base64 - type: string - default: True - example: /9j/4AAQSkZJRgABAQEASABIAAD/2wBDAAMCAgMCAgMDAwMEAwMEBQgFBQQEBQoHBwYIDAoMDAsKCwsNDhIQDQ4RDgsLEBYQERMUFRUVDA8XGBYUG... - description: |+ - Input image file in base64 format. - - - securitySchemes: - APIAuthorizer: - type: apiKey - name: x-api-key - in: header - x-amazon-apigateway-authtype: custom - description: Authentication is done using the x-api-key in the request header diff --git a/yaml/demographics_hdb_sg.yaml b/yaml/demographics_hdb_sg.yaml deleted file mode 100644 index bc9353022..000000000 --- a/yaml/demographics_hdb_sg.yaml +++ /dev/null @@ -1,448 +0,0 @@ -openapi: 3.0.1 -info: - title: HDB Demographics (SG) - x-subscribelink: demographics_hdb_sg - description: |+ - This Data microservice returns information on Housing Development Board of Singapore (HDB) estates and includes the location address, postal code, gender and age groups, down to block-level granularity.The HDB POTH programme makes selected public and non-public datasets available to developers and companies to improve their service offerings to benefit the lives of Singapore citizens. Sentient.io is proud to partner with HDB to manage and facilitate the sharing of data for the POTH Programme. - - **Note:** As this microservice uses the GET method, developers using this microservice must remember to have their app encode all the input values to be URL friendly (i.e. all spaces and special characters must be replaced). Here’s a reference on [URL encoding](https://www.w3schools.com/tags/ref_urlencode.ASP). - - x-additionalinfo : |+ - Suggested Use Cases: - - This microservice can be used as a solution to help businesses better understand and connect with their customers, engage new prospects and increase revenue. For example, it can be used to create intelligent prospect lists that ensure one is always maximizing their marketing investment. - - **Refining queries in the filterdata field using filter types and match types** - The filterdata fields use elasticsearch’s syntax (specifically filter types and match types) to help further refine search results and provide greater flexibility in structuring more sophisticated queries. - - **Filter Types:** - A filter type is a logic operator to which the search results must fulfill certain logical conditions to be returned. The supported match types are: - - * **must** - All of the stated conditions must match. Equivalent to an AND operator. - - > {"must":[{"match_phrase":{"street":"serangoon north avenue 4"}}]} - - * **must_not** - All of the stated conditions must not match. Equivalent to a NOT operator. - > {"must_not":[{"match":{"postalcode":"570251"}}]} - - * **should** - At least one of the stated conditions should match. Equivalent to an OR operator. - > {"should":[{"match_phrase":{"street":"serangoon north avenue 4"}}]} - - * **filter** - All of the stated conditions that must match. However, results are not scored unlike the other filter types which returns results based on how well the conditions are met. - > {"filter":[{"match":{"street":"serangoon"}}]} - - For a more detailed guide on filter types, [refer to this](https://www.elastic.co/guide/en/elasticsearch/reference/6.8/query-dsl-bool-query.html). - - Filter types cannot be used alone and must be used in conjunction with a match type to complete the query. - **Match Types:** - A match type is a match operator nested within a filter type that fine-tunes the matching condition of the text search. The supported match types are: - - * **match** - Search within a full text field for a single word - > {"match":{"street":"serangoon"}} - * **match_phrase** - Search within a full text field - > {"match_phrase":{"street":"serangoon central"}} - * **match_phrase_prefix** - Search within a full text field with prefix - > {"match_phrase_prefix":{"street":"serangoon central"}} - * **term** - Returns results that contain an exact term in a provided field - > {"term":{"postalcode":"560720"}} - * **terms** - Returns results that contain one or more exact terms in a provided field - > {"terms":{"postalcode":["560720","560721"]}} - - * **range** - Returns results that contain terms within a stipulated range - - > {"range":{"residents":{"gte":10}}} - > {"range":{"residents":{"lte":50}}} - > {"range":{"residents":{"gte":10,"lte":50}}} - - * **exists** - Returns results that contain any indexed value for a field - - > {"exists":{ "field":"postalcode"}} - For a more detailed guide to match types, [refer to this](https://www.elastic.co/guide/en/elasticsearch/reference/7.9/term-level-queries.html). - - **Forming sophisticated queries using combinations of filter types (in JSON)** - Multiple filter types can be combined together in one query (written in JSON format) to form a very sophisticated query. Here’s one example below: - - > { - > "must":[{"match_phrase":{"street":"serangoon+central"}}], - > "filter":[{"range":{"residents":{"gte":10}}}], - > "should":[{"match":{"gender":"male"}}], - > "must_not":[{"match":{"age_group_id":"2"}}] - > } - - **Sample Queries Based on Use Cases** - - 1. **Search for the number of elderly residents staying at Blk 423, Tampines Street 41 filter by age and gender.** - Using a filterdata only: - - > {"filter":[{"match":{"street":"tampines street 41"}},{"match":{"block":"423"}},{"terms":{"age_group_id":[6,7,8]}}]} - - 2. **Search for the number of female residents between age 50 to 59 staying in the postal code from 050034 to 050532.** - Using a filterdata only: - - > {"filter":[{"terms":{"postalcode":["050034","050532"]}},{"match":{"gender":"female"}},{"terms":{"age_group_id":[6]}}]} - version: '0.1.0' -servers: - - url: 'https://api.sentient.io' -tags: -- name: "v0.1.0" - description: "Published Date - May 15, 2020" -paths: - /DaaS/prod/hdb/demographics: - get: - tags: - - v0.1.0 - parameters: - - in: query - name: querystring - schema: - type: string - description: |+ - Simple keyword search for matches in all searchable fields. Keywords separated by spaces will return results containing any of those keywords. For exact phrase match, put entire phrase in double quotes (" "). - - If this field is set to null, by default the microservice will return all buildings (within the stated limit), which can be further refined through the filterdata field for more sophisticated queries. - - example: "tampines" - default: false - - in: query - name: offset - schema: - type: integer - description: The offset of the record list ie the starting index - example: "0" - default: false - - in: query - name: limit - schema: - type: integer - description: The max records to return for the request. Default - 10, Max - 10000 - example: "10" - default: false - - in: query - name: filterdata - schema: - type: string - description: |+ - Refine the search further on any of the possible through the 4 filter types : - * must - * must_not - * should - * filter - default: false - example: |+ - {"filter":[{"match":{"age_group_id":7}},{"match":{"gender":"male"}},{"match":{"postalcode":520423}}]} - responses: - '200': - description: success response - content: - application/json: - schema: - $ref: '#/components/schemas/success' - example: - results: - total: 986 - max_score: 17.995623 - hits: - - _index: sentient_demographics_hdb_index - _type: dir_doc - _id: K7scqWgBv3dNEHq2WvMo - _score: 17.995623 - _source: - postalcode: '560720' - gender: 'male' - age_group: '50 to 59' - age_group_id: 6 - residents: 54 - block: '34' - street: 'upper cross street' - xcoord: 29520.58 - ycoord: 39311.68 - address: '34 upper cross street' - createddate: '2020-04-23' - lastupdated: '2020-04-23' - location: - lat: 1.37179535 - lon: 103.8469821 - source: hdb - message: Successfully Processed - status: Success - '401': - description: Unauthorized - content: - application/json: - schema: - $ref: '#/components/schemas/unauthorized' - '402': - description: Payment Required - content: - application/json: - schema: - $ref: '#/components/schemas/paymentrequired' - '403': - description: Forbidden - content: - application/json: - schema: - $ref: '#/components/schemas/forbidden' - '404': - description: Not Found - content: - application/json: - schema: - $ref: '#/components/schemas/notfound' - '419': - description: Input Field Missing - content: - application/json: - schema: - $ref: '#/components/schemas/inputfieldmissing' - '413': - description: Input Limit Exceeded - content: - application/json: - schema: - $ref: '#/components/schemas/inputlimitexceeded' - '415': - description: Invalid Input - content: - application/json: - schema: - $ref: '#/components/schemas/invalidinput' - '500': - description: Internal Server Error - content: - application/json: - schema: - $ref: '#/components/schemas/servererror' - '504': - description: Gateway Timeout - content: - application/json: - schema: - $ref: '#/components/schemas/gatewaytimeout' - security: - - APIAuthorizer: [] -components: - schemas: - success: - type: object - properties: - results: - type: object - example: {} - description: Json Object of returned results - properties: - total: - type: number - example: 986 - description: Total number of records - max_score: - type: number - example: 17.995623 - description: The highest score value - hits: - type: array - example: [{} - description: Json Object of returned hits - properties: - postalcode: - type: string - description: Postal code of a block - example: "560720" - gender: - type: string - description: Gender details, values are male/female - example: "male" - age_group: - type: string - description: Range of age groups - example: "50 to 59" - age_group_id: - type: number - description: |+ - Age group ID represents a certain age range: - 1 (<10 years) - 2 (10-19 years) - 3 (20-29 years) - 4 (30-39 years) - 5 (40-49 years) - 6 (50-59 years) - 7 (60-69 years) - 8 (>70 years) - example: 6 - residents: - type: number - description: Number of residents - example: 54 - block: - type: string - description: Address block - example: "34" - street: - type: string - description: Street Address or building name - example: "upper cross street" - xcoord: - type: string - description: SVY21 X coordinates - example: 29520.58 - ycoord: - type: string - description: SVY21 Y coordinates - example: 39311.68 - address: - type: string - description: Building full address - example: "34 upper cross street" - createddate: - type: string - description: Record first release date on sentient - example: "2020-04-23" - lastupdated: - type: string - description: Record last updated date on sentient - example: "2020-04-23" - location: - type: object - description: WGS84 coordinates lat/long - example: {"lat":1.37179535,"lon":103.8469821} - properties: - lat: - type: string - description: WGS84 latitude - example: 1.37179535 - lon: - type: string - description: WGS84 longitude - example: 103.8469821 - source: - type: string - description: Dataset source - example: "hdb" - message: - type: string - example: Successfully Processed - description: The detail description on the status - status: - type: string - example: Success - description: The status of the API call Success/Failure - unauthorized: - type: object - properties: - message: - type: string - example: Missing Authentication Token - status: - type: string - example: Failure - forbidden: - type: object - properties: - message: - type: string - example: Access Denied Unauthorized User - status: - type: string - example: Failure - paymentrequired: - type: object - properties: - message: - type: string - example: Insufficient Credits Kindly Top Up - status: - type: string - example: Failure - notfound: - type: object - properties: - message: - type: string - example: Invalid Request URL - status: - type: string - example: Failure - servererror: - type: object - properties: - message: - type: string - example: Internal Server Error - status: - type: string - example: Failure - gatewaytimeout: - type: object - properties: - message: - type: string - example: Request Timeout - status: - type: string - example: Failure - inputfieldmissing: - type: object - properties: - message: - type: string - example: Input Field Missing - status: - type: string - example: Failure - inputlimitexceeded: - type: object - properties: - message: - type: string - example: Input Limit Exceeded - status: - type: string - example: Failure - invalidinput: - type: object - properties: - message: - type: string - example: Invalid Input - status: - type: string - example: Failure - versions: - type: object - properties: - v0.1.0: - type: array - items: - oneOf: - - type: string - example: Published Date - May 15,2020 - description: Initial version release - securitySchemes: - APIAuthorizer: - type: apiKey - name: x-api-key - in: header - x-amazon-apigateway-authtype: custom - description: Authentication is done using the x-api-key in the request header. diff --git a/yaml/directory_of_singapore_startups.yaml b/yaml/directory_of_singapore_startups.yaml deleted file mode 100644 index 87562de87..000000000 --- a/yaml/directory_of_singapore_startups.yaml +++ /dev/null @@ -1,548 +0,0 @@ -openapi: 3.0.1 -info: - title: Directory of Singapore Startups - x-subscribelink: directory_of_singapore_startups - description: |+ - This Data microservice retrieves the list of all Singapore startup companies found on the internet through web scraping. Updated quarterly. - x-additionalinfo: |+ - Suggested Use Cases: - - Build solutions related to startups in Singapore. For example, investors interested in industry analysis can use this microservice to identify the trends and patterns in Singapore's startup scene. - - **Refining queries in the filterdata field using filter types and match types** - - The filterdata fields use elasticsearch’s syntax (specifically filter types and match types) to help further refine search results and provide greater flexibility in structuring more sophisticated queries. - - **Filter Types:** - - A filter type is a logic operator to which the search results must fulfill certain logical conditions to be returned. The supported match types are: - - * **must** - All of the stated conditions must match. Equivalent to an AND operator. - - > {"must":[{"match":{"name":"technology"}}]} - - * **must_not** - All of the stated conditions must not match. Equivalent to a NOT operator. - - > {"must_not":[{"match":{"yearestablished.e27":"2016"}}]} - - * **should** - At least one of the stated conditions should match. Equivalent to an OR operator. - - > {"should":[{"match":{"status.e27":"active"}}]} - - * **filter** - All of the stated conditions that must match. However, results are not scored unlike the other filter types which returns results based on how well the conditions are met. - - > {"filter":[{"exists":{"field":"company.e27"}}]} - - For a more detailed guide on filter types, [refer to this](https://www.elastic.co/guide/en/elasticsearch/reference/6.8/query-dsl-bool-query.html). - - Filter types cannot be used alone and must be used in conjunction with a match type to complete the query. - - **Match Types:** - - A match type is a match operator nested within a filter type that fine-tunes the matching condition of the text search. The supported match types are: - - * **match** - Search within a full text field for a single word - - > {"match":{"name":"technology"}} - - * **match_phrase** - Search within a full text field - - > {"match_phrase":{"name":"nextwave partners"}} - - * **match_phrase_prefix** - Search within a full text field with prefix - - > {"match_phrase_prefix":{"name":"nextwave partners"}} - - * **term** - Returns results that contain an exact term in a provided field - - > {"term":{"employeecount.techinasia":"11"}} - - * **terms** - Returns results that contain one or more exact terms in a provided field - - > {"terms":{"employeecount.techinasia":["11","15"]}} - - * **range** - Returns results that contain terms within a stipulated range - - > {"range":{"company.techinasia.funding.amount":{"gte":10000000}}} - > {"range":{"company.techinasia.funding.amount":{"lte":50000000}}} - > {"range":{"company.techinasia.funding.amount":{"gte":10000000,"lte":50000000}}} - - * **exists** - Returns results that contain any indexed value for a field - - > {"exists":{"field":"company.e27"}} - - **Sample filterdata JSON:** - > { - > "must":[{"match":{"name":"technology"}}], - > "filter":[{"exists":{"field":"company.e27"}}], - > "should":[{"match":{"status.e27":"active"}}], - > "must_not":[{"match":{"yearestablished.e27":"2016"}}] - > } - version: '0.1.0' -servers: - - url: 'https://api.sentient.io' -tags: -- name: "v0.1.0" - description: "Published Date - Dec 26, 2018" -paths: - /DaaS/prod/directories/searchdir: - get: - tags: - - v0.1.0 - parameters: - - in: query - name: querystring - schema: - type: string - description: |+ - Simple keyword search for matches in all searchable fields. Keywords separated by spaces will return results containing any of those keywords. For exact phrase match, put entire phrase in double quotes (" "). - - If this field is set to null, by default the microservice will return all start ups (within the stated limit), which can be further refined through the filterdata field for more sophisticated queries. - - example: "technology" - default: false - - in: query - name: offset - schema: - type: integer - description: The offset of the record list ie the starting index - example: "0" - default: false - - in: query - name: limit - schema: - type: integer - description: The max records to return for the request. Default - 10, Max - 10000 - example: "10" - default: false - - in: query - name: filterdata - schema: - type: string - description: |+ - Refine the search further on any of the possible through the 4 filter types : - * must - * must_not - * should - * filter - default: false - example: |+ - {"must":[{"match":{"name":"technology"}}],"filter":[{"exists":{"field":"company.e27"}}],"should":[{"match":{"status.e27":"active"}}],"must_not":[{"match":{"yearestablished.e27":"2016"}}]} - responses: - '200': - description: success response - content: - application/json: - schema: - $ref: '#/components/schemas/success' - example: - results: - total: 986 - max_score: 1 - hits: - - _index: sentient_directory_index - _type: dir_doc - _id: TrrmAWgBv3dNEHq24P-C - _score: 1 - _source: - type: company - source: sentient - address: singapore - createddate: '2018-12-31' - name: AAR Consultancy - logo: - e27: https://e27.co/img/startups/11448/logo.png - company: - e27: - sourceurl: https://e27.co/startup/aar-consultancy - type: startup - technology: - - Enterprise Solution - - Big Data - - E-commerce - - Education - - Internet of Things - socialmedia: - e27: - linkedin: https://sg.linkedin.com/in/soumikch - descshort: - e27: Google Certified Professionals. Providing with Consultation, Implementation - Strategy and Training of various online platforms, methods and campaigns, - including eComm launches. - desclong: - e27: 'My name is Soumik and I am founder of AAR Consultancy, a registered - business in Singapore. I provide online consultancy, implementation strategy - development and Training.I offer various online services, which you can - see from my attached company profile. I am an MBA with 11+ years experience - helping manage digital / online marketing for various industries. Been guest - speakers at seminars and conferences and provided corporate training to - SMEs and MNCs alike. I have worked with Streetdirectory, MDIS, Ogilvy and - Mather, American Express and Mothercare and has helped clients such as IBM, - Unilever, Nestle, SingTel, Guinness amongst others. SMEs, MNCs : B2B and - B2C.Have launched eCommerce Platforms, websites, strategies, technologies, - apps, and more.Trained and implemented, SEO, AdWords - ppc, media ads, social, - community management and more.' - website: - e27: http://ww.aaronline.sg - status: - e27: active - message: Successfully Processed - status: Success - '401': - description: Unauthorized - content: - application/json: - schema: - $ref: '#/components/schemas/unauthorized' - '402': - description: Payment Required - content: - application/json: - schema: - $ref: '#/components/schemas/paymentrequired' - '403': - description: Forbidden - content: - application/json: - schema: - $ref: '#/components/schemas/forbidden' - '404': - description: Not Found - content: - application/json: - schema: - $ref: '#/components/schemas/notfound' - '419': - description: Input Field Missing - content: - application/json: - schema: - $ref: '#/components/schemas/inputfieldmissing' - '413': - description: Input Limit Exceeded - content: - application/json: - schema: - $ref: '#/components/schemas/inputlimitexceeded' - '415': - description: Invalid Input - content: - application/json: - schema: - $ref: '#/components/schemas/invalidinput' - '500': - description: Internal Server Error - content: - application/json: - schema: - $ref: '#/components/schemas/servererror' - '504': - description: Gateway Timeout - content: - application/json: - schema: - $ref: '#/components/schemas/gatewaytimeout' - security: - - APIAuthorizer: [] -components: - schemas: - success: - type: object - properties: - results: - type: object - example: { "" } - description: Json Object of returned results - properties: - total: - type: number - example: 986 - description: Total number of records - max_score: - type: number - example: 1 - description: The highest score value - hits: - type: array - example: [ { "" } - description: Json Object of returned hits - properties: - type: - type: string - description: Directory type - example: company - source: - type: string - description: Dataset source - example: sentient - address: - type: string - description: Full address - example: singapore - createddate: - type: string - description: Record first release date on sentient - example: '2018-12-31' - name: - type: string - description: Business name - example: AAR Consultancy - logo: - type: object - example: { "" } - description: List of logo from various content providers like f6s, e27, techinasia - properties: - : - type: string - description: logo url - example: 'https://e27.co/img/startups/11448/logo.png' - company: - type: object - example: { "" } - description: Full details about the company from various content providers like f6s, e27, techinasia - properties: - : - type: object - example: { "" } - description: Directory details from the content provider like f6s, e27, techinasia - properties: - sourceurl: - type: string - description: Directory source url - example: 'https://e27.co/startup/tech-in-asia' - type: - type: string - description: Type of Directory - example: startup - technology: - type: array - items: - oneOf: - - type: string - format: list - example: Enterprise Solution - - type: string - format: list - example: Big Data - - type: string - format: list - example: E-commerce - - type: string - format: list - example: Education - - type: string - format: list - example: Internet of Things - funding: - type: array - example: [ { "" } - description: Various Social media details from various content providers like f6s, e27, techinasia - properties: - : - type: string - description: Social media information of the record - example: 'https://www.linkedin.com/company/tech-in-asia' - properties: - linkedin: - type: string - description: Social media - Linkedin url - example: 'https://www.linkedin.com/company/tech-in-asia' - facebook: - type: string - description: Social media - Facebook url - example: 'https://www.facebook.com/techinasia' - twitter: - type: string - description: Social media - twitter url - example: 'https://www.twitter.com/Techinasia' - descshort: - type: object - example: { "" } - description: Short description - properties: - : - type: string - description: Short description from various content providers like f6s, e27, techinasia - example: 'Tech in Asia (YC W15) is the go-to online platform for Asia’s tech community, with annual conferences hosted in Singapore, Tokyo, and Jakarta.' - desclong: - type: object - example: { "" } - description: Long description - properties: - : - type: string - description: Long description from various content providers like f6s, e27, techinasia - example: 'Tech in Asia (YC W15) is the go-to online platform for Asia’s tech community, with annual conferences hosted in Singapore, Tokyo, and Jakarta. Right here is where you can keep abreast of Asia’s tech industry, share your thoughts alongside ours, and connect with startups and investors alike.With an ever-growing team of close to 100 based all across Asia and the US, spanning editorial, events and database functions, they are fully dedicated to bringing Asia’s tech ecosystem closer together.Above all, they want to give you a voice with their platform and facilitate meaningful discussions that would otherwise only take place offline. Anyone willing to add value to Asia’s tech community and ecosystem is able and welcome to join in the conversation.Tech in Asia counts Softbank, Y Combinator, Walden International, East Ventures, Facebook co-founder Eduardo Saverin, and more amongst its list of investors. Their statement of ethics governs their principles regarding full disclosure and conflicts of interest.' - website: - type: object - example: { "" } - description: Website details from various content providers like f6s, e27, techinasia - properties: - : - type: string - description: Website address - example: 'https://www.techinasia.com' - status: - type: object - example: { "" } - description: Company status from various content providers like f6s, e27, techinasia - properties: - : - type: string - description: Company status - example: active - message: - type: string - example: Successfully Processed - description: The detail description on the status - status: - type: string - example: Success - description: The status of the API call Success/Failure - unauthorized: - type: object - properties: - message: - type: string - example: Missing Authentication Token - status: - type: string - example: Failure - forbidden: - type: object - properties: - message: - type: string - example: Access Denied Unauthorized User - status: - type: string - example: Failure - paymentrequired: - type: object - properties: - message: - type: string - example: Insufficient Credits Kindly Top Up - status: - type: string - example: Failure - notfound: - type: object - properties: - message: - type: string - example: Invalid Request URL - status: - type: string - example: Failure - servererror: - type: object - properties: - message: - type: string - example: Internal Server Error - status: - type: string - example: Failure - gatewaytimeout: - type: object - properties: - message: - type: string - example: Request Timeout - status: - type: string - example: Failure - inputfieldmissing: - type: object - properties: - message: - type: string - example: Input Field Missing - status: - type: string - example: Failure - inputlimitexceeded: - type: object - properties: - message: - type: string - example: Input Limit Exceeded - status: - type: string - example: Failure - invalidinput: - type: object - properties: - message: - type: string - example: Invalid Input - status: - type: string - example: Failure - versions: - type: object - properties: - v0.1.0: - type: array - items: - oneOf: - - type: string - example: Published Date - Dec 26, 2018 - description: Initial version release - securitySchemes: - APIAuthorizer: - type: apiKey - name: x-api-key - in: header - x-amazon-apigateway-authtype: custom - description: Authentication is done using the x-api-key in the request header. diff --git a/yaml/document_convertor_eng.yaml b/yaml/document_convertor_eng.yaml deleted file mode 100644 index 05cf17edd..000000000 --- a/yaml/document_convertor_eng.yaml +++ /dev/null @@ -1,235 +0,0 @@ -openapi: 3.0.1 -info: - title: Document Convertor ENG - description: |+ - This Utility microservice extracts the English text content of singular input Microsoft Word, HTML or PDF documents and outputs into plain text format. - - The size of your document file should **not exceed 7 MB**. - x-additionalinfo: |+ - Suggested Use Cases: - - Used for pre/post processing of documents so that the output can paired with another microservice to address a specific solution. For example, text extracted from the document can be used with a Voice microservice such as Text-to-Speech. - - - Can be used for solutions related to processing workflows that are document-heavy so that the user can focus on the more value-added decisions. Documents in a variety of formats can be taken in to return cleanly structured data. Examples included mortgage processing, procurement data etc. - version: '1.0.0' - x-subscribelink: document_convertor_eng -servers: - - url: 'https://apis.sentient.io' -tags: -- name: "v1.0.0" - description: "Published Date - Jul 30, 2020" -paths: - /microservices/utility/docconversion/v1.0/getresults: - post: - tags: - - v1.0.0 - responses: - '200': - description: success response - content: - application/json: - schema: - $ref: '#/components/schemas/success' - example: - results: "\\n L 328/84 \\n Official Journal of the European Union \\n EN \\n - 18.12.2019 \\n DECISIONS \\n COMMISSION IMPLEMENTING DECISION (EU) 2019/2166 \\n - of 16 December 2019 \\n amending Implementing Decision 2014/908/EU as regards the - inclusion of Serbia and South Korea in \\n the lists of third countries and - \ territories whose supervisory and regulatory requirements" - message: Successfully Processed - status: Success - '401': - description: Unauthorized - content: - application/json: - schema: - $ref: '#/components/schemas/unauthorized' - '402': - description: Payment Required - content: - application/json: - schema: - $ref: '#/components/schemas/paymentrequired' - '403': - description: Forbidden - content: - application/json: - schema: - $ref: '#/components/schemas/forbidden' - '404': - description: Not Found - content: - application/json: - schema: - $ref: '#/components/schemas/notfound' - '419': - description: Input Field Missing - content: - application/json: - schema: - $ref: '#/components/schemas/inputfieldmissing' - '413': - description: Input Limit Exceeded - content: - application/json: - schema: - $ref: '#/components/schemas/inputlimitexceeded' - '415': - description: Invalid Input - content: - application/json: - schema: - $ref: '#/components/schemas/invalidinput' - '500': - description: Internal Server Error - content: - application/json: - schema: - $ref: '#/components/schemas/servererror' - '504': - description: Gateway Timeout - content: - application/json: - schema: - $ref: '#/components/schemas/gatewaytimeout' - security: - - APIAuthorizer: [] - requestBody: - content: - multipart/form-data: - schema: - $ref: '#/components/schemas/input' -components: - schemas: - success: - type: object - properties: - results: - type: string - example: \n L 328/84 \n Official Journal of the European Union \n EN \n 18.12.2019 \n DECISIONS \n COMMISSION IMPLEMENTING DECISION (EU) 2019/2166 \n of 16 December 2019 \n amending Implementing Decision 2014/908/EU as regards the inclusion of Serbia and South Korea in \n the lists of third countries and territories whose supervisory and regulatory requirements - description: The result of the API call. - message: - type: string - example: Successfully Processed - description: Detail description on the API status - status: - type: string - example: Success - description: The status of the API call success/failure - unauthorized: - type: object - properties: - message: - type: string - example: Missing Authentication Token - status: - type: string - example: Failure - forbidden: - type: object - properties: - message: - type: string - example: Access Denied Unauthorized User - status: - type: string - example: Failure - paymentrequired: - type: object - properties: - message: - type: string - example: Insufficient Credits Kindly Top Up - status: - type: string - example: Failure - notfound: - type: object - properties: - message: - type: string - example: Invalid Request URL - status: - type: string - example: Failure - servererror: - type: object - properties: - message: - type: string - example: Internal Server Error - status: - type: string - example: Failure - gatewaytimeout: - type: object - properties: - message: - type: string - example: Request Timeout - status: - type: string - example: Failure - inputfieldmissing: - type: object - properties: - message: - type: string - example: Input Field Missing - status: - type: string - example: Failure - inputlimitexceeded: - type: object - properties: - message: - type: string - example: Input Limit Exceeded - status: - type: string - example: Failure - invalidinput: - type: object - properties: - message: - type: string - example: Invalid Input - status: - type: string - example: Failure - versions: - type: object - properties: - v1.0.0: - type: array - items: - oneOf: - - type: string - example: Published Date - Jul 30, 2020 - description: Change libary for PDF reader - v0.1.0: - type: array - items: - oneOf: - - type: string - example: Published Date - Apr 16, 2018 - description: Initial version release - input: - type: object - required: - - filePath - properties: - filePath: - type: string - format: binary - default: true - example: sample.txt - description: The file object. - - Supported formats: docx, pdf, txt. - securitySchemes: - APIAuthorizer: - type: apiKey - name: x-api-key - in: header - x-amazon-apigateway-authtype: custom - description: Authentication is done using the x-api-key in the request header diff --git a/yaml/download_dataset.yaml b/yaml/download_dataset.yaml deleted file mode 100644 index 34c1dc112..000000000 --- a/yaml/download_dataset.yaml +++ /dev/null @@ -1,10 +0,0 @@ -info: - title: Data Alliance - Download Dataset API - version: '0.1.0' -# tags must include in to the documentation, to read the description text for published date -tags: -- name: "v0.1.0" - description: " " -html: |+ - diff --git a/yaml/encryption_using_pki_key.yaml b/yaml/encryption_using_pki_key.yaml deleted file mode 100644 index 89f64add2..000000000 --- a/yaml/encryption_using_pki_key.yaml +++ /dev/null @@ -1,225 +0,0 @@ -openapi: 3.0.1 -info: - title: Encryption using PKI Key - description: |+ - This Utiltiy microservice encrypts the input text using the input key string. - - This can be use with PKI Key Generator. - - Do ensure that your text is **within 512 characters**. - x-additionalinfo: |+ - Suggested Use Cases: - - This microservice can be used to simplify the deployment, management, and security of one's enterprise PKI with a microservice that helps to automate time-consuming, risky, and error-prone infrastructure tasks, freeing users to focus on higher-value projects. - version: '0.1.0' - x-subscribelink: encryption_using_pki_key -servers: - - url: 'https://apis.sentient.io' -tags: -- name: "v0.1.0" - description: "Published Date - Aug 30, 2019" -paths: - /microservices/utility/rsa_encode/v0.1/getresults: - post: - tags: - - v0.1.0 - responses: - '200': - description: success response - content: - application/json: - schema: - $ref: '#/components/schemas/success' - example: - message: Successfully Processed - status: Success - result: nXqbfpv8gK3wZqLjohfy2NCdBJSXQ/NyHec52SFcQiePxl/iVB9wwThAc1U3mBRSM2/YysQodsd89DVuQx3aNNV4/BmYmC53yeWIwfpHZv8DOWSY4dremBDFa6vaFLF89ed0RSkgl7+cut4g0bkXuMODMyEfBerqnrsvQlqHbVY= - '401': - description: Unauthorized - content: - application/json: - schema: - $ref: '#/components/schemas/unauthorized' - '402': - description: Payment Required - content: - application/json: - schema: - $ref: '#/components/schemas/paymentrequired' - '403': - description: Forbidden - content: - application/json: - schema: - $ref: '#/components/schemas/forbidden' - '404': - description: Not Found - content: - application/json: - schema: - $ref: '#/components/schemas/notfound' - '419': - description: Input Field Missing - content: - application/json: - schema: - $ref: '#/components/schemas/inputfieldmissing' - '413': - description: Input Limit Exceeded - content: - application/json: - schema: - $ref: '#/components/schemas/inputlimitexceeded' - '415': - description: Invalid Input - content: - application/json: - schema: - $ref: '#/components/schemas/invalidinput' - '500': - description: Internal Server Error - content: - application/json: - schema: - $ref: '#/components/schemas/servererror' - '504': - description: Gateway Timeout - content: - application/json: - schema: - $ref: '#/components/schemas/gatewaytimeout' - security: - - APIAuthorizer: [] - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/input' - required: true -components: - schemas: - success: - type: object - properties: - message: - type: string - example: Successfully Processed - description: Detailed description on the API status - status: - type: string - example: Success - description: The status of the API call. - result: - type: string - description: Encrypted text - example: nXqbfpv8gK3wZqLjohfy2NCdBJSXQ/NyHec52SFcQiePxl/iVB9wwThAc1U3mBRSM2/YysQodsd89DVuQx3aNNV4/BmYmC53yeWIwfpHZv8DOWSY4dremBDFa6vaFLF89ed0RSkgl7+cut4g0bkXuMODMyEfBerqnrsvQlqHbVY= - unauthorized: - type: object - properties: - message: - type: string - example: Missing Authentication Token - status: - type: string - example: Failure - forbidden: - type: object - properties: - message: - type: string - example: Access Denied Unauthorized User - status: - type: string - example: Failure - paymentrequired: - type: object - properties: - message: - type: string - example: Insufficient Credits Kindly Top Up - status: - type: string - example: Failure - notfound: - type: object - properties: - message: - type: string - example: Invalid Request URL - status: - type: string - example: Failure - servererror: - type: object - properties: - message: - type: string - example: Internal Server Error - status: - type: string - example: Failure - gatewaytimeout: - type: object - properties: - message: - type: string - example: Request Timeout - status: - type: string - example: Failure - inputfieldmissing: - type: object - properties: - message: - type: string - example: Input Field Missing - status: - type: string - example: Failure - inputlimitexceeded: - type: object - properties: - message: - type: string - example: Input Limit Exceeded - status: - type: string - example: Failure - invalidinput: - type: object - properties: - message: - type: string - example: Invalid Input - status: - type: string - example: Failure - input: - type: object - properties: - text: - type: string - default: true - example: plain text - description: Input text - key: - type: string - default: true - example: MIIBIjANBgkqhkiG9w0BAQEF... - description: Public key - versions: - type: object - properties: - v0.1.0: - type: array - items: - oneOf: - - type: string - example: Published Date - Aug 30, 2019 - description: Initial version release - securitySchemes: - APIAuthorizer: - type: apiKey - name: x-api-key - in: header - x-amazon-apigateway-authtype: custom - description: Authentication is done using the x-api-key in the request header diff --git a/yaml/face_recognition_politicians_sg.yaml b/yaml/face_recognition_politicians_sg.yaml deleted file mode 100644 index 926daba86..000000000 --- a/yaml/face_recognition_politicians_sg.yaml +++ /dev/null @@ -1,271 +0,0 @@ -openapi: 3.0.1 -info: - title: Face Recognition - description: |+ - This Computer Vision microservice recognises faces of Singaporean and Japanese public figures (e.g. athletes, business leaders, celebrities, politicians, TV personalities, etc). - - This microservice returns the identity of the person, the bounding box in image coordinates, and the confidence of the prediction. Users can further filter - - Help us grow this microservice! [Let us know](https://www.sentient.io/contact) which other public figures you would like us this microservice to also recognise (e.g. a new country or a new category). We will expand the capability of this microservices based on user feedback and demand. - x-additionalinfo: |+ - Suggested Use Cases: - - For solutions related to identifying the speaker for auto-tagging, or matching the transcription to a person that is a Singaporean politician, or a Singaporean/Japanese public figure. - version: '0.1.0' - x-subscribelink: face_recognition -servers: - - url: 'https://apis.sentient.io' -tags: -- name: "v0.1.0" - description: "Published Date - Jul 03, 2020" -paths: - /microservices/cv/facerecognition/v0.1/getpredictions: - post: - tags: - - v0.1.0 - responses: - '200': - description: success response - content: - application/json: - schema: - $ref: '#/components/schemas/success' - example: - results: {conf: 0.6588699206768599,identity: "Lee Hsien Loong",location: [67,339,196,210]} - '401': - description: Unauthorized - content: - application/json: - schema: - $ref: '#/components/schemas/unauthorized' - '402': - description: Payment Required - content: - application/json: - schema: - $ref: '#/components/schemas/paymentrequired' - '403': - description: Forbidden - content: - application/json: - schema: - $ref: '#/components/schemas/forbidden' - '404': - description: Not Found - content: - application/json: - schema: - $ref: '#/components/schemas/notfound' - '419': - description: Input Field Missing - content: - application/json: - schema: - $ref: '#/components/schemas/inputfieldmissing' - '413': - description: Input Limit Exceeded - content: - application/json: - schema: - $ref: '#/components/schemas/inputlimitexceeded' - '415': - description: Invalid Input - content: - application/json: - schema: - $ref: '#/components/schemas/invalidinput' - '500': - description: Internal Server Error - content: - application/json: - schema: - $ref: '#/components/schemas/servererror' - '504': - description: Gateway Timeout - content: - application/json: - schema: - $ref: '#/components/schemas/gatewaytimeout' - security: - - APIAuthorizer: [] - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/input' - required: true -components: - schemas: - success: - type: object - properties: - results: - type: array - example: {conf: 0.6588699206768599,identity: "Lee Hsien Loong",location: [67,339,196,210]} - description: Details of the face recognised from the image - items: - oneOf: - - type: object - properties: - conf: - type: number - format: float - example: 0.6588699206768599 - description: 0.0 to 1.0. Confidence score of identification. Higher is more confidence. - identity: - type: string - example: Lee Hsien Loong - description: Person's formal name. If identity is not known, "UNKNOWN" is returned - location: - type: array - example: [67,339,196,210] - description: bounding box of the face in pixel coordinates of top, right, bottom, left. - items: - oneOf: - - type: number - example: 67 - - unauthorized: - type: object - properties: - message: - type: string - example: Missing Authentication Token - status: - type: string - example: Failure - restricted: - type: object - properties: - message: - type: string - example: The content is restricted - status: - type: string - example: Failure - forbidden: - type: object - properties: - message: - type: string - example: Access Denied Unauthorized User - status: - type: string - example: Failure - paymentrequired: - type: object - properties: - message: - type: string - example: Insufficient Credits Kindly Top Up - status: - type: string - example: Failure - notfound: - type: object - properties: - message: - type: string - example: Invalid Request - status: - type: string - example: Failure - servererror: - type: object - properties: - message: - type: string - example: Internal Server Error - status: - type: string - example: Failure - gatewaytimeout: - type: object - properties: - message: - type: string - example: Request Timeout - status: - type: string - example: Failure - inputfieldmissing: - type: object - properties: - message: - type: string - example: Input Field Missing - status: - type: string - example: Failure - inputlimitexceeded: - type: object - properties: - message: - type: string - example: Input Limit Exceeded - status: - type: string - example: Failure - versions: - type: object - properties: - v0.1.0: - type: array - items: - oneOf: - - type: string - example: Published Date - Jul 03,2020 - description: Initial version release - invalidinput: - type: object - properties: - message: - type: string - example: Invalid Input - status: - type: string - example: Failure - input: - type: object - required: - - model - - img_base64 - properties: - model: - x-name: model - type: string - default: true - example: sg-parliament-2019 - description: |+ - Model name. “sg-parliament-2019” is trained on Singapore Members of Parliament - 2019. - img_base64: - x-name: img_base64 - type: string - default: true - example: UklGRkbiBABXQVZFZm10IBAAAAABA... - description: |+ - Input image file in base64 format - file_type: - x-name: file_type - type: string - default: false - example: jpg - description: |+ - Type of image file. If not specified, the type of file is detected and processed. - - Refer to Python Imaging Library (PIL) for supported formats: bmp, gif, jpg/jpeg, png. - threshold: - x-name: threshold - type: float - format: float - default: false - example: 0.5 - description: |+ - 0.0 to 1.0. Default is 0.4. Higher threshold will return results with higher confidence. - - securitySchemes: - APIAuthorizer: - type: apiKey - name: x-api-key - in: header - x-amazon-apigateway-authtype: custom - description: Authentication is done using the x-api-key in the request header diff --git a/yaml/face_recognition_v1.0.yaml b/yaml/face_recognition_v1.0.yaml deleted file mode 100644 index f26455b36..000000000 --- a/yaml/face_recognition_v1.0.yaml +++ /dev/null @@ -1,358 +0,0 @@ -openapi: 3.0.1 -info: - title: Face Recognition - description: |+ - This Computer Vision microservice recognises faces of Singaporean and Japanese public figures (e.g. athletes, business leaders, celebrities, politicians, TV personalities, etc). - - This microservice returns the identity of the person, the bounding box in image coordinates, and the confidence of the prediction. Users can further filter the results by countries, profession or even down to the individual names. - - Help us grow this microservice! [Let us know](https://www.sentient.io/contact) which other public figures you would like us this microservice to also recognise (e.g. a new country or a new category). We will expand the capability of this microservices based on user feedback and demand. - version: '1.0.1' - x-additionalinfo: |+ - **Full List of Filters** - Users may choose to filter the output using any of these filters below. - - 1. Countries: - - Japan - - Singapore - - 2. Categories: - - Olympic_medalist - - Paralympic_competitors - - Paralympic_medalist - - athletes - - bloggers - - broadcast_news_analysts - - business_executives - - business_leaders - - celebrities - - chairmen_of_corporations - - chief_executives - - columnists - - female_pop_singers - - female_singers - - film_actors - - film_actresses - - film_directors - - film_people - - film_producers - - journalists - - male_pop_singers - - male_singers - - participants_in_reality_television_series - - people_of_interest - - photojournalists - - politicians - - pop_singers - - radio_people - - screenwriters - - singer-songwriters - - social_media_personalities - - sportsman - - television_actors - - television_actresses - - television_personalities - - television_presenters - - 3. Individual Names - If you happen to know the individual names of the faces you hope to recognise, you may also put in the individual names as a filter. - - **Suggested Use Cases** - - For solutions related to identifying the speaker for auto-tagging, or matching the transcription to a person that is a Singaporean politician, or a Singaporean/Japanese public figure. - - - x-subscribelink: face_recognition -servers: - - url: 'https://apis.sentient.io' -tags: -- name: "v1.0.1" - description: "Published Date - Jan 11, 2021" -paths: - /microservices/cv/facerecognition/v1/getpredictions: - post: - tags: - - v1.0.1 - responses: - '200': - description: success response - content: - application/json: - schema: - $ref: '#/components/schemas/success' - example: - results: - output: {conf: 0.6588699206768599,identity: "Lee Hsien Loong",location: [67,339,196,210]} - message: Successfully Processed - status: Success - '401': - description: Unauthorized - content: - application/json: - schema: - $ref: '#/components/schemas/unauthorized' - '402': - description: Payment Required - content: - application/json: - schema: - $ref: '#/components/schemas/paymentrequired' - '403': - description: Forbidden - content: - application/json: - schema: - $ref: '#/components/schemas/forbidden' - '404': - description: Not Found - content: - application/json: - schema: - $ref: '#/components/schemas/notfound' - '419': - description: Input Field Missing - content: - application/json: - schema: - $ref: '#/components/schemas/inputfieldmissing' - '413': - description: Input Limit Exceeded - content: - application/json: - schema: - $ref: '#/components/schemas/inputlimitexceeded' - '415': - description: Invalid Input - content: - application/json: - schema: - $ref: '#/components/schemas/invalidinput' - '500': - description: Internal Server Error - content: - application/json: - schema: - $ref: '#/components/schemas/servererror' - '504': - description: Gateway Timeout - content: - application/json: - schema: - $ref: '#/components/schemas/gatewaytimeout' - security: - - APIAuthorizer: [] - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/input' - required: true -components: - schemas: - success: - type: object - properties: - results: - type: object - description: The result of the API call. - example: { "" } - properties: - output: - type: array - example: {conf: 0.6588699206768599,identity: "Lee Hsien Loong",location: [67,339,196,210]} - description: Details of the face recognised from the image - items: - oneOf: - - type: object - properties: - conf: - type: number - format: float - example: 0.6588699206768599 - description: 0.0 to 1.0. Confidence score of identification. Higher is more confidence. - identity: - type: string - example: Lee Hsien Loong - description: Person's formal name. If identity is not known, "UNKNOWN" is returned - location: - type: array - example: [67,339,196,210] - description: bounding box of the face in pixel coordinates of top, right, bottom, left. - items: - oneOf: - - type: number - example: 67 - message: - type: string - example: Successfully Processed - description: Detail description on the API status - status: - type: string - example: Success - description: The status of the API call success/failure - - unauthorized: - type: object - properties: - message: - type: string - example: Missing Authentication Token - status: - type: string - example: Failure - restricted: - type: object - properties: - message: - type: string - example: The content is restricted - status: - type: string - example: Failure - forbidden: - type: object - properties: - message: - type: string - example: Access Denied Unauthorized User - status: - type: string - example: Failure - paymentrequired: - type: object - properties: - message: - type: string - example: Insufficient Credits Kindly Top Up - status: - type: string - example: Failure - notfound: - type: object - properties: - message: - type: string - example: Invalid Request - status: - type: string - example: Failure - servererror: - type: object - properties: - message: - type: string - example: Internal Server Error - status: - type: string - example: Failure - gatewaytimeout: - type: object - properties: - message: - type: string - example: Request Timeout - status: - type: string - example: Failure - inputfieldmissing: - type: object - properties: - message: - type: string - example: Input Field Missing - status: - type: string - example: Failure - inputlimitexceeded: - type: object - properties: - message: - type: string - example: Input Limit Exceeded - status: - type: string - example: Failure - invalidinput: - type: object - properties: - message: - type: string - example: Invalid Input - status: - type: string - example: Failure - versions: - type: object - properties: - v1.0.1: - type: array - items: - oneOf: - - type: string - example: Published Date - Jan 11, 2021 - description: Bug fix - Threshold value - v1.0.0: - type: array - items: - oneOf: - - type: string - example: Published Date - Dec 09, 2020 - description: Standardizing Output JSON and model update - - v0.1.0: - type: array - items: - oneOf: - - type: string - example: Published Date - Jul 03,2020 - description: Initial version release - input: - type: object - required: - - model - - image_base64 - properties: - image_base64: - x-name: image_base64 - type: string - default: true - example: UklGRkbiBABXQVZFZm10IBAAAAABA... - description: |+ - Input image file in base64 format. - file_type: - x-name: file_type - type: string - default: false - example: jpg - description: |+ - Type of image file. If not specified, the type of file is detected and processed. - - Refer to Python Imaging Library (PIL) for supported formats: bmp, gif, jpg/jpeg, png. - threshold: - x-name: threshold - type: integer - format: float - default: false - example: 0.5 - description: |+ - 0.0 to 1.0. Default is 0.4. Higher threshold will return results with higher confidence. - filter: - x-name: filter - type: array - default: false - example: ["japan", "television_actors"] - description: |+ - Optional filters that allows the user to refine the output. There are 3 types of filters: - - 1. Countries - e.g. "Singapore", "Japan" - 2. Professions - e.g. "atheletes", "pop_singers" - 3. Individual person names - e.g. "Lee Hsien Loong". Useful if the user only wants to detect for specific people. - - See "Additional Information" section for full list of available filters - - securitySchemes: - APIAuthorizer: - type: apiKey - name: x-api-key - in: header - x-amazon-apigateway-authtype: custom - description: Authentication is done using the x-api-key in the request header diff --git a/yaml/fitness_stations_and_playgrounds_hdb_sg.yaml b/yaml/fitness_stations_and_playgrounds_hdb_sg.yaml deleted file mode 100644 index 5dd69f4c5..000000000 --- a/yaml/fitness_stations_and_playgrounds_hdb_sg.yaml +++ /dev/null @@ -1,237 +0,0 @@ -openapi: 3.0.1 -info: - title: HDB Fitness Stations and Playgrounds (SG) - x-subscribelink: fitness_stations_and_playgrounds_hdb_sg - description: |+ - This Data microservice captures the indicative outline of fitness stations/playgrounds for all Housing Development Board of Singapore (HDB) Towns, HDB Estates and on HDB Land. The features were identified visually from high definition ortho-rectified aerial imagery (2014) and manually digitized. Objects largely obstructed by trees, structures and/or shadow are likely not captured in this dataset. The outlines of partially obstructed objects were extrapolated where possible and may not fully represent the actual shape of the actual object. - As this is a dataset download microservice, a successful call will return a pre-signed URL where the entire dataset can be downloaded as a CSV file. - The HDB POTH programme makes selected public and non-public datasets available to developers and companies to improve their service offerings to benefit the lives of Singapore citizens. Sentient.io is proud to partner with HDB to manage and facilitate the sharing of data for the POTH Programme. - x-additionalinfo: |+ - Suggested Use Cases: - - Real estate services - can be used as a background check solution to extract information related to the types and number of fitness stations/playgrounds present in an area for people buying or renting a HDB home. - - Download the complete dataset using a pre-signed URL. It's a two steps process. - - **Step 1:** Get the pre-signed URL - - Replace the correct x-api-key, and API endpoint - - > **curl -X GET -H "Content-Type: application/json" -H "x-api-key:XXXXX" ** - **Step 2:** Download file - - Using the results.url (i.e) the pre-signed URL to download the dataset - - > **curl --request GET "results.url" >> "FILE_NAME"** - - **Data schema** - - | Name | Type | Size | Description | - |---|---|---|---|---| - | FEATID | Integer | N/A | Feature ID. Unique running number. | - | TYPE | Char | N/A | Captures the type of object. | - | LVL | Char | N/A | Captures whether the object is located at Ground level or Above Ground level. | - | QUALITY | Char | N/A | Captures whether the section of the feature was Fully Visible or Partially Visible. | - | INC_CRC | Varchar | 50 | Sub Location Id | - | FMEL_UPD_D | Datetime | N/A | Date Updated | - | Shape__Area | Float | N/A | Area of the feature | - | Shape__Length | Float | N/A | Length of the feature | - - version: '0.1.0' -servers: - - url: 'https://api.sentient.io' -tags: -- name: "v0.1.0" - description: "Published Date - Mar 24, 2020" -paths: - /DaaS/prod/hdb/amenities/gs/csv/fitnessstationplaygrnd/hdb: - get: - tags: - - v0.1.0 - responses: - '200': - description: success response - content: - application/json: - schema: - $ref: '#/components/schemas/success' - example: - results: - url: "" - status: Success - message: Successfully Processed - '401': - description: Unauthorized - content: - application/json: - schema: - $ref: '#/components/schemas/unauthorized' - '402': - description: Payment Required - content: - application/json: - schema: - $ref: '#/components/schemas/paymentrequired' - '403': - description: Forbidden - content: - application/json: - schema: - $ref: '#/components/schemas/forbidden' - '404': - description: Not Found - content: - application/json: - schema: - $ref: '#/components/schemas/notfound' - '419': - description: Input Field Missing - content: - application/json: - schema: - $ref: '#/components/schemas/inputfieldmissing' - '413': - description: Input Limit Exceeded - content: - application/json: - schema: - $ref: '#/components/schemas/inputlimitexceeded' - '415': - description: Invalid Input - content: - application/json: - schema: - $ref: '#/components/schemas/invalidinput' - '500': - description: Internal Server Error - content: - application/json: - schema: - $ref: '#/components/schemas/servererror' - '504': - description: Gateway Timeout - content: - application/json: - schema: - $ref: '#/components/schemas/gatewaytimeout' - security: - - APIAuthorizer: [] -components: - schemas: - success: - type: object - properties: - results: - type: object - example: { "" } - description: Json Object of returned results - properties: - url: - type: string - description: pre-signed URL to download the file - example: "" - status: - type: string - example: Success - description: The status of the API call. success/failure - message: - type: string - example: Successfully Processed - description: Detail description on the api status - unauthorized: - type: object - properties: - message: - type: string - example: Missing Authentication Token - status: - type: string - example: Failure - forbidden: - type: object - properties: - message: - type: string - example: Access Denied Unauthorized User - status: - type: string - example: Failure - paymentrequired: - type: object - properties: - message: - type: string - example: Insufficient Credits Kindly Top Up - status: - type: string - example: Failure - notfound: - type: object - properties: - message: - type: string - example: Invalid Request URL - status: - type: string - example: Failure - servererror: - type: object - properties: - message: - type: string - example: Internal Server Error - status: - type: string - example: Failure - gatewaytimeout: - type: object - properties: - message: - type: string - example: Request Timeout - status: - type: string - example: Failure - inputfieldmissing: - type: object - properties: - message: - type: string - example: Input Field Missing - status: - type: string - example: Failure - inputlimitexceeded: - type: object - properties: - message: - type: string - example: Input Limit Exceeded - status: - type: string - example: Failure - invalidinput: - type: object - properties: - message: - type: string - example: Invalid Input - status: - type: string - example: Failure - versions: - type: object - properties: - v0.1.0: - type: array - items: - oneOf: - - type: string - example: Published Date - Mar 24, 2020 - description: Initial version release - securitySchemes: - APIAuthorizer: - type: apiKey - name: x-api-key - in: header - x-amazon-apigateway-authtype: custom - description: Authentication is done using the x-api-key in the request header. diff --git a/yaml/flat_ownership_hdb_sg.yaml b/yaml/flat_ownership_hdb_sg.yaml deleted file mode 100644 index 0961fd126..000000000 --- a/yaml/flat_ownership_hdb_sg.yaml +++ /dev/null @@ -1,449 +0,0 @@ -openapi: 3.0.1 -info: - title: HDB Flat Ownership Duration (SG) - x-subscribelink: flat_ownership_hdb_sg - description: |+ - This Data microservice returns information on flat ownership within Housing Development Board of Singapore (HDB) estates and includes the location address, postal code, length of ownership and their quantity in units.The HDB POTH programme makes selected public and non-public datasets available to developers and companies to improve their service offerings to benefit the lives of Singapore citizens. Sentient.io is proud to partner with HDB to manage and facilitate the sharing of data for the POTH Programme." - - **Note:** As this microservice uses the GET method, developers using this microservice must remember to have their app encode all the input values to be URL friendly (i.e. all spaces and special characters must be replaced). Here’s a reference on [URL encoding](https://www.w3schools.com/tags/ref_urlencode.ASP). - - x-additionalinfo : |+ - Suggested Use Cases: - - Real estate services - for example, this microservice can be used for services that are related to HDB ownership transfer (i.e. when one transfer, include, withdraw and/or substitute owners for a flat), such as when drafting up related legal documents. - - **Refining queries in the filterdata field using filter types and match types** - The filterdata fields use elasticsearch’s syntax (specifically filter types and match types) to help further refine search results and provide greater flexibility in structuring more sophisticated queries. - - **Filter Types:** - A filter type is a logic operator to which the search results must fulfill certain logical conditions to be returned. The supported match types are: - - * **must** - All of the stated conditions must match. Equivalent to an AND operator. - - > {"must":[{"match_phrase":{"street":"serangoon north avenue 4"}}]} - - * **must_not** - All of the stated conditions must not match. Equivalent to a NOT operator. - > {"must_not":[{"match":{"postalcode":"570251"}}]} - - * **should** - At least one of the stated conditions should match. Equivalent to an OR operator. - > {"should":[{"match_phrase":{"street":"serangoon north avenue 4"}}]} - - * **filter** - All of the stated conditions that must match. However, results are not scored unlike the other filter types which returns results based on how well the conditions are met. - > {"filter":[{"match":{"street":"serangoon"}}]} - - For a more detailed guide on filter types, [refer to this](https://www.elastic.co/guide/en/elasticsearch/reference/6.8/query-dsl-bool-query.html). - - Filter types cannot be used alone and must be used in conjunction with a match type to complete the query. - **Match Types:** - A match type is a match operator nested within a filter type that fine-tunes the matching condition of the text search. The supported match types are: - - * **match** - Search within a full text field for a single word - - > {"match":{"street":"serangoon"}} - - * **match_phrase** - Search within a full text field - - > {"match_phrase":{"street":"serangoon central"}} - - * **match_phrase_prefix** - Search within a full text field with prefix - - > {"match_phrase_prefix":{"street":"serangoon central"}} - - * **term** - Returns results that contain an exact term in a provided field - - > {"term":{"postalcode":"560720"}} - * **terms** - Returns results that contain one or more exact terms in a provided field - - > {"terms":{"postalcode":["560720","560721"]}} - - * **range** - Returns results that contain terms within a stipulated range - - > {"range":{"no_of_units":{"gte":10}}} - > {"range":{"no_of_units":{"lte":50}}} - > {"range":{"no_of_units":{"gte":10,"lte":50}}} - - * **exists** - Returns results that contain any indexed value for a field - - > {"exists":{ "field": "postalcode"}} - - For a more detailed guide to match types, [refer to this](https://www.elastic.co/guide/en/elasticsearch/reference/7.9/term-level-queries.html). - - **Forming sophisticated queries using combinations of filter types (in JSON)** - Multiple filter types can be combined together in one query (written in JSON format) to form a very sophisticated query. Here’s one example below: - - > { - > "must":[{"match_phrase":{"street":"serangoon+central"}}], - > "filter":[{"match":{"postalcode":"550209"}}], - > "should":[{"range":{"no_of_units":{"gte":10}}}], - > "must_not":[{"match":{"len_of_ownership_id":"5"}}] - > } - - **Sample Queries Based on Use Cases** - - 1. **Search for all blocks with duration of ownership equal to or exceeding 10 years in Ang Mo Kio.** - - Using a filterdata only: - - > filterdata = {"filter":[{"match":{"street":"ang mo kio"}},{"match":{"len_of_ownership_id":"1"}}]} - - version: '0.1.0' -servers: - - url: 'https://api.sentient.io' -tags: -- name: "v0.1.0" - description: "Published Date - May 15, 2020" -paths: - /DaaS/prod/hdb/ownership: - get: - tags: - - v0.1.0 - parameters: - - in: query - name: querystring - schema: - type: string - description: |+ - Simple keyword search for matches in all searchable fields. Keywords separated by spaces will return results containing any of those keywords. For exact phrase match, put entire phrase in double quotes (" "). - - If this field is set to null, by default the microservice will return all units (within the stated limit), which can be further refined through the filterdata field for more sophisticated queries. - - example: "serangoon" - default: false - - in: query - name: offset - schema: - type: integer - description: The offset of the record list ie the starting index - example: "0" - default: false - - in: query - name: limit - schema: - type: integer - description: The max records to return for the request. Default - 10, Max - 10000 - example: "10" - default: false - - in: query - name: filterdata - schema: - type: string - description: |+ - Refine the search further on any of the possible through the 4 filter types : - * must - * must_not - * should - * filter - default: false - example: |+ - {"must":[{"match_phrase":{"street":"serangoon+central"}}],"filter":[{"match":{"postalcode":"550209"}}],"should":[{"range":{"no_of_units":{"gte":10}}}],"must_not":[{"match":{"len_of_ownership_id":"5"}}]} - responses: - '200': - description: success response - content: - application/json: - schema: - $ref: '#/components/schemas/success' - example: - results: - total: 986 - max_score: 17.995623 - hits: - - _index: sentient_durationofownership_hdb_index - _type: dir_doc - _id: 050533/40} - description: Json Object of returned results - properties: - total: - type: number - example: 986 - description: Total number of records - max_score: - type: number - example: 17.995623 - description: The highest score value - hits: - type: array - example: [{} - description: Json Object of returned hits - properties: - postalcode: - type: string - description: Postal code of a block - example: "560720" - len_of_ownership: - type: string - description: Range of length - example: "40 < t <= 50" - len_of_ownership_id: - type: number - description: |+ - Length Types - 1 (t <= 10) - 2 (10 < t <= 20) - 3 (20 < t <= 30) - 4 (30 < t <= 40) - 5 (40 < t <= 50) - 6 (t > 50) - - example: "5" - no_of_units: - type: number - description: Ownership units - example: "29" - block: - type: string - description: Address block - example: "533" - street: - type: string - description: Street Address or building name - example: "upper cross street" - xcoord: - type: string - description: SVY21 X coordinates - example: 29520.58 - ycoord: - type: string - description: SVY21 Y coordinates - example: 39311.68 - address: - type: string - description: Building full address - example: "533 upper cross street" - createddate: - type: string - description: Record first release date on sentient - example: "2020-04-23" - lastupdated: - type: string - description: Record last updated date on sentient - example: "2020-04-23" - location: - type: object - description: WGS84 coordinates lat/long - example: {"lat":1.37179535,"lon":103.8469821} - properties: - lat: - type: string - description: WGS84 latitude - example: 1.37179535 - lon: - type: string - description: WGS84 longitude - example: 103.8469821 - source: - type: string - description: Dataset source - example: hdb - message: - type: string - example: Successfully Processed - description: The detail description on the status - status: - type: string - example: Success - description: The status of the API call Success/Failure - unauthorized: - type: object - properties: - message: - type: string - example: Missing Authentication Token - status: - type: string - example: Failure - forbidden: - type: object - properties: - message: - type: string - example: Access Denied Unauthorized User - status: - type: string - example: Failure - paymentrequired: - type: object - properties: - message: - type: string - example: Insufficient Credits Kindly Top Up - status: - type: string - example: Failure - notfound: - type: object - properties: - message: - type: string - example: Invalid Request URL - status: - type: string - example: Failure - servererror: - type: object - properties: - message: - type: string - example: Internal Server Error - status: - type: string - example: Failure - gatewaytimeout: - type: object - properties: - message: - type: string - example: Request Timeout - status: - type: string - example: Failure - inputfieldmissing: - type: object - properties: - message: - type: string - example: Input Field Missing - status: - type: string - example: Failure - inputlimitexceeded: - type: object - properties: - message: - type: string - example: Input Limit Exceeded - status: - type: string - example: Failure - invalidinput: - type: object - properties: - message: - type: string - example: Invalid Input - status: - type: string - example: Failure - versions: - type: object - properties: - v0.1.0: - type: array - items: - oneOf: - - type: string - example: Published Date - May 15,2020 - description: Initial version release - securitySchemes: - APIAuthorizer: - type: apiKey - name: x-api-key - in: header - x-amazon-apigateway-authtype: custom - description: Authentication is done using the x-api-key in the request header. - diff --git a/yaml/index.yaml b/yaml/index.yaml deleted file mode 100644 index a076a26aa..000000000 --- a/yaml/index.yaml +++ /dev/null @@ -1,255 +0,0 @@ -Voice: - Automatic Speech Recognition ENG (SG): - title: automatic_speech_recognition_eng_sg - versions: - v1.0: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/automatic_speech_recognition_eng_sg_v1.0.yaml" - v0.1: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/automatic_speech_recognition_eng_sg.yaml" - Automatic Speech Recognition CHI (SG): - title: automatic_speech_recognition_chi_sg - versions: - v0.1: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/automatic_speech_recognition_chi_sg.yaml" - Online Automatic Speech Recognition ENG (SG): - title: online_automatic_speech_recognition_eng_sg - versions: - v0.1: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/online_automatic_speech_recognition_eng_sg.yaml" - Online Command Automatic Speech Recognition ENG (SG): - title: online_command_automatic_speech_recognition_eng_sg - versions: - v0.1: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/online_command_automatic_speech_recognition_eng_sg.yaml" - Text-To-Speech ENG: - title: text-to-speech_eng - versions: - v0.1: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/text-to-speech_eng.yaml" - Text-To-Speech CHI: - title: text-to-speech_chi - versions: - v0.1: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/text-to-speech_chi.yaml" - ASR with Voice Activity Detection ENG (SG): - title: asr_with_voice_activity_detection_eng_sg - versions: - v1.0: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/asr_with_voice_activity_detection_eng_sg_v1.0.yaml" - v0.1: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/asr_with_voice_activity_detection_eng_sg.yaml" - Voice Activity Detection ENG: - title: voice_activity_detection_eng - versions: - v1.0: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/voice_activity_detection_eng_v1.0.yaml" - v0.1: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/voice_activity_detection_eng.yaml" -NLP: - Inverse Text Normalisation ENG: - title: inverse_text_normalisation_eng - versions: - v1.0: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/inverse_text_normalisation_eng_v1.0.yaml" - v0.1: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/inverse_text_normalisation_eng.yaml" - Named-Entity Recognition ENG: - title: named-entity_recognition_eng - versions: - v1.0: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/named-entity_recognition_eng_v1.0.yaml" - v0.1: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/named-entity_recognition_eng.yaml" - spaCy NER: - title: spacy_ner - versions: - v0.1: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/spacy_named-entity_recognition_eng.yaml" - Page Profiler ENG: - title: page_profiler_eng - versions: - v2.1: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/page_profiler_eng_v2.1.yaml" - Page Profiler JP: - title: page_profiler_jp - versions: - v1.0: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/page_profiler_jp.yaml" - Page Profiler THAI: - title: page_profiler_thai - versions: - v1.0: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/page_profiler_thai.yaml" - Taxonomy Matcher ENG: - title: taxonomy_matcher_eng - versions: - v1.0: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/taxonomy_matcher_eng_v1.0.yaml" - v0.1: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/taxonomy_matcher_eng.yaml" - Word Sense Disambiguation ENG: - title: word_sense_disambiguation_eng - versions: - v1.0: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/word_sense_disambiguation_eng_v1.0.yaml" - v0.1: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/word_sense_disambiguation_eng.yaml" - Named-Entity Recognition JP: - title: named-entity_recognition_jp - versions: - v1.0: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/named-entity_recognition_jp_v1.0.yaml" - v0.1: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/named-entity_recognition_jp.yaml" - Named Entity Recognition THAI: - title: named-entity_recognition_thai - versions: - v1.0: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/named-entity_recognition_thai_v1.0.yaml" - v0.1: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/named-entity_recognition_thai.yaml" - Script Alignment: - title: script_alignment - versions: - v1.0: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/script_alignment_v1.0.yaml" - v0.1: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/script_alignment.yaml" -Computer Vision: - Object Detection: - title: object_detection - versions: - v0.1: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/object_detection.yaml" - Face Recognition: - title: face_recognition - versions: - v1.0: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/face_recognition_v1.0.yaml" - v0.1: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/face_recognition_politicians_sg.yaml" - People Counting: - title: people_counting - versions: - v0.1: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/people_counting.yaml" - Landmark Detection (SG): - title: landmark_detection_sg - versions: - v0.1: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/landmark_detection_sg.yaml" - Landmark Detection (JP): - title: landmark_detection_jp - versions: - v0.1: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/landmark_detection_jp.yaml" - Demographics Classification: - title: demographics_classification - versions: - v0.1: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/demographics_classification.yaml" -Utility: - Youtube Video Downloader: - title: youtube_video_downloader - versions: - v0.1: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/youtube_video_downloader.yaml" - Video-To-Audio Convertor: - title: video-to-audio_convertor - versions: - v0.1: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/video-to-audio_convertor.yaml" - Web Scraper: - title: web_scraper - versions: - v1.1: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/web_scraper.yaml" - Document Convertor ENG: - title: document_convertor_eng - versions: - v1.0: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/document_convertor_eng.yaml" - PDF Extractor: - title: pdf_extractor - versions: - v1.0: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/pdf_extractor.yaml" - PKI Key Generator: - title: pki_key_generator - versions: - v0.1: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/pki_key_generator.yaml" - Encryption using PKI Key: - title: encryption_using_pki_key - versions: - v0.1: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/encryption_using_pki_key.yaml" - Decryption using PKI Key: - title: decryption_using_pki_key - versions: - v0.1: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/decryption_using_pki_key.yaml" - Wikipedia Retrieval: - title: wikipedia_retrieval - versions: - v1.0: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/wikipedia_retrieval_v1.0.yaml" - v0.1: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/wikipedia_retrieval.yaml" - JSON-CSV Convertor: - title: json-csv_convertor - versions: - v1.0: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/json-csv_convertor.yaml" - CSV-JSON Convertor: - title: csv-json_convertor - versions: - v1.0: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/csv-json_convertor.yaml" - Audio Format Convertor: - title: audio_format_convertor - versions: - v0.1: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/audio_format_convertor.yaml" - Video-to-Image Convertor: - title: video-to-image_convertor - versions: - v0.1: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/video-to-image_convertor.yaml" - Newspaper Article Scraper: - title: newspaper_article_scraper - versions: - v0.1: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/newspaper_article_scraper.yaml" - URLs Retrieval: - title: urls_retrieval - versions: - v0.2: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/urls_retrieval.yaml" - Base64 Encoder: - title: base64_encoder - versions: - v0.1: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/base64-encoder.yaml" - Base64 Decoder: - title: base64_decoder - versions: - v0.1: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/base64-decoder.yaml" -Data: - HDB Commercial Directories (SG): - title: commercial_directories_hdb_sg - versions: - v0.1: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/commercial_directories_hdb_sg.yaml" - HDB Block Coordinates (SG): - title: building_addresses_hdb_sg - versions: - v0.1: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/building_addresses_hdb_sg.yaml" - HDB Residential Occupancy Status (SG): - title: residential_sales_and_rental_hdb_sg - versions: - v0.1: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/residential_sales_and_rental_hdb_sg.yaml" - HDB Carpark Locations (SG): - title: carpark_hdb_sg - versions: - v0.2: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/carpark_hdb_sg.yaml" - HDB Demographics (SG): - title: demographics_hdb_sg - versions: - v0.1: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/demographics_hdb_sg.yaml" - HDB Flat Ownership Duration (SG): - title: flat_ownership_hdb_sg - versions: - v0.1: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/flat_ownership_hdb_sg.yaml" - HDB Season Parking Availability (SG): - title: season_parking_availability_hdb_sg - versions: - v0.1: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/season_parking_availability_hdb_sg.yaml" - Directory of Singapore Startups: - title: directory_of_singapore_startups - versions: - v0.1: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/directory_of_singapore_startups.yaml" - HDB Fitness Stations and Playgrounds (SG): - title: fitness_stations_and_playgrounds_hdb_sg - versions: - v0.1: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/fitness_stations_and_playgrounds_hdb_sg.yaml" - HDB Lamp Posts Locations (SG): - title: amenities_lamp_posts_hdb_sg - versions: - v0.1: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/amenities_lamp_posts_hdb_sg.yaml" - HDB Hardcourts Locations (SG): - title: amenities_hardcourts_hdb_sg - versions: - v0.1: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/amenities_hardcourts_hdb_sg.yaml" - HDB Shelters Locations (SG): - title: amenities_shelters_hdb_sg - versions: - v0.1: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/amenities_shelters_hdb_sg.yaml" - D&B Business Check Plus (SG): - title: d&b_business_check_plus_sg - versions: - v0.1: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/d&b_business_check_plus_sg.yaml" - D&B Basic Individual Search (SG): - title: d&b_basic_individual_search_sg - versions: - v0.1: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/d&b_basic_individual_search_sg.yaml" - D&B Business Check (SG): - title: d&b_business_check_sg - versions: - v0.1: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/d&b_business_check_sg.yaml" - D&B Brief Financial Information (SG): - title: d&b_brief_financial_information_sg - versions: - v0.1: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/d&b_brief_financial_information_sg.yaml" -Data Alliance: - Download Dataset API: - title: download_dataset_api - urlkey: download_dataset_api - versions: - v0.1: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/download_dataset.yaml" diff --git a/yaml/inverse_text_normalisation_eng.yaml b/yaml/inverse_text_normalisation_eng.yaml deleted file mode 100644 index 10520a858..000000000 --- a/yaml/inverse_text_normalisation_eng.yaml +++ /dev/null @@ -1,228 +0,0 @@ -openapi: 3.0.1 -info: - title: Inverse Text Normalisation ENG - description: |+ - This NLP microservice recovers missing punctuations such as full stop, comma, exclamation mark, and question mark from the input text. - - This NLP microservice also converts pre-defined abbreviations from lower case to upper case. - - This NLP microservice also converts first letters of sentences to upper case. - x-additionalinfo: |+ - Suggested Use Cases: - - Can be integrated into services or apps that offer digital writing assistance to make writing clear and effective. - version: '0.1.0' - x-subscribelink: inverse_text_normalisation_eng -servers: - - url: 'https://apis.sentient.io' -tags: -- name: "v0.1.0" - description: "Published Date - Mar 24, 2020" -paths: - /microservices/nlp/inversenorm/v0.1/getpredictions: - post: - tags: - - v0.1.0 - responses: - '200': - description: success response - content: - application/json: - schema: - $ref: '#/components/schemas/success' - example: - '0': |+ - Apple said, the project-financing fund was the 1 of its kind, real estate developers, - often secure bonds for affordable housing development, but must service the debt - during construction, until the houses are built and start to generate revenue, apple - and state officials hope to provide bridge financing during construction at rates - below those from commercial lenders. - '1': |+ - The $2000000000 in funding will be deployable across NTU while the remaining - 5500000000 will go toward efforts specific to apple's home region in northern california, - where fast-growing tech companies have drawn protests from residents who blame them - for rising, housing costs. - '401': - description: Unauthorized - content: - application/json: - schema: - $ref: '#/components/schemas/unauthorized' - '402': - description: Payment Required - content: - application/json: - schema: - $ref: '#/components/schemas/paymentrequired' - '403': - description: Forbidden - content: - application/json: - schema: - $ref: '#/components/schemas/forbidden' - '404': - description: Not Found - content: - application/json: - schema: - $ref: '#/components/schemas/notfound' - '419': - description: Input Field Missing - content: - application/json: - schema: - $ref: '#/components/schemas/inputfieldmissing' - '413': - description: Input Limit Exceeded - content: - application/json: - schema: - $ref: '#/components/schemas/inputlimitexceeded' - '415': - description: Invalid Input - content: - application/json: - schema: - $ref: '#/components/schemas/invalidinput' - '500': - description: Internal Server Error - content: - application/json: - schema: - $ref: '#/components/schemas/servererror' - '504': - description: Gateway Timeout - content: - application/json: - schema: - $ref: '#/components/schemas/gatewaytimeout' - security: - - APIAuthorizer: [] - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/input' - required: true -components: - schemas: - success: - type: object - properties: - : - type: string - example: { 0: Apple said, the project-financing fund was the 1 of its kind, real estate developers, often secure bonds for affordable housing development, but must service the debt during construction, until the houses are built and start to generate revenue, apple and state officials hope to provide bridge financing during construction at rates below those from commercial lenders.} - description: Order sequence number - unauthorized: - type: object - properties: - message: - type: string - example: Missing Authentication Token - status: - type: string - example: Failure - forbidden: - type: object - properties: - message: - type: string - example: Access Denied Unauthorized User - status: - type: string - example: Failure - paymentrequired: - type: object - properties: - message: - type: string - example: Insufficient Credits Kindly Top Up - status: - type: string - example: Failure - notfound: - type: object - properties: - message: - type: string - example: Invalid Request URL - status: - type: string - example: Failure - servererror: - type: object - properties: - message: - type: string - example: Internal Server Error - status: - type: string - example: Failure - gatewaytimeout: - type: object - properties: - message: - type: string - example: Request Timeout - status: - type: string - example: Failure - inputfieldmissing: - type: object - properties: - message: - type: string - example: Input Field Missing - status: - type: string - example: Failure - inputlimitexceeded: - type: object - properties: - message: - type: string - example: Input Limit Exceeded - status: - type: string - example: Failure - invalidinput: - type: object - properties: - message: - type: string - example: Invalid Input - status: - type: string - example: Failure - versions: - type: object - properties: - v0.1.0: - type: array - items: - oneOf: - - type: string - example: Published Date - Mar 24, 2020 - description: Initial version release - input: - type: array - required: - - text - items: - type: object - properties: - text: - x-name: text - type: string - default: true - example: Apple said the project-financing fund was the first of its kind Real estate developers often secure bonds for affordable housing development but must service the debt during construction until the houses are built and start to generate revenue Apple and state officials hope to provide bridge financing during construction at rates below those from commercial lenders - description: |+ - Input text. - - Supported formats: ASCII only - securitySchemes: - APIAuthorizer: - type: apiKey - name: x-api-key - in: header - x-amazon-apigateway-authtype: custom - description: Authentication is done using the x-api-key in the request header diff --git a/yaml/inverse_text_normalisation_eng_v1.0.yaml b/yaml/inverse_text_normalisation_eng_v1.0.yaml deleted file mode 100644 index 63e1e1e8b..000000000 --- a/yaml/inverse_text_normalisation_eng_v1.0.yaml +++ /dev/null @@ -1,248 +0,0 @@ -openapi: 3.0.1 -info: - title: Inverse Text Normalisation ENG - description: |+ - This NLP microservice recovers the missing punctuations such as full stop, comma, exclamation mark, and question mark from the input text. - - It converts pre-defined abbreviations from lower case to upper case and also first letters of sentences to upper case. - - Do ensure that your text is within **5000 characters**. - version: '1.0.0' - x-additionalinfo: |+ - Suggested Use Cases: - - Can be integrated into services or apps that offer digital writing assistance to make writing clear and effective. - x-subscribelink: inverse_text_normalisation_eng -servers: - - url: 'https://apis.sentient.io' -tags: -- name: "v1.0.0" - description: "Published Date - Oct 30, 2020" -paths: - /microservices/nlp/inversenorm/v1/getpredictions: - post: - tags: - - v1.0.0 - responses: - '200': - description: success response - content: - application/json: - schema: - $ref: '#/components/schemas/success' - example: - results: - '0': |+ - Apple said, the project-financing fund was the 1 of its kind, real estate developers, - often secure bonds for affordable housing development, but must service the debt - during construction, until the houses are built and start to generate revenue, apple - and state officials hope to provide bridge financing during construction at rates - below those from commercial lenders. - '1': |+ - The $2000000000 in funding will be deployable across NTU while the remaining - 5500000000 will go toward efforts specific to apple's home region in northern california, - where fast-growing tech companies have drawn protests from residents who blame them - for rising, housing costs. - message: Successfully Processed - status: Success - '401': - description: Unauthorized - content: - application/json: - schema: - $ref: '#/components/schemas/unauthorized' - '402': - description: Payment Required - content: - application/json: - schema: - $ref: '#/components/schemas/paymentrequired' - '403': - description: Forbidden - content: - application/json: - schema: - $ref: '#/components/schemas/forbidden' - '404': - description: Not Found - content: - application/json: - schema: - $ref: '#/components/schemas/notfound' - '419': - description: Input Field Missing - content: - application/json: - schema: - $ref: '#/components/schemas/inputfieldmissing' - '413': - description: Input Limit Exceeded - content: - application/json: - schema: - $ref: '#/components/schemas/inputlimitexceeded' - '415': - description: Invalid Input - content: - application/json: - schema: - $ref: '#/components/schemas/invalidinput' - '500': - description: Internal Server Error - content: - application/json: - schema: - $ref: '#/components/schemas/servererror' - '504': - description: Gateway Timeout - content: - application/json: - schema: - $ref: '#/components/schemas/gatewaytimeout' - security: - - APIAuthorizer: [] - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/input' - required: true -components: - schemas: - success: - type: object - properties: - results: - type: object - description: The result of the API call. - example: { "" } - properties: - : - x-name: - type: string - example: { 0: Apple said, the project-financing fund was the 1 of its kind, real estate developers, often secure bonds for affordable housing development, but must service the debt during construction, until the houses are built and start to generate revenue, apple and state officials hope to provide bridge financing during construction at rates below those from commercial lenders.} - description: Order sequence number - message: - type: string - example: Successfully Processed - description: Detail description on the API status - status: - type: string - example: Success - description: The status of the API call success/failure - unauthorized: - type: object - properties: - message: - type: string - example: Missing Authentication Token - status: - type: string - example: Failure - forbidden: - type: object - properties: - message: - type: string - example: Access Denied Unauthorized User - status: - type: string - example: Failure - paymentrequired: - type: object - properties: - message: - type: string - example: Insufficient Credits Kindly Top Up - status: - type: string - example: Failure - notfound: - type: object - properties: - message: - type: string - example: Invalid Request URL - status: - type: string - example: Failure - servererror: - type: object - properties: - message: - type: string - example: Internal Server Error - status: - type: string - example: Failure - gatewaytimeout: - type: object - properties: - message: - type: string - example: Request Timeout - status: - type: string - example: Failure - inputfieldmissing: - type: object - properties: - message: - type: string - example: Input Field Missing - status: - type: string - example: Failure - inputlimitexceeded: - type: object - properties: - message: - type: string - example: Input Limit Exceeded - status: - type: string - example: Failure - invalidinput: - type: object - properties: - message: - type: string - example: Invalid Input - status: - type: string - example: Failure - versions: - type: object - properties: - v1.0.0: - type: array - items: - oneOf: - - type: string - example: Published Date - Oct 30,2020 - description: Standardizing Output JSON - v0.1.0: - type: array - items: - oneOf: - - type: string - example: Published Date - Mar 24, 2020 - description: Initial version release - input: - type: object - required: - - text - properties: - text: - x-name: text - type: string - default: true - example: Apple said the project-financing fund was the first of its kind Real estate developers often secure bonds for affordable housing development but must service the debt during construction until the houses are built and start to generate revenue Apple and state officials hope to provide bridge financing during construction at rates below those from commercial lenders - description: |+ - Input text - securitySchemes: - APIAuthorizer: - type: apiKey - name: x-api-key - in: header - x-amazon-apigateway-authtype: custom - description: Authentication is done using the x-api-key in the request header diff --git a/yaml/json-csv_convertor.yaml b/yaml/json-csv_convertor.yaml deleted file mode 100644 index bd89410b6..000000000 --- a/yaml/json-csv_convertor.yaml +++ /dev/null @@ -1,233 +0,0 @@ -openapi: 3.0.1 -info: - title: JSON-CSV Convertor - description: |+ - This Utility microservice converts the input JSON (json string or json file) to CSV format. - x-additionalinfo: |+ - Suggested Use Cases: - - For users who would like to combine data into useful spreadsheets for others to analyze, update, or refer to. This microservice can convert a collection of JSON into CSV spreadsheets like Google Sheets or Excel to analyze data without programming. - version: '1.0.0' - x-subscribelink: json-csv_convertor -servers: - - url: 'https://apis.sentient.io' -tags: -- name: "v1.0.0" - description: "Published Date - May 15, 2020" -paths: - /microservices/utility/jsontocsv/v1.0/getresults: - post: - tags: - - v1.0.0 - responses: - '200': - description: success response - content: - application/json: - schema: - $ref: '#/components/schemas/success' - example: - results: - url: https://storage.googleapis.com/json_csv_stroage/data_file.csv?X-Goog-Algorithm=GOOG4-RSA-SHA256&X-Goog-Credential=sentient-dev-bigquery%40sentient-207310.iam.gserviceaccount.com%2F20200514%2Fauto%2Fstorage%2Fgoog4_request&X-Goog-Date=20200514T062642Z&X-Goog-Expires=6000&X-Goog-SignedHeaders=host&X-Goog-Signature=4141536f1982dfb26a49c8764517a8147db31ed658aabe36715fe253588c073415bc813be245311cd701462da4d9bd8c07bc587127fea062e00eaf1a30db42a932ef458fae561969bf3d8c614d0c10a993590387a9f8587b8ed48925d8ef8eeed2a7e6ba09049a7a466c4d6204feccedb56dd05ea47d0acd8dcd9517c6b94613f69af7bf5dacf68da3911713da781ee81bc5e0821f507a658cab3f4910f4997462c1fdd612940d088d32c07218ab40ccf3b30af752eab47ae715a354aeb5497cc6470d46b0fbb2db49b2f76535f85b99f758162ed46809a206c2760f39c5c72fc084ec007a5444ccb99a0a3466542d673a326b3290ffa5271fbf3348e99f9926" - status: Success - message: Successfully Converted and stored in Google Cloud Storage - '401': - description: Unauthorized - content: - application/json: - schema: - $ref: '#/components/schemas/unauthorized' - '402': - description: Payment Required - content: - application/json: - schema: - $ref: '#/components/schemas/paymentrequired' - '403': - description: Forbidden - content: - application/json: - schema: - $ref: '#/components/schemas/forbidden' - '404': - description: Not Found - content: - application/json: - schema: - $ref: '#/components/schemas/notfound' - '419': - description: Input Field Missing - content: - application/json: - schema: - $ref: '#/components/schemas/inputfieldmissing' - '413': - description: Input Limit Exceeded - content: - application/json: - schema: - $ref: '#/components/schemas/inputlimitexceeded' - '415': - description: Invalid Input - content: - application/json: - schema: - $ref: '#/components/schemas/invalidinput' - '500': - description: Internal Server Error - content: - application/json: - schema: - $ref: '#/components/schemas/servererror' - '504': - description: Gateway Timeout - content: - application/json: - schema: - $ref: '#/components/schemas/gatewaytimeout' - security: - - APIAuthorizer: [] - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/input' - multipart/form-data: - schema: - $ref: '#/components/schemas/input1' -components: - schemas: - success: - type: object - properties: - results: - type: object - example: [{key:value}] - description: list of json objects - properties: - url: - type: string - description: Pre-signed URL to download the csvfile - example: https://storage.googleapis.com/json_csv_stroage/data_file.csv?X-Goog-Algorithm=GOOG4-RSA-SHA256&X-Goog-Credential=sentient-dev-bigquery%40sentient-207310.iam.gserviceaccount.com%2F20200514%2Fauto%2Fstorage%2Fgoog4_request&X-Goog-Date=20200514T062642Z&X-Goog-Expires=6000&X-Goog-SignedHeaders=host&X-Goog-Signature=4141536f1982dfb26a49c8764517a8147db31ed658aabe36715fe253588c073415bc813be245311cd701462da4d9bd8c07bc587127fea062e00eaf1a30db42a932ef458fae561969bf3d8c614d0c10a993590387a9f8587b8ed48925d8ef8eeed2a7e6ba09049a7a466c4d6204feccedb56dd05ea47d0acd8dcd9517c6b94613f69af7bf5dacf68da3911713da781ee81bc5e0821f507a658cab3f4910f4997462c1fdd612940d088d32c07218ab40ccf3b30af752eab47ae715a354aeb5497cc6470d46b0fbb2db49b2f76535f85b99f758162ed46809a206c2760f39c5c72fc084ec007a5444ccb99a0a3466542d673a326b3290ffa5271fbf3348e99f9926" - status: - type: string - example: Success - description: The status of the API call success/failure - message: - type: string - example: Successfully Converted and stored in Google Cloud Storage - description: Detail description on the API status - unauthorized: - type: object - properties: - message: - type: string - example: Missing Authentication Token - status: - type: string - example: Failure - forbidden: - type: object - properties: - message: - type: string - example: Access Denied Unauthorized User - status: - type: string - example: Failure - paymentrequired: - type: object - properties: - message: - type: string - example: Insufficient Credits Kindly Top Up - status: - type: string - example: Failure - notfound: - type: object - properties: - message: - type: string - example: Invalid Request URL - status: - type: string - example: Failure - servererror: - type: object - properties: - message: - type: string - example: Internal Server Error - status: - type: string - example: Failure - gatewaytimeout: - type: object - properties: - message: - type: string - example: Request Timeout - status: - type: string - example: Failure - inputfieldmissing: - type: object - properties: - message: - type: string - example: Input Field Missing - status: - type: string - example: Failure - inputlimitexceeded: - type: object - properties: - message: - type: string - example: Input Limit Exceeded - status: - type: string - example: Failure - invalidinput: - type: object - properties: - message: - type: string - example: Invalid Input - status: - type: string - example: Failure - input1: - type: object - properties: - jsonfile: - type: object - example: [{key:value}] - default: true - description: List of json objects - input: - type: object - properties: - jsonfile: - type: string - format: binary - example: [{key:value}] - default: true - description: List of json objects - versions: - type: object - properties: - v1.0.0: - type: array - items: - oneOf: - - type: string - example: Published Date - May 15, 2020 - description: Initial version release - securitySchemes: - APIAuthorizer: - type: apiKey - name: x-api-key - in: header - x-amazon-apigateway-authtype: custom - description: Authentication is done using the x-api-key in the request header diff --git a/yaml/landmark_detection_jp.yaml b/yaml/landmark_detection_jp.yaml deleted file mode 100644 index aa0e23555..000000000 --- a/yaml/landmark_detection_jp.yaml +++ /dev/null @@ -1,237 +0,0 @@ -openapi: 3.0.1 -info: - title: Landmark Detection (JP) - description: |+ - This Computer Vision microservice identifies Japan landmarks from multiple input images. - - The microservice returns the detected landmark and confidence score. - - The size of your image file should **not exceed 5 MB**. - x-additionalinfo: |+ - Suggested Use Cases: - - Can be used for geo-targeting apps with map feature or property development planning resource apps. - version: '0.1.0' - x-subscribelink: landmark_detection_jp -servers: - - url: 'https://apis.sentient.io' -tags: -- name: "v0.1.0" - description: "Published Date - Jul 30, 2020" -paths: - /microservices/cv/landmarkjp/v0.1/getpredictions: - post: - tags: - - v0.1.0 - responses: - '200': - description: success response - content: - application/json: - schema: - $ref: '#/components/schemas/success' - example: - confidence: 100% - landmark: Gion - '401': - description: Unauthorized - content: - application/json: - schema: - $ref: '#/components/schemas/unauthorized' - '402': - description: Payment Required - content: - application/json: - schema: - $ref: '#/components/schemas/paymentrequired' - '403': - description: Forbidden - content: - application/json: - schema: - $ref: '#/components/schemas/forbidden' - '404': - description: Not Found - content: - application/json: - schema: - $ref: '#/components/schemas/notfound' - '419': - description: Input Field Missing - content: - application/json: - schema: - $ref: '#/components/schemas/inputfieldmissing' - '413': - description: Input Limit Exceeded - content: - application/json: - schema: - $ref: '#/components/schemas/inputlimitexceeded' - '415': - description: Invalid Input - content: - application/json: - schema: - $ref: '#/components/schemas/invalidinput' - '500': - description: Internal Server Error - content: - application/json: - schema: - $ref: '#/components/schemas/servererror' - '504': - description: Gateway Timeout - content: - application/json: - schema: - $ref: '#/components/schemas/gatewaytimeout' - security: - - APIAuthorizer: [] - - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/input' - required: true - - -components: - schemas: - success: - type: object - properties: - confidence: - x-name: confidence - type: string - example: 100% - description: Confidence score of identification. Higher is more confidence. - landmark: - x-name: landmark - type: string - example: Gion - description: Name of the landmark - - - - unauthorized: - type: object - properties: - message: - type: string - example: Missing Authentication Token - status: - type: string - example: Failure - restricted: - type: object - properties: - message: - type: string - example: The content is restricted - status: - type: string - example: Failure - forbidden: - type: object - properties: - message: - type: string - example: Access Denied Unauthorized User - status: - type: string - example: Failure - paymentrequired: - type: object - properties: - message: - type: string - example: Insufficient Credits Kindly Top Up - status: - type: string - example: Failure - notfound: - type: object - properties: - message: - type: string - example: Invalid Request - status: - type: string - example: Failure - servererror: - type: object - properties: - message: - type: string - example: Internal Server Error - status: - type: string - example: Failure - gatewaytimeout: - type: object - properties: - message: - type: string - example: Request Timeout - status: - type: string - example: Failure - inputfieldmissing: - type: object - properties: - message: - type: string - example: Input Field Missing - status: - type: string - example: Failure - inputlimitexceeded: - type: object - properties: - message: - type: string - example: Input Limit Exceeded - status: - type: string - example: Failure - invalidinput: - type: object - properties: - message: - type: string - example: Invalid Input - status: - type: string - example: Failure - versions: - type: object - properties: - v0.1.0: - type: array - items: - oneOf: - - type: string - example: Published Date - Jul 30,2020 - description: Initial version release - input: - type: object - properties: - image_base64: - x-name: image_base64 - type: string - default: true - example: UklGRkbiBABXQVZFZm10IBAAAAABA... - description: |+ - Input image in base64 format. - - Supported formats: blp, bmp, bufr, cur, dcx, dds, dib, eps, ps, fit, fits, flc, fli, fpx, ftc, ftu, gbr, gif, grib, h5, hd5, icns, ico, im, iim, jpeg, jp2, mic, mpeg, msp, pcd, pcx, pxr, png, ppm, psd, sgi, ras, tga, tiff, wmf, xbm, xpm. - - securitySchemes: - APIAuthorizer: - type: apiKey - name: x-api-key - in: header - x-amazon-apigateway-authtype: custom - description: Authentication is done using the x-api-key in the request header diff --git a/yaml/landmark_detection_sg.yaml b/yaml/landmark_detection_sg.yaml deleted file mode 100644 index 445b27108..000000000 --- a/yaml/landmark_detection_sg.yaml +++ /dev/null @@ -1,241 +0,0 @@ -openapi: 3.0.1 -info: - title: Landmark Detection (SG) - description: |+ - This Computer Vision microservice identifies Singapore landmarks from multiple input images. - - This microservice returns the detected landmark and confidence score. - - The size of your image file should **not exceed 5 MB**. - x-additionalinfo: |+ - Suggested Use Cases: - - Can be used for geo-targeting apps with map feature or property development planning resource apps. - version: '0.1.0' - x-subscribelink: landmark_detection_sg -servers: - - url: 'https://apis.sentient.io' -tags: -- name: "v0.1.0" - description: "Published Date - Jul 30, 2020" -paths: - /microservices/cv/landmarksg/v0.1/getpredictions: - post: - tags: - - v0.1.0 - - responses: - '200': - description: success response - content: - application/json: - schema: - $ref: '#/components/schemas/success' - example: - confidence: 100% - landmark: Artscience Museum - - '401': - description: Unauthorized - content: - application/json: - schema: - $ref: '#/components/schemas/unauthorized' - '402': - description: Payment Required - content: - application/json: - schema: - $ref: '#/components/schemas/paymentrequired' - '403': - description: Forbidden - content: - application/json: - schema: - $ref: '#/components/schemas/forbidden' - '404': - description: Not Found - content: - application/json: - schema: - $ref: '#/components/schemas/notfound' - '419': - description: Input Field Missing - content: - application/json: - schema: - $ref: '#/components/schemas/inputfieldmissing' - '413': - description: Input Limit Exceeded - content: - application/json: - schema: - $ref: '#/components/schemas/inputlimitexceeded' - '415': - description: Invalid Input - content: - application/json: - schema: - $ref: '#/components/schemas/invalidinput' - '500': - description: Internal Server Error - content: - application/json: - schema: - $ref: '#/components/schemas/servererror' - '504': - description: Gateway Timeout - content: - application/json: - schema: - $ref: '#/components/schemas/gatewaytimeout' - security: - - APIAuthorizer: [] - - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/input' - required: true - - -components: - schemas: - success: - type: object - properties: - confidence: - x-name: confidence - type: string - example: 100% - description: Confidence score of identification. Higher is more confidence. - landmark: - x-name: landmark - type: string - example: Artscience Museum - description: Name of the landmark - - - - unauthorized: - type: object - properties: - message: - type: string - example: Missing Authentication Token - status: - type: string - example: Failure - restricted: - type: object - properties: - message: - type: string - example: The content is restricted - status: - type: string - example: Failure - forbidden: - type: object - properties: - message: - type: string - example: Access Denied Unauthorized User - status: - type: string - example: Failure - paymentrequired: - type: object - properties: - message: - type: string - example: Insufficient Credits Kindly Top Up - status: - type: string - example: Failure - notfound: - type: object - properties: - message: - type: string - example: Invalid Request - status: - type: string - example: Failure - servererror: - type: object - properties: - message: - type: string - example: Internal Server Error - status: - type: string - example: Failure - gatewaytimeout: - type: object - properties: - message: - type: string - example: Request Timeout - status: - type: string - example: Failure - inputfieldmissing: - type: object - properties: - message: - type: string - example: Input Field Missing - status: - type: string - example: Failure - inputlimitexceeded: - type: object - properties: - message: - type: string - example: Input Limit Exceeded - status: - type: string - example: Failure - invalidinput: - type: object - properties: - message: - type: string - example: Invalid Input - status: - type: string - example: Failure - versions: - type: object - properties: - v0.1.0: - type: array - items: - oneOf: - - type: string - example: Published Date - Jul 30,2020 - description: Initial version release - input: - type: object - required: - - image_base64 - properties: - image_base64: - x-name: image_base64 - type: string - default: true - example: UklGRkbiBABXQVZFZm10IBAAAAABA... - description: |+ - Input image in base64 format. - - Supported formats: blp, bmp, bufr, cur, dcx, dds, dib, eps, ps, fit, fits, flc, fli, fpx, ftc, ftu, gbr, gif, grib, h5, hd5, icns, ico, im, iim, jpeg, jp2, mic, mpeg, msp, pcd, pcx, pxr, png, ppm, psd, sgi, ras, tga, tiff, wmf, xbm, xpm. - - securitySchemes: - APIAuthorizer: - type: apiKey - name: x-api-key - in: header - x-amazon-apigateway-authtype: custom - description: Authentication is done using the x-api-key in the request header diff --git a/yaml/named-entity_recognition_eng.yaml b/yaml/named-entity_recognition_eng.yaml deleted file mode 100644 index 1a81a8283..000000000 --- a/yaml/named-entity_recognition_eng.yaml +++ /dev/null @@ -1,264 +0,0 @@ -openapi: 3.0.1 -info: - title: Named-Entity Recognition ENG - description: |+ - This NLP microservice locates and classifies the named-entities classes from input unstructured English text. - - The named-entity classes extracted are persons, locations, organisations and miscellaneous. - - This microservice automatically extracts structured information from unstructured text data such as chatlogs, emails, news articles, etc. - - Do ensure that your text is within **5000 characters**. - x-additionalinfo: |+ - Suggested Use Cases: - - Extracting structured pre-defined information from text. - - - Gain insights from online customers - extract structured information from unstructured text data such as chatlogs, emails, news articles, etc. to find and label fields within a document and then apply sentiment analysis to understand customer opinions to find actionable product and UX insights. - - - Entity analysis - identify entities within documents, including receipts, invoices, and contracts; and label them by types such as date, person, contact information, organization, location, events, products, and media. - version: '0.1.0' - x-subscribelink: named-entity_recognition_eng -servers: - - url: 'https://apis.sentient.io' -tags: -- name: "v0.1.0" - description: "Published Date - Nov 25, 2019" -paths: - /microservices/nlp/namedentityrecognition/v0.1/getpredictions: - post: - tags: - - v0.1.0 - responses: - '200': - description: success response - content: - application/json: - schema: - $ref: '#/components/schemas/success' - example: - LOC: - - America - - Saudi Arabia - - Yemen - - Abqaiq - - Iraq - - Iran - - Khurais - MISC: - - Arabian - - American - - Saudi - - Iranian - - Shia - ORG: - - Houthi - PER: - - DONALD TRUMP - - Mike Pompeo - '401': - description: Unauthorized - content: - application/json: - schema: - $ref: '#/components/schemas/unauthorized' - '402': - description: Payment Required - content: - application/json: - schema: - $ref: '#/components/schemas/paymentrequired' - '403': - description: Forbidden - content: - application/json: - schema: - $ref: '#/components/schemas/forbidden' - '404': - description: Not Found - content: - application/json: - schema: - $ref: '#/components/schemas/notfound' - '419': - description: Input Field Missing - content: - application/json: - schema: - $ref: '#/components/schemas/inputfieldmissing' - '413': - description: Input Limit Exceeded - content: - application/json: - schema: - $ref: '#/components/schemas/inputlimitexceeded' - '415': - description: Invalid Input - content: - application/json: - schema: - $ref: '#/components/schemas/invalidinput' - '500': - description: Internal Server Error - content: - application/json: - schema: - $ref: '#/components/schemas/servererror' - '504': - description: Gateway Timeout - content: - application/json: - schema: - $ref: '#/components/schemas/gatewaytimeout' - security: - - APIAuthorizer: [] - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/input' - required: true -components: - schemas: - success: - type: object - properties: - LOC: - x-name: LOC - type: array - example: [ America,Saudi Arabia,Yemen,Abqaiq ] - description: "name of location found in the text string" - MISC: - x-name: MISC - type: array - example: [ Arabian,American,Saudi ] - description: "name of miscellaneous names found in the text string" - ORG: - x-name: ORG - type: array - example: [ Houthi ] - description: "name of organizations found in the text string" - PER: - x-name: PER - type: array - example: [ DONALD TRUMP,Mike Pompeo ] - description: "name of persons found in the text string" - - unauthorized: - type: object - properties: - message: - type: string - example: Missing Authentication Token - status: - type: string - example: Failure - forbidden: - type: object - properties: - message: - type: string - example: Access Denied Unauthorized User - status: - type: string - example: Failure - paymentrequired: - type: object - properties: - message: - type: string - example: Insufficient Credits Kindly Top Up - status: - type: string - example: Failure - notfound: - type: object - properties: - message: - type: string - example: Invalid Request URL - status: - type: string - example: Failure - servererror: - type: object - properties: - message: - type: string - example: Internal Server Error - status: - type: string - example: Failure - gatewaytimeout: - type: object - properties: - message: - type: string - example: Request Timeout - status: - type: string - example: Failure - inputfieldmissing: - type: object - properties: - message: - type: string - example: Input Field Missing - status: - type: string - example: Failure - inputlimitexceeded: - type: object - properties: - message: - type: string - example: Input Limit Exceeded - status: - type: string - example: Failure - invalidinput: - type: object - properties: - message: - type: string - example: Invalid Input - status: - type: string - example: Failure - versions: - type: object - properties: - v1.0.0: - type: array - items: - oneOf: - - type: string - example: Published Date - Nov 25,2019 - description: Updated version release v1.0 - v0.1.0: - type: array - items: - oneOf: - - type: string - example: Published Date - Nov 25,2019 - description: Initial version release - input: - type: object - required: - - text - properties: - text: - x-name: text - type: string - default: true - example: The Singaporean procedure of hanging condemned individuals is similar to the methods formerly used in the United Kingdom. - description: |+ - Input text. - - Supported formats: ASCII only - securitySchemes: - APIAuthorizer: - type: apiKey - name: x-api-key - in: header - x-amazon-apigateway-authtype: custom - description: Authentication is done using the x-api-key in the request header diff --git a/yaml/named-entity_recognition_eng_v1.0.yaml b/yaml/named-entity_recognition_eng_v1.0.yaml deleted file mode 100644 index b5a977bcf..000000000 --- a/yaml/named-entity_recognition_eng_v1.0.yaml +++ /dev/null @@ -1,269 +0,0 @@ -openapi: 3.0.1 -info: - title: Named-Entity Recognition ENG - description: |+ - This NLP microservice locates and classifies the named-entities classes from input unstructured English text. - - The named-entity classes extracted are persons, locations, organisations and miscellaneous. - - This microservice automatically extracts structured information from unstructured text data such as chatlogs, emails, news articles, etc. - - Do ensure that your text is within **5000 characters**. - version: '1.0.0' - x-additionalinfo: |+ - Suggested Use Cases: - - Extracting structured pre-defined information from text. - - Gain insights from online customers - extract structured information from unstructured text data such as chatlogs, emails, news articles, etc. to find and label fields within a document and then apply sentiment analysis to understand customer opinions to find actionable product and UX insights. - - Entity analysis - identify entities within documents, including receipts, invoices, and contracts; and label them by types such as date, person, contact information, organization, location, events, products, and media. - x-subscribelink: named-entity_recognition_eng -servers: - - url: 'https://apis.sentient.io' -tags: -- name: "v1.0.0" - description: "Published Date - Sep 30, 2020" -paths: - /microservices/nlp/namedentityrecognition/v1/getpredictions: - post: - tags: - - v1.0.0 - responses: - '200': - description: success response - content: - application/json: - schema: - $ref: '#/components/schemas/success' - example: {"message":"SuccessfullyProcessed","results":{"loc":["Hubei","Singapore","SINGAPORE","China","Immigration"],"misc":["ICA.They"],"org":["ImmigrationandCheckpointsAuthority","ICA","LOA"]},"status":"Success"} - '401': - description: Unauthorized - content: - application/json: - schema: - $ref: '#/components/schemas/unauthorized' - '402': - description: Payment Required - content: - application/json: - schema: - $ref: '#/components/schemas/paymentrequired' - '403': - description: Forbidden - content: - application/json: - schema: - $ref: '#/components/schemas/forbidden' - '404': - description: Not Found - content: - application/json: - schema: - $ref: '#/components/schemas/notfound' - '419': - description: Input Field Missing - content: - application/json: - schema: - $ref: '#/components/schemas/inputfieldmissing' - '413': - description: Input Limit Exceeded - content: - application/json: - schema: - $ref: '#/components/schemas/inputlimitexceeded' - '415': - description: Invalid Input - content: - application/json: - schema: - $ref: '#/components/schemas/invalidinput' - '500': - description: Internal Server Error - content: - application/json: - schema: - $ref: '#/components/schemas/servererror' - '504': - description: Gateway Timeout - content: - application/json: - schema: - $ref: '#/components/schemas/gatewaytimeout' - security: - - APIAuthorizer: [] - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/input' - required: true -components: - schemas: - success: - type: object - properties: - results: - type: object - example: { "" } - description: Json Object of returned results - properties: - loc: - type: array - items: - type: string - example: - - Hubei - - Singapore - - Hubei - - Hubei - - Immigration - description: "name of location found in the text string" - misc: - type: array - items: - type: string - example: - - ICA.They - description: "name of miscellaneous names found in the text string" - org: - type: array - items: - type: string - example: - - Immigration and Checkpoints Authority - - ICA - - LOA - description: "name of organizations names found in the text string" - per: - type: array - items: - type: string - example: - - Lee Hsien Loong - description: "person names found in the text string" - message: - type: string - example: Successfully Processed - description: Detail description on the API status - status: - type: string - example: Success - description: The status of the API call success/failure - unauthorized: - type: object - properties: - message: - type: string - example: Missing Authentication Token - status: - type: string - example: Failure - forbidden: - type: object - properties: - message: - type: string - example: Access Denied Unauthorized User - status: - type: string - example: Failure - paymentrequired: - type: object - properties: - message: - type: string - example: Insufficient Credits Kindly Top Up - status: - type: string - example: Failure - notfound: - type: object - properties: - message: - type: string - example: Invalid Request URL - status: - type: string - example: Failure - servererror: - type: object - properties: - message: - type: string - example: Internal Server Error - status: - type: string - example: Failure - gatewaytimeout: - type: object - properties: - message: - type: string - example: Request Timeout - status: - type: string - example: Failure - inputfieldmissing: - type: object - properties: - message: - type: string - example: Input Field Missing - status: - type: string - example: Failure - inputlimitexceeded: - type: object - properties: - message: - type: string - example: Input Limit Exceeded - status: - type: string - example: Failure - invalidinput: - type: object - properties: - message: - type: string - example: Invalid Input - status: - type: string - example: Failure - versions: - type: object - properties: - v1.0.0: - type: array - items: - oneOf: - - type: string - example: Published Date - Sep 30, 2020 - description: Updated version release v1.0 - v0.1.0: - type: array - items: - oneOf: - - type: string - example: Published Date - Nov 25,2019 - description: Initial version release - input: - type: object - required: - - text - properties: - text: - x-name: text - type: string - default: true - example: SINGAPORE - Immigration officers have issued 77 stay-home notices as of noon on Wednesday (Feb 19), 12 hours after the scheme kicked in.These notices were issued to Singapore residents, long-term pass holders and foreign workers who have travelled to mainland China in the last 14 days, said the Immigration and Checkpoints Authority (ICA) in response to queries on Thursday.Travellers from Hubei province are excluded from this scheme, as they are quarantined.Those who are issued the new notices, which took effect at 11.59pm on Tuesday, cannot leave their homes for 14 days./n This is stricter than the leave of absence (LOA), which allowed people to briefly leave their homes for necessities. LOA will no longer be issued.Those who do not observe the stay-home period can be prosecuted under the Infectious Diseases Act, warned the ICA.They could be fined up to $10,000 or jailed for up to six month, or both, for the first offence. For subsequent offences, this could go up to a maximum of $20,000 and up to a year. - description: |+ - Input text. - - Supported formats: ASCII only - securitySchemes: - APIAuthorizer: - type: apiKey - name: x-api-key - in: header - x-amazon-apigateway-authtype: custom - description: Authentication is done using the x-api-key in the request header diff --git a/yaml/named-entity_recognition_jp.yaml b/yaml/named-entity_recognition_jp.yaml deleted file mode 100644 index c97d551bc..000000000 --- a/yaml/named-entity_recognition_jp.yaml +++ /dev/null @@ -1,255 +0,0 @@ -openapi: 3.0.1 -info: - title: Named-Entity Recognition JP - description: |+ - This NLP microservice locates and classifies the named-entities classes from input unstructured Japanese text. - - The named-entity classes extracted are persons, locations, organisations and miscellaneous. - - This microservice automatically extracts structured information from unstructured text data such as chatlogs, emails, news articles, etc. - x-additionalinfo: |+ - Suggested Use Cases: - - Extract structured pre-defined information from text. - - - Insights from online customers - extract structured information from unstructured text data such as chatlogs, emails, news articles, etc. to find and label fields within a document and then apply sentiment analysis to understand customer opinions to find actionable product and UX insights. - - - Entity analysis - identify entities within documents, including receipts, invoices, and contracts; and label them by types such as date, person, contact information, organization, location, events, products, and media. - version: '0.1.0' - x-subscribelink: named-entity_recognition_jp -servers: - - url: 'https://apis.sentient.io' -tags: -- name: "v0.1.0" - description: "Published Date - May 15, 2020" -paths: - /microservices/nlp/japanesener/v0.1/getpredictions: - post: - tags: - - v0.1.0 - responses: - '200': - description: success response - content: - application/json: - schema: - $ref: '#/components/schemas/success' - example: - Company: - - 和歌山製鉄所 - Date: - - 7日,2023年9月 - - 22年9月 - Domestic_Region: - - 呉製鉄所 - Material: - - 鉄鋼最大手 - N_Product: - - 高炉2基 - - 2基","1基 - Province: - - 広島県呉市 - - 和歌山市 - '401': - description: Unauthorized - content: - application/json: - schema: - $ref: '#/components/schemas/unauthorized' - '402': - description: Payment Required - content: - application/json: - schema: - $ref: '#/components/schemas/paymentrequired' - '403': - description: Forbidden - content: - application/json: - schema: - $ref: '#/components/schemas/forbidden' - '404': - description: Not Found - content: - application/json: - schema: - $ref: '#/components/schemas/notfound' - '419': - description: Input Field Missing - content: - application/json: - schema: - $ref: '#/components/schemas/inputfieldmissing' - '413': - description: Input Limit Exceeded - content: - application/json: - schema: - $ref: '#/components/schemas/inputlimitexceeded' - '415': - description: Invalid Input - content: - application/json: - schema: - $ref: '#/components/schemas/invalidinput' - '500': - description: Internal Server Error - content: - application/json: - schema: - $ref: '#/components/schemas/servererror' - '504': - description: Gateway Timeout - content: - application/json: - schema: - $ref: '#/components/schemas/gatewaytimeout' - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/input' - required: true - security: - - APIAuthorizer: [] -components: - schemas: - success: - type: object - properties: - Company: - x-name: Company - type: array - example: [ 和歌山製鉄所 ] - description: name of Company found in the text string - Date: - x-name: Date - type: array - example: [ 7日,2023年9月,22年9月 ] - description: name of Date found in the text string - Domestic_Region: - x-name: Domestic_Region - type: array - example: [ 呉製鉄所 ] - description: name of Domestic_Region found in the text string - Material: - x-name: Material - type: array - example: [ 鉄鋼最大手 ] - description: name of Material found in the text string - unauthorized: - type: object - properties: - message: - type: string - example: Missing Authentication Token - status: - type: string - example: Failure - forbidden: - type: object - properties: - message: - type: string - example: Access Denied Unauthorized User - status: - type: string - example: Failure - paymentrequired: - type: object - properties: - message: - type: string - example: Insufficient Credits Kindly Top Up - status: - type: string - example: Failure - notfound: - type: object - properties: - message: - type: string - example: Invalid Request URL - status: - type: string - example: Failure - servererror: - type: object - properties: - message: - type: string - example: Internal Server Error - status: - type: string - example: Failure - gatewaytimeout: - type: object - properties: - message: - type: string - example: Request Timeout - status: - type: string - example: Failure - inputfieldmissing: - type: object - properties: - message: - type: string - example: Input Field Missing - status: - type: string - example: Failure - inputlimitexceeded: - type: object - properties: - message: - type: string - example: Input Limit Exceeded - status: - type: string - example: Failure - invalidinput: - type: object - properties: - message: - type: string - example: Invalid Input - status: - type: string - example: Failure - versions: - type: object - properties: - v1.0.0: - type: array - items: - oneOf: - - type: string - example: Published Date - Sep 30,2020 - description: Updated version release v1.0 - v0.1.0: - type: array - items: - oneOf: - - type: string - example: Published Date - May 15,2020 - description: Initial version release - input: - type: object - required: - - text - properties: - text: - x-name: text - type: string - default: true - example: 鉄鋼最大手の日本製鉄は7日、高炉2基を備えた呉製鉄所（広島県呉市）を2023年9月までに全面休止すると発表した。閉鎖につながる可能性が高い。和歌山製鉄所（和歌山市）の高炉2基のうち1基を22年9月までに休止することも明らかにした。 - description: |+ - Input text - securitySchemes: - APIAuthorizer: - type: apiKey - name: x-api-key - in: header - x-amazon-apigateway-authtype: custom - description: Authentication is done using the x-api-key in the request header diff --git a/yaml/named-entity_recognition_jp_v1.0.yaml b/yaml/named-entity_recognition_jp_v1.0.yaml deleted file mode 100644 index 289adcfa0..000000000 --- a/yaml/named-entity_recognition_jp_v1.0.yaml +++ /dev/null @@ -1,329 +0,0 @@ -openapi: 3.0.1 -info: - title: Named-Entity Recognition JP - description: |+ - This NLP microservice locates and classifies the named-entities classes from input unstructured Japanese text. - - The named-entity classes extracted are persons, locations, organisations and miscellaneous. - - This microservice automatically extracts structured information from unstructured text data such as chatlogs, emails, news articles, etc. - - Do ensure that your text is within **5000 characters**. - version: '1.0.0' - x-additionalinfo: |+ - Suggested Use Cases: - - Extract structured pre-defined information from text. - - Insights from online customers - extract structured information from unstructured text data such as chatlogs, emails, news articles, etc. to find and label fields within a document and then apply sentiment analysis to understand customer opinions to find actionable product and UX insights. - - Entity analysis - identify entities within documents, including receipts, invoices, and contracts; and label them by types such as date, person, contact information, organization, location, events, products, and media. - x-subscribelink: named-entity_recognition_jp -servers: - - url: 'https://apis.sentient.io' -tags: -- name: "v1.0.0" - description: "Published Date - Sep 30, 2020" -paths: - /microservices/nlp/japanesener/v1/getpredictions: - post: - tags: - - v1.0.0 - responses: - '200': - description: success response - content: - application/json: - schema: - $ref: '#/components/schemas/success' - example: - message: Successfully Processed - results: - age: - - '56' - countx_other: - - 2稿 - - 8口 - doctrine_method_other: - - 険所コホ特室りょ - n_event: - - 受1 - numex_other: - - 百経 - ordinal_number: - - 30弾 - person: - - くぼ - - 壮 - - 琢紫 - - ナユ - product_other: - - 都合ヘラアニ限 - - 議帳 - show_organization: - - 左成相態 - status: Success - '401': - description: Unauthorized - content: - application/json: - schema: - $ref: '#/components/schemas/unauthorized' - '402': - description: Payment Required - content: - application/json: - schema: - $ref: '#/components/schemas/paymentrequired' - '403': - description: Forbidden - content: - application/json: - schema: - $ref: '#/components/schemas/forbidden' - '404': - description: Not Found - content: - application/json: - schema: - $ref: '#/components/schemas/notfound' - '419': - description: Input Field Missing - content: - application/json: - schema: - $ref: '#/components/schemas/inputfieldmissing' - '413': - description: Input Limit Exceeded - content: - application/json: - schema: - $ref: '#/components/schemas/inputlimitexceeded' - '415': - description: Invalid Input - content: - application/json: - schema: - $ref: '#/components/schemas/invalidinput' - '500': - description: Internal Server Error - content: - application/json: - schema: - $ref: '#/components/schemas/servererror' - '504': - description: Gateway Timeout - content: - application/json: - schema: - $ref: '#/components/schemas/gatewaytimeout' - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/input' - required: true - security: - - APIAuthorizer: [] -components: - schemas: - success: - type: object - properties: - results: - type: object - example: { "" } - description: Json Object of returned results - properties: - age: - type: array - items: - type: string - example: - - 56 - description: "age details found in the text string" - countx_other: - type: array - items: - type: string - example: - - 2稿 - - 8口 - description: "countx other details found in the text string" - doctrine_method_other: - type: array - items: - type: string - example: - - 険所コホ特室りょ - description: "doctrine method in the text string" - n_event: - type: array - items: - type: string - example: - - 受1 - description: "n_event in the text string" - numex_other: - type: array - items: - type: string - example: - - 受1 - description: "numex_other details found in the text string" - ordinal_number: - type: array - items: - type: string - example: - -30弾 - description: "ordinal_number details in the text string" - person: - type: array - items: - type: string - example: - - person - - 壮 - - 琢紫 - - ナユ - description: "person details found in the text string" - product_other: - type: array - items: - type: string - example: - - 都合ヘラアニ限 - - 議帳 - description: "product found in the text string" - show_organization: - type: array - items: - type: string - example: - - 左成相態 - description: "organization details found in the text string" - message: - type: string - example: Successfully Processed - description: Detail description on the API status - status: - type: string - example: Success - description: The status of the API call success/failure - unauthorized: - type: object - properties: - message: - type: string - example: Missing Authentication Token - status: - type: string - example: Failure - forbidden: - type: object - properties: - message: - type: string - example: Access Denied Unauthorized User - status: - type: string - example: Failure - paymentrequired: - type: object - properties: - message: - type: string - example: Insufficient Credits Kindly Top Up - status: - type: string - example: Failure - notfound: - type: object - properties: - message: - type: string - example: Invalid Request URL - status: - type: string - example: Failure - servererror: - type: object - properties: - message: - type: string - example: Internal Server Error - status: - type: string - example: Failure - gatewaytimeout: - type: object - properties: - message: - type: string - example: Request Timeout - status: - type: string - example: Failure - inputfieldmissing: - type: object - properties: - message: - type: string - example: Input Field Missing - status: - type: string - example: Failure - inputlimitexceeded: - type: object - properties: - message: - type: string - example: Input Limit Exceeded - status: - type: string - example: Failure - invalidinput: - type: object - properties: - message: - type: string - example: Invalid Input - status: - type: string - example: Failure - versions: - type: object - properties: - v1.0.0: - type: array - items: - oneOf: - - type: string - example: Published Date - Sep 30,2020 - description: Updated version release v1.0 - v0.1.0: - type: array - items: - oneOf: - - type: string - example: Published Date - May 15,2020 - description: Initial version release - input: - type: object - required: - - text - properties: - text: - x-name: text - type: string - default: true - example: 30弾ソイキ昇機マ了映だ店原いひ険所コホ特室りょくぼ都合ヘラアニ限2稿タチケア迷芸歌セ利講ルねひ詳績めかをぶ観提メエ府木ホフタ分不写ひフ妹検らし器増壮憶クわ。8口アユ琢紫ヨ理特ゆほス見百経イス図退ナユ介精しぜ議帳モテ受1中コハ載北早ぎのりや載裁風力壌ひろふ。運56済ぞ下写報スや来際おっはの学要ヘ手米真社つみよや非央で野館き肉待づぜフ次睡ルをが左成相態万えやろ。 - description: |+ - Input text. - - Supported formats: ASCII only - securitySchemes: - APIAuthorizer: - type: apiKey - name: x-api-key - in: header - x-amazon-apigateway-authtype: custom - description: Authentication is done using the x-api-key in the request header diff --git a/yaml/named-entity_recognition_thai.yaml b/yaml/named-entity_recognition_thai.yaml deleted file mode 100644 index 46968c45a..000000000 --- a/yaml/named-entity_recognition_thai.yaml +++ /dev/null @@ -1,237 +0,0 @@ -openapi: 3.0.1 -info: - title: Named-Entity Recognition THAI - description: |+ - This NLP microservice locates and classifies the named-entities classes from input unstructured Thai text. - - The named-entity classes extracted are persons, locations, organisations and miscellaneous. - - This microservice automatically extracts structured information from unstructured text data such as chatlogs, emails, news articles, etc. - x-additionalinfo: |+ - Suggested Use Cases: - - Extract structured pre-defined information from text. - - - Insights from online customers - extract structured information from unstructured text data such as chatlogs, emails, news articles, etc. to find and label fields within a document and then apply sentiment analysis to understand customer opinions to find actionable product and UX insights. - - - Entity analysis - identify entities within documents, including receipts, invoices, and contracts; and label them by types such as date, person, contact information, organization, location, events, products, and media. - version: '0.1.0' - x-subscribelink: named-entity_recognition_thai -servers: - - url: 'https://apis.sentient.io' -tags: -- name: "v0.1.0" - description: "Published Date - Aug 28, 2020" -paths: - /microservices/nlp/thainer/v0.1/getpredictions: - post: - tags: - - v0.1.0 - responses: - '200': - description: success response - content: - application/json: - schema: - $ref: '#/components/schemas/success' - example: - location: - - อินเดีย,สหรัฐอเมริกา - person: - - ประธานาธิบดีทรัมป์ - - '401': - description: Unauthorized - content: - application/json: - schema: - $ref: '#/components/schemas/unauthorized' - '402': - description: Payment Required - content: - application/json: - schema: - $ref: '#/components/schemas/paymentrequired' - '403': - description: Forbidden - content: - application/json: - schema: - $ref: '#/components/schemas/forbidden' - '404': - description: Not Found - content: - application/json: - schema: - $ref: '#/components/schemas/notfound' - '419': - description: Input Field Missing - content: - application/json: - schema: - $ref: '#/components/schemas/inputfieldmissing' - '413': - description: Input Limit Exceeded - content: - application/json: - schema: - $ref: '#/components/schemas/inputlimitexceeded' - '415': - description: Invalid Input - content: - application/json: - schema: - $ref: '#/components/schemas/invalidinput' - '500': - description: Internal Server Error - content: - application/json: - schema: - $ref: '#/components/schemas/servererror' - '504': - description: Gateway Timeout - content: - application/json: - schema: - $ref: '#/components/schemas/gatewaytimeout' - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/input' - required: true - security: - - APIAuthorizer: [] -components: - schemas: - success: - type: object - properties: - location: - x-name: location - type: array - example: [ สหรัฐอเมริ ] - description: name of location found in the text string - - person: - x-name: person - type: array - example: [ ประธานาธิบดีทร ] - description: name of person found in the text string - - unauthorized: - type: object - properties: - message: - type: string - example: Missing Authentication Token - status: - type: string - example: Failure - forbidden: - type: object - properties: - message: - type: string - example: Access Denied Unauthorized User - status: - type: string - example: Failure - paymentrequired: - type: object - properties: - message: - type: string - example: Insufficient Credits Kindly Top Up - status: - type: string - example: Failure - notfound: - type: object - properties: - message: - type: string - example: Invalid Request URL - status: - type: string - example: Failure - servererror: - type: object - properties: - message: - type: string - example: Internal Server Error - status: - type: string - example: Failure - gatewaytimeout: - type: object - properties: - message: - type: string - example: Request Timeout - status: - type: string - example: Failure - inputfieldmissing: - type: object - properties: - message: - type: string - example: Input Field Missing - status: - type: string - example: Failure - invalidinput: - type: object - properties: - message: - type: string - example: Invalid Input - status: - type: string - example: Failure - inputlimitexceeded: - type: object - properties: - message: - type: string - example: Input Limit Exceeded - status: - type: string - example: Failure - versions: - type: object - properties: - v1.0.0: - type: array - items: - oneOf: - - type: string - example: Published Date - Aug 28,2020 - description: Updated version release v1.0 - v0.1.0: - type: array - items: - oneOf: - - type: string - example: Published Date - Aug 28,2020 - description: Initial version release - input: - type: object - required: - - text - properties: - text: - x-name: text - type: string - default: true - example: ประธานาธิบดีทรัมป์เป็นประธานาธิบดีแห่งสหรัฐอเมริกา เขาเคยเป็นส่วนหนึ่งของ Apple ในอินเดีย เวลา - description: |+ - Input text - securitySchemes: - APIAuthorizer: - type: apiKey - name: x-api-key - in: header - x-amazon-apigateway-authtype: custom - description: Authentication is done using the x-api-key in the request header diff --git a/yaml/named-entity_recognition_thai_v1.0.yaml b/yaml/named-entity_recognition_thai_v1.0.yaml deleted file mode 100644 index 0578e3883..000000000 --- a/yaml/named-entity_recognition_thai_v1.0.yaml +++ /dev/null @@ -1,331 +0,0 @@ -openapi: 3.0.1 -info: - title: Named-Entity Recognition THAI - description: |+ - This NLP microservice locates and classifies the named-entities classes from input unstructured Thai text. - - The named-entity classes extracted are persons, locations, organisations and miscellaneous. - - This microservice automatically extracts structured information from unstructured text data such as chatlogs, emails, news articles, etc. - - Do ensure that your text is **within 5000 characters**. - version: '1.0.0' - x-additionalinfo: |+ - Suggested Use Cases: - - Extract structured pre-defined information from text. - - - Insights from online customers - extract structured information from unstructured text data such as chatlogs, emails, news articles, etc. to find and label fields within a document and then apply sentiment analysis to understand customer opinions to find actionable product and UX insights. - - - Entity analysis - identify entities within documents, including receipts, invoices, and contracts; and label them by types such as date, person, contact information, organization, location, events, products, and media. - x-subscribelink: named-entity_recognition_thai -servers: - - url: 'https://apis.sentient.io' -tags: -- name: "v1.0.0" - description: "Published Date - Sep 30, 2020" -paths: - /microservices/nlp/thainer/v1/getpredictions: - post: - tags: - - v1.0.0 - responses: - '200': - description: success response - content: - application/json: - schema: - $ref: '#/components/schemas/success' - example: - message: Successfully Processed - results: - law: - - รัฐธรรมนูญ - location: - - ประเทศไทย - - มาเลเซีย - - ทะเลอันดามัน - - กรุงเทพมหานคร - - อินโดนีเซีย - - ราชอาณาจักรไทย - - อินเดียทางทะเลอันดามันทางตะวันตกเฉียงใต้ - - ลาวทางทิศตะวันออกติดกับลาว - - เอเชียตะวันออกเฉียงใต้ - - เวียดนาม - - ประเทศพม่า - - กัมพูชาทางทิศใต้ติดกับอ่าวไทย - organization: - - รัฐสภา - status: Success - '401': - description: Unauthorized - content: - application/json: - schema: - $ref: '#/components/schemas/unauthorized' - '402': - description: Payment Required - content: - application/json: - schema: - $ref: '#/components/schemas/paymentrequired' - '403': - description: Forbidden - content: - application/json: - schema: - $ref: '#/components/schemas/forbidden' - '404': - description: Not Found - content: - application/json: - schema: - $ref: '#/components/schemas/notfound' - '419': - description: Input Field Missing - content: - application/json: - schema: - $ref: '#/components/schemas/inputfieldmissing' - '413': - description: Input Limit Exceeded - content: - application/json: - schema: - $ref: '#/components/schemas/inputlimitexceeded' - '415': - description: Invalid Input - content: - application/json: - schema: - $ref: '#/components/schemas/invalidinput' - '500': - description: Internal Server Error - content: - application/json: - schema: - $ref: '#/components/schemas/servererror' - '504': - description: Gateway Timeout - content: - application/json: - schema: - $ref: '#/components/schemas/gatewaytimeout' - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/input' - required: true - security: - - APIAuthorizer: [] -components: - schemas: - success: - type: object - properties: - results: - type: object - example: { "" } - description: Json Object of returned results - properties: - law: - x-name: law - type: array - example: [พ.ร.บ.โรคระบาด พ.ศ.2499, รัฐธรรมนูญ] - description: "law details found in the text string" - location: - x-name: location - type: array - example: - - ประเทศไทย - - มาเลเซีย - - ทะเลอันดามัน - - กรุงเทพมหานคร - - อินโดนีเซีย - - ราชอาณาจักรไทย - - อินเดียทางทะเลอันดามันทางตะวันตกเฉียงใต้ - - ลาวทางทิศตะวันออกติดกับลาว - - เอเชียตะวันออกเฉียงใต้ - - เวียดนาม - - ประเทศพม่า - - กัมพูชาทางทิศใต้ติดกับอ่าวไทย - description: "location found in the text string" - organization: - x-name: organization - type: array - example: - - รัฐสภา - description: "organization found in the text string" - date: - x-name: date - type: array - example: [2/21/2004, 16 ก.พ., จันทร์] - description: "date found in the text string" - money: - x-name: money - type: array - example: [2.7 ล้านบาท, 2,000 บาท] - description: "amount of currency found in the text string" - time: - x-name: time - type: array - example: [16.30 น., 5 วัน, 1-3 ปี] - description: "time found in the text string" - email: - x-name: email - type: array - example: [info@nrpsc.ac.th] - description: "email id found in the text string" - len: - x-name: len - type: array - example: [30 กิโลเมตร, 5 กม.] - description: "distance in km found in the text string" - person: - x-name: person - type: array - example: [น.พ.จรัล, นางประนอม ทองจันทร์] - description: "name of person found in the text string" - phone: - x-name: phone - type: array - example: [0 2670 8888] - description: "date found in the text string" - url: - x-name: url - type: array - example: [http://www.bangkokhealth.com/] - description: "url in the text string" - zip: - x-name: zip - type: array - example: [10400] - description: "zipcode found in the text string" - - message: - type: string - example: Successfully Processed - description: Detail description on the API status - status: - type: string - example: Success - description: The status of the API call success/failure - unauthorized: - type: object - properties: - message: - type: string - example: Missing Authentication Token - status: - type: string - example: Failure - forbidden: - type: object - properties: - message: - type: string - example: Access Denied Unauthorized User - status: - type: string - example: Failure - paymentrequired: - type: object - properties: - message: - type: string - example: Insufficient Credits Kindly Top Up - status: - type: string - example: Failure - notfound: - type: object - properties: - message: - type: string - example: Invalid Request URL - status: - type: string - example: Failure - invalidinput: - type: object - properties: - message: - type: string - example: Invalid Input - status: - type: string - example: Failure - servererror: - type: object - properties: - message: - type: string - example: Internal Server Error - status: - type: string - example: Failure - gatewaytimeout: - type: object - properties: - message: - type: string - example: Request Timeout - status: - type: string - example: Failure - inputfieldmissing: - type: object - properties: - message: - type: string - example: Input Field Missing - status: - type: string - example: Failure - inputlimitexceeded: - type: object - properties: - message: - type: string - example: Input Limit Exceeded - status: - type: string - example: Failure - versions: - type: object - properties: - v1.0.0: - type: array - items: - oneOf: - - type: string - example: Published Date - Sep 30,2020 - description: Updated version release v1.0 - v0.1.0: - type: array - items: - oneOf: - - type: string - example: Published Date - Aug 28,2020 - description: Initial version release - input: - type: object - required: - - text - properties: - text: - x-name: text - type: string - default: true - example: ประเทศไทย [a] ราชอาณาจักรไทยอย่างเป็นทางการและมีชื่อเดิมว่าสยาม [b] เป็นประเทศในเอเชียตะวันออกเฉียงใต้ ตั้งอยู่ที่ใจกลางคาบสมุทรอินโดจีนประกอบด้วย 76 จังหวัดและครอบคลุมพื้นที่ 513,120 ตารางกิโลเมตร (198,120 ตารางไมล์) และมีประชากรมากกว่า 66 ล้านคน [4] ประเทศไทยเป็นประเทศที่มีพื้นที่ทางบกมากเป็นอันดับที่ 50ของโลกและเป็นประเทศที่มีประชากรมากที่สุดเป็นอันดับที่ 22 ของโลก เมืองหลวงและเมืองที่ใหญ่ที่สุดคือกรุงเทพมหานครซึ่งเป็นเขตปกครองพิเศษ ประเทศไทยมีพรมแดนติดทางทิศเหนือติดกับเมียนมาร์และลาวทางทิศตะวันออกติดกับลาวและกัมพูชาทางทิศใต้ติดกับอ่าวไทยและมาเลเซียและทางทิศตะวันตกติดกับทะเลอันดามันและทางตอนใต้ของประเทศพม่า พรมแดนทางทะเล ได้แก่ เวียดนามในอ่าวไทยทางตะวันออกเฉียงใต้และอินโดนีเซียและอินเดียทางทะเลอันดามันทางตะวันตกเฉียงใต้ ประเทศไทยเป็นระบอบรัฐธรรมนูญและประชาธิปไตยแบบรัฐสภา อย่างไรก็ตามในประวัติศาสตร์ที่ผ่านมารัฐบาลของตนต้องเผชิญกับการรัฐประหารหลายครั้งและช่วงเวลาแห่งการปกครองแบบเผด็จการทหารย เวลา - description: |+ - Input text. - - Supported formats: ASCII only - securitySchemes: - APIAuthorizer: - type: apiKey - name: x-api-key - in: header - x-amazon-apigateway-authtype: custom - description: Authentication is done using the x-api-key in the request header diff --git a/yaml/newspaper_article_scraper.yaml b/yaml/newspaper_article_scraper.yaml deleted file mode 100644 index dcefbee00..000000000 --- a/yaml/newspaper_article_scraper.yaml +++ /dev/null @@ -1,325 +0,0 @@ -openapi: 3.0.1 -info: - title: Newspaper Article Scraper - description: |+ - This api allows to extracting & curating articles and delivers Instapaper style article extraction. - - Current supported languages: Arabic, Russian, Dutch, German, English, Spanish, French, Hebrew, Italian, Korean, Norwegian, Persian, Polish, Portuguese, Swedish, Hungarian, Finnish, Danish, Chinese, Indonesian, Vietnamese, Swahili, Turkish, Greek, Ukrainian. Supports automatic languages detection. - - Note that the URL has to be **spelt in full**, including "https://www." - x-additionalinfo: |+ - Suggested Use Cases: - - Can be used in services related to the creation of a real-time web application that gathers data from several newspapers and shows a summary of the different topics that are being discussed in the news articles. - version: '0.1.0' - x-subscribelink: newspaper_article_scraper -servers: - - url: 'https://apis.sentient.io' -tags: -- name: "v0.1.0" - description: "Published Date - Aug 07, 2020" -paths: - /microservices/utility/newsarticle/v0.1/getresults: - post: - tags: - - v0.1.0 - responses: - '200': - description: success response - content: - application/json: - schema: - $ref: '#/components/schemas/success' - example: - content: - all_images: - - https://static.bangkokpost.com/media/content/20170620/2363063.jpg - - https://www.bangkokpost.com/media/content/20170620/c1_1272315_170620160518_620x413.jpg - - https://static.bangkokpost.com/media/content/20170620/2364459.jpg - - https://static.bangkokpost.com/media/content/20170620/2363071.jpg - - https://static.bangkokpost.com/media/content/20170620/2364455.jpg - - https://static.bangkokpost.com/media/content/20170620/2363075.jpg - authors: - - Bangkok Post Public Company Limited - keywords: - - scholarships - - opportunities - - fair - - study - - learning - - worlds - language: en - link: https://www.bangkokpost.com/learning/news/1272315/study-and-work-in-australia-%E2%80%93-many-opportunities-ahead- - publish_date: 2020-09-30T07:11:15 - summary: |- - Australia is a country welcoming international students to study at all levels of education with its quality and the part-time work rights given. - Moreover, there are opportunities to work full-time and to migrate and hold Australian citizenship after graduation from Australia. - Study, Work and Live in one of the World's most liveable countries. - "Post Study Work Rights and Pathways to Australian Permanent - text: |- - Australia is a country welcoming international students to study at all levels of education with its quality and the part-time work rights given. Moreover, there are opportunities to work full-time and to migrate and hold Australian citizenship after graduation from Australia. Especially, engineers, IT specialists and accountants, and many more, are on the list of occupations which Australia is demanding. - - Study, Work and Live in one of the World's most liveable countries. - - Don't miss the chance to interview directly with 40 leading universities and institutions from across Australia. Application fee waivers and scholarships are also available. - - Unique! "Post Study Work Rights and Pathways to Australian Permanent Resident" seminar by Dr. Visa, Australian Registered Migration Agent, and special talks by Andrew Biggs, - title: Study and Work in Australia - top_image: https://www.bangkokpost.com/media/content/20170620/c1_1272315_170620160518_620x413.jpg - video: - - https://www.youtube.com/embed/8I9uQVHluBk - message: Successfully Processed - status: Success - '401': - description: Unauthorized - content: - application/json: - schema: - $ref: '#/components/schemas/unauthorized' - '402': - description: Payment Required - content: - application/json: - schema: - $ref: '#/components/schemas/paymentrequired' - '403': - description: Forbidden - content: - application/json: - schema: - $ref: '#/components/schemas/forbidden' - '404': - description: Not Found - content: - application/json: - schema: - $ref: '#/components/schemas/notfound' - '419': - description: Input Field Missing - content: - application/json: - schema: - $ref: '#/components/schemas/inputfieldmissing' - '413': - description: Input Limit Exceeded - content: - application/json: - schema: - $ref: '#/components/schemas/inputlimitexceeded' - '415': - description: Invalid Input - content: - application/json: - schema: - $ref: '#/components/schemas/invalidinput' - '500': - description: Internal Server Error - content: - application/json: - schema: - $ref: '#/components/schemas/servererror' - '504': - description: Gateway Timeout - content: - application/json: - schema: - $ref: '#/components/schemas/gatewaytimeout' - security: - - APIAuthorizer: [] - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/input' - required: true -components: - schemas: - success: - type: object - properties: - content: - type: object - example: {} - description: The result of the API call - properties: - all_images: - type: array - items: - type: string - example: - - https://static.bangkokpost.com/media/content/20170620/2363063.jpg - - https://www.bangkokpost.com/media/content/20170620/c1_1272315_170620160518_620x413.jpg - - https://static.bangkokpost.com/media/content/20170620/2364459.jpg - - https://static.bangkokpost.com/media/content/20170620/2363071.jpg - - https://static.bangkokpost.com/media/content/20170620/2364455.jpg - - https://static.bangkokpost.com/media/content/20170620/2363075.jpg - description: All images of new article. - authors: - type: array - items: - type: string - example: - - Bangkok Post Public Company Limited - description: Authors of new article. - keywords: - type: array - items: - type: string - example: - - scholarships - - opportunities - - fair - - study - - learning - - worlds - description: NLP processed keywords from news article. - language: - type: string - example: "en" - description: Language of news article. - link: - type: string - example: "https://www.bangkokpost.com/learning/news/1272315/study-and-work-in-australia-%E2%80%93-many-opportunities-ahead-" - description: Main article link url. - publish_date: - type: string - example: 2020-09-30T07:11:15 - description: Published date of news article. - summary: - type: string - example: "Australia is a country welcoming international students to study at all levels of education with its quality and the part-time work rights given.\nMoreover, there are opportunities to work full-time and to migrate and hold Australian citizenship after graduation from Australia.\nStudy, Work and Live in one of the World's most liveable countries.\n\"Post Study Work Rights and Pathways to Australian Permanent" - description: Main content of news article. - text: - type: string - example: "Australia is a country welcoming international students to study at all levels of education with its quality and the part-time work rights given. Moreover, there are opportunities to work full-time and to migrate and hold Australian citizenship after graduation from Australia. Especially, engineers, IT specialists and accountants, and many more, are on the list of occupations which Australia is demanding.\n\nStudy, Work and Live in one of the World's most liveable countries.\n\nDon't miss the chance to interview directly with 40 leading universities and institutions from across Australia. Application fee waivers and scholarships are also available.\n\nUnique! \"Post Study Work Rights and Pathways to Australian Permanent Resident\" seminar by Dr. Visa, Australian Registered Migration Agent, and special talks by Andrew Biggs," - description: Full text content of news article. - title: - type: string - example: "Study and Work in Australia" - description: Title of news article. - top_image: - type: string - example: "https://www.bangkokpost.com/media/content/20170620/c1_1272315_170620160518_620x413.jpg" - description: Published image of news article. - video: - type: array - items: - type: string - example: - - https://www.youtube.com/embed/8I9uQVHluBk - description: All video clips related to news article if available. - message: - type: string - example: Successfully Processed - description: Detail description on the API status - status: - type: string - example: Success - description: The status of the API call success/failure - unauthorized: - type: object - properties: - message: - type: string - example: Missing Authentication Token - status: - type: string - example: Failure - forbidden: - type: object - properties: - message: - type: string - example: Access Denied Unauthorized User - status: - type: string - example: Failure - paymentrequired: - type: object - properties: - message: - type: string - example: Insufficient Credits Kindly Top Up - status: - type: string - example: Failure - notfound: - type: object - properties: - message: - type: string - example: Invalid Request URL - status: - type: string - example: Failure - servererror: - type: object - properties: - message: - type: string - example: Internal Server Error - status: - type: string - example: Failure - gatewaytimeout: - type: object - properties: - message: - type: string - example: Request Timeout - status: - type: string - example: Failure - inputfieldmissing: - type: object - properties: - message: - type: string - example: Input Field Missing - status: - type: string - example: Failure - invalidinput: - type: object - properties: - message: - type: string - example: Invalid Input - status: - type: string - example: Failure - inputlimitexceeded: - type: object - properties: - message: - type: string - example: Input Limit Exceeded - status: - type: string - example: Failure - versions: - type: object - properties: - v0.1.0: - type: array - items: - oneOf: - - type: string - example: Published Date - Aug 07, 2020 - description: Initial version release - input: - type: object - required: - - url - properties: - url: - type: string - example: https://www.bangkokpost.com/learning/news/1272315/study-and-work-in-australia-%E2%80%93-many-opportunities-ahead - default: true - description: The absolute input url, i.e exact, full address (URL) to the page. - securitySchemes: - APIAuthorizer: - type: apiKey - name: x-api-key - in: header - x-amazon-apigateway-authtype: custom - description: Authentication is done using the x-api-key in the request header diff --git a/yaml/object_detection.yaml b/yaml/object_detection.yaml deleted file mode 100644 index d2025b37d..000000000 --- a/yaml/object_detection.yaml +++ /dev/null @@ -1,250 +0,0 @@ -openapi: 3.0.1 -info: - title: Object Detection - description: |+ - This Computer Vision microservice detects objects in the input image. - - The microservice returns detected objects with their classes and their bounding boxes in the image coordinates. - - The classes are: person, bicycle, car, motorbike, aeroplane, bus, train, truck, boat, traffic light, fire hydrant, stop sign, parking meter, bench, bird, cat, dog, horse, sheep, cow, elephant, bear, zebra, giraffe, backpack, umbrella, handbag, tie, suitcase, frisbee, skis, snowboard, sports ball, kite, baseball bat, baseball glove, skateboard, surfboard, tennis racket, bottle, wine glass, cup, fork, knife, spoon, bowl, banana, apple, sandwich, orange, broccoli, carrot, hot dog, pizza, donut, cake, chair, sofa, pottedplant, bed, diningtable, toilet, tvmonitor, laptop, mouse, remote, keyboard, cell phone, microwave, oven, toaster, sink, refrigerator, book, clock, vase, scissors, teddy bear, hair drier, toothbrush. - - The size of your image file should **not exceed 5 MB**, and the image dimension should be **at least 416x416 pixels**. - x-additionalinfo: |+ - Suggested Use Cases: - - Industrial inspection - use Object Detection to automate the quality control process in manufacturing by enabling edge devices to identify defects. - - - Product search - build a product search app to find products of interest within images and visually search product catalogs. - - - Build an object detection app for the visually-impaired - help users identify daily objects that they may need aid in recognising - version: '0.1.0' - x-subscribelink: object_detection -servers: - - url: 'https://apis.sentient.io' -tags: -- name: "v0.1.0" - description: "Published Date - May 15, 2020" -paths: - /microservices/cv/objectdetection/v0.1/getpredictions: - post: - tags: - - v0.1.0 - responses: - '200': - description: success response - content: - application/json: - schema: - $ref: '#/components/schemas/success' - example: {"Object 1": ["person : 100%",{"Bounding Box": {"Bot": 742,"Left": 19,"Right": 1019,"Top": 73}}],"Object 2": ["tie : 100%",{"Bounding Box": {"Bot": 783,"Left": 411,"Right": 595,"Top": 520}}]} - - '401': - description: Unauthorized - content: - application/json: - schema: - $ref: '#/components/schemas/unauthorized' - '402': - description: Payment Required - content: - application/json: - schema: - $ref: '#/components/schemas/paymentrequired' - '403': - description: Forbidden - content: - application/json: - schema: - $ref: '#/components/schemas/forbidden' - '404': - description: Not Found - content: - application/json: - schema: - $ref: '#/components/schemas/notfound' - '419': - description: Input Field Missing - content: - application/json: - schema: - $ref: '#/components/schemas/inputfieldmissing' - '413': - description: Input Limit Exceeded - content: - application/json: - schema: - $ref: '#/components/schemas/inputlimitexceeded' - '415': - description: Invalid Input - content: - application/json: - schema: - $ref: '#/components/schemas/invalidinput' - '500': - description: Internal Server Error - content: - application/json: - schema: - $ref: '#/components/schemas/servererror' - '504': - description: Gateway Timeout - content: - application/json: - schema: - $ref: '#/components/schemas/gatewaytimeout' - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/input' - required: true - security: - - APIAuthorizer: [] -components: - schemas: - success: - type: object - properties: - : - type: array - example: ["person : 100%",{"Bounding Box": {"Bot": 742,"Left": 19,"Right": 1019,"Top": 73}}] - description: "Details of the detected object" - items: - properties: - person: - type: string - example: 100% - description: people - Bounding Box: - type: object - example: {"Bot": 742,"Left": 19,"Right": 1019,"Top": 73} - description: Bounding box of the image - properties: - Bot: - type: number - example: 742 - description: Bottom coordinate of the box - Left: - type: number - example: 19 - description: Left coordinate of the box - Right: - type: number - example: 1019 - description: Right coordinate of the box - Top: - type: number - example: 73 - description: Top coordinate of the box - unauthorized: - type: object - properties: - message: - type: string - example: Missing Authentication Token - status: - type: string - example: Failure - forbidden: - type: object - properties: - message: - type: string - example: Access Denied Unauthorized User - status: - type: string - example: Failure - paymentrequired: - type: object - properties: - message: - type: string - example: Insufficient Credits Kindly Top Up - status: - type: string - example: Failure - notfound: - type: object - properties: - message: - type: string - example: Invalid Request URL - status: - type: string - example: Failure - servererror: - type: object - properties: - message: - type: string - example: Internal Server Error - status: - type: string - example: Failure - gatewaytimeout: - type: object - properties: - message: - type: string - example: Request Timeout - status: - type: string - example: Failure - invalidinput: - type: object - properties: - message: - type: string - example: Invalid Input - status: - type: string - example: Failure - inputfieldmissing: - type: object - properties: - message: - type: string - example: Input Field Missing - status: - type: string - example: Failure - inputlimitexceeded: - type: object - properties: - message: - type: string - example: Input Limit Exceeded - status: - type: string - example: Failure - - versions: - type: object - properties: - v0.1.0: - type: array - items: - oneOf: - - type: string - example: Published Date - May 15,2020 - description: Initial version release - input: - type: object - required: - - image_base64 - properties: - image_base64: - x-name: image_base64 - type: string - default: true - example: /9j/4AAQSkZJRgABAQEASABIAAD/2wBDAAMCAgMCAgMDAwMEAwMEBQgFBQQEBQoHBwYIDAoMDAsKCwsNDhIQDQ4RDgsLEBYQERMUFRUVDA8XGBYUG... - description: |+ - Input image file in base64 format. - - Supported formats: bmp, dib, exr, hdr, jpeg, jpg, jpe, jp2, png, pic, pbm, pgm, ppm, pxm, pnm, ras, sr, tiff, tif, webp. - securitySchemes: - APIAuthorizer: - type: apiKey - name: x-api-key - in: header - x-amazon-apigateway-authtype: custom - description: Authentication is done using the x-api-key in the request header diff --git a/yaml/object_detection_v1.0.yaml b/yaml/object_detection_v1.0.yaml deleted file mode 100644 index e5db137ef..000000000 --- a/yaml/object_detection_v1.0.yaml +++ /dev/null @@ -1,278 +0,0 @@ -openapi: 3.0.1 -info: - title: Object Detection - description: |+ - This Computer Vision microservice detects objects in the input image. - - The microservice returns detected objects with their classes and their bounding boxes in the image coordinates. - - The classes are: person, bicycle, car, motorbike, aeroplane, bus, train, truck, boat, traffic light, fire hydrant, stop sign, parking meter, bench, bird, cat, dog, horse, sheep, cow, elephant, bear, zebra, giraffe, backpack, umbrella, handbag, tie, suitcase, frisbee, skis, snowboard, sports ball, kite, baseball bat, baseball glove, skateboard, surfboard, tennis racket, bottle, wine glass, cup, fork, knife, spoon, bowl, banana, apple, sandwich, orange, broccoli, carrot, hot dog, pizza, donut, cake, chair, sofa, pottedplant, bed, diningtable, toilet, tvmonitor, laptop, mouse, remote, keyboard, cell phone, microwave, oven, toaster, sink, refrigerator, book, clock, vase, scissors, teddy bear, hair drier, toothbrush. - - The size of your image file should **not exceed 5 MB**, and the image dimension should be **at least 416x416 pixels**. - x-additionalinfo: |+ - Suggested Use Cases: - - Industrial inspection - use Object Detection to automate the quality control process in manufacturing by enabling edge devices to identify defects. - - Product search - build a product search app to find products of interest within images and visually search product catalogs. - - Build an object detection app for the visually-impaired - help users identify daily objects that they may need aid in recognising - version: '1.0.0' - x-subscribelink: object_detection -servers: - - url: 'https://apis.sentient.io' -tags: -- name: "v1.0.0" - description: "Published Date - Dec 31, 2020" -paths: - /microservices/cv/objectdetection/v1/getpredictions: - post: - tags: - - v1.0.0 - responses: - '200': - description: success response - content: - application/json: - schema: - $ref: '#/components/schemas/success' - example: {"results":{"objects": [{"bounding box": {"bottom": 742,"left": 19,"right": 1019,"top": 73},"class": "person","confidence": 1,"object id": 0}]},"message": "Successfully Processed","status": "Success"} - - '401': - description: Unauthorized - content: - application/json: - schema: - $ref: '#/components/schemas/unauthorized' - '402': - description: Payment Required - content: - application/json: - schema: - $ref: '#/components/schemas/paymentrequired' - '403': - description: Forbidden - content: - application/json: - schema: - $ref: '#/components/schemas/forbidden' - '404': - description: Not Found - content: - application/json: - schema: - $ref: '#/components/schemas/notfound' - '419': - description: Input Field Missing - content: - application/json: - schema: - $ref: '#/components/schemas/inputfieldmissing' - '420': - description: Input Limit Exceeded - content: - application/json: - schema: - $ref: '#/components/schemas/inputlimitexceeded' - '422': - description: Invalid Input - content: - application/json: - schema: - $ref: '#/components/schemas/invalidinput' - '500': - description: Internal Server Error - content: - application/json: - schema: - $ref: '#/components/schemas/servererror' - '504': - description: Gateway Timeout - content: - application/json: - schema: - $ref: '#/components/schemas/gatewaytimeout' - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/input' - required: true - security: - - APIAuthorizer: [] -components: - schemas: - success: - type: object - properties: - results: - type: object - description: The result of the API call. - example: { "" } - properties: - objects: - type: array - example: [{"bounding box": {"bottom": 742,"left": 19,"right": 1019,"top": 73},"class": "person","confidence": 1,"object id": 0}] - description: "Details of the detected object" - items: - oneOf: - - type: object - properties: - bounding box: - type: object - example: {"bottom": 742,"left": 19,"right": 1019,"top": 73} - description: Bounding box of the image - properties: - bottom: - type: number - example: 742 - description: Bottom coordinate of the box - left: - type: number - example: 19 - description: Left coordinate of the box - right: - type: number - example: 1019 - description: Right coordinate of the box - top: - type: number - example: 73 - description: Top coordinate of the box - class: - type: string - example: person - description: Detected object - confidence: - type: number - example: 1 - description: Confidence of the detected object. Higher confidence, more accurate the detected object. - object id: - type: number - example: 0 - description: Detected object id - message: - type: string - example: Successfully Processed - description: Detail description on the API status - status: - type: string - example: Success - description: The status of the API call success/failure - unauthorized: - type: object - properties: - message: - type: string - example: Missing Authentication Token - status: - type: string - example: Failure - forbidden: - type: object - properties: - message: - type: string - example: Access Denied Unauthorized User - status: - type: string - example: Failure - paymentrequired: - type: object - properties: - message: - type: string - example: Insufficient Credits Kindly Top Up - status: - type: string - example: Failure - notfound: - type: object - properties: - message: - type: string - example: Invalid Request URL - status: - type: string - example: Failure - servererror: - type: object - properties: - message: - type: string - example: Internal Server Error - status: - type: string - example: Failure - gatewaytimeout: - type: object - properties: - message: - type: string - example: Request Timeout - status: - type: string - example: Failure - invalidinput: - type: object - properties: - message: - type: string - example: Invalid Input - status: - type: string - example: Failure - inputfieldmissing: - type: object - properties: - message: - type: string - example: Input Field Missing - status: - type: string - example: Failure - inputlimitexceeded: - type: object - properties: - message: - type: string - example: Input Limit Exceeded - status: - type: string - example: Failure - - versions: - type: object - properties: - v1.0.0: - type: array - items: - oneOf: - - type: string - example: Published Date - Dec 31, 2020 - description: Standardizing Output JSON - v0.1.0: - type: array - items: - oneOf: - - type: string - example: Published Date - May 15,2020 - description: Initial version release - input: - type: object - required: - - image_base64 - properties: - image_base64: - x-name: image_base64 - type: string - default: true - example: /9j/4AAQSkZJRgABAQEASABIAAD/2wBDAAMCAgMCAgMDAwMEAwMEBQgFBQQEBQoHBwYIDAoMDAsKCwsNDhIQDQ4RDgsLEBYQERMUFRUVDA8XGBYUG... - description: |+ - Input image file in base64 format. - - Supported formats: bmp, dib, exr, hdr, jpeg, jpg, jpe, jp2, png, pic, pbm, pgm, ppm, pxm, pnm, ras, sr, tiff, tif, webp. - securitySchemes: - APIAuthorizer: - type: apiKey - name: x-api-key - in: header - x-amazon-apigateway-authtype: custom - description: Authentication is done using the x-api-key in the request header diff --git a/yaml/online_automatic_speech_recognition_eng_sg.yaml b/yaml/online_automatic_speech_recognition_eng_sg.yaml deleted file mode 100644 index d74750dfa..000000000 --- a/yaml/online_automatic_speech_recognition_eng_sg.yaml +++ /dev/null @@ -1,17 +0,0 @@ -# This is a testing yaml file fir MS that does not have a proper yaml documentation -# API Documentation Platfrom will check if the yaml file has a "html" key -# If have "html", will read HTML content and hide all other API documentation element -info: - title: Online Automatic Speech Recognition ENG (SG) - description: >- - This Utility microservice converts audio format to the WAV format.

The encoding scheme, bitrate, sample rate of the output WAV are to be specified.

Authentication:

Authentication is done using the x-api-key in the request header. - version: '0.1.0' -# tags must include in to the documentation, to read the description text for published date -tags: -- name: "v0.1.0" - description: "Published Date - Apr 17, 2020" -html: |+ -
- -
diff --git a/yaml/online_command_automatic_speech_recognition_eng_sg.yaml b/yaml/online_command_automatic_speech_recognition_eng_sg.yaml deleted file mode 100644 index 8dbaeec6a..000000000 --- a/yaml/online_command_automatic_speech_recognition_eng_sg.yaml +++ /dev/null @@ -1,10 +0,0 @@ -info: - title: Online Command Automatic Speech Recognition ENG (SG) - version: '0.1.0' -# tags must include in to the documentation, to read the description text for published date -tags: -- name: "v0.1.0" - description: "Published Date - Aug 31, 2020" -html: |+ - diff --git a/yaml/page_profiler_eng.yaml b/yaml/page_profiler_eng.yaml deleted file mode 100644 index 780eb4217..000000000 --- a/yaml/page_profiler_eng.yaml +++ /dev/null @@ -1,255 +0,0 @@ - openapi: 3.0.1 - info: - title: Page Profiler ENG - description: |+ - This NLP microservice retrieves web content in English from the input URL. - - From the web content, the microservice then applies natural language processing to extracts named-entities and returns the output. - - The named-entity classes extracted are persons, locations, organisations and miscellaneous.

This microservice automatically extracts structured information from unstructured text data such as chatlogs, emails, news articles, etc. - - Do ensure that your URL text is in the **ASCII format**. - x-additionalinfo: |+ - Suggested Use Cases: - - Gain insights from online customers - extract structured information from unstructured text data such as chatlogs, emails, news articles, etc. to find and label fields within a document and then apply sentiment analysis to understand customer opinions to find actionable product and UX insights. - - - Entity analysis - identify entities within documents, including receipts, invoices, and contracts; and label them by types such as date, person, contact information, organization, location, events, products, and media. - version: '1.0.0' - x-subscribelink: page_profiler_eng - x-depreciated: "Oct 15, 2020" - servers: - - url: 'https://apis.sentient.io' - tags: - - name: "v1.0.0" - description: "Published Date - May 15, 2020" - paths: - /microservices/nlp/pageprofiler/v1.0/getpredictions: - post: - tags: - - v1.0.0 - responses: - '200': - description: success response - content: - application/json: - schema: - $ref: '#/components/schemas/success' - example: {"LOC": ["Beijing","Atlanta","Indonesia"], "MISC": [Twiight,Singaporean],"ORG": [CNA,Singapore Parliament],"PER": [Skip Navigation,Bookmarks]} - '401': - description: Unauthorized - content: - application/json: - schema: - $ref: '#/components/schemas/unauthorized' - '402': - description: Payment Required - content: - application/json: - schema: - $ref: '#/components/schemas/paymentrequired' - '403': - description: Forbidden - content: - application/json: - schema: - $ref: '#/components/schemas/forbidden' - '404': - description: Not Found - content: - application/json: - schema: - $ref: '#/components/schemas/notfound' - '419': - description: Not Found - content: - application/json: - schema: - $ref: '#/components/schemas/inputfieldmissing' - '420': - description: Not Found - content: - application/json: - schema: - $ref: '#/components/schemas/inputlimitexceeded' - '422': - description: Invalid Input - content: - application/json: - schema: - $ref: '#/components/schemas/invalidinput' - '500': - description: Internal Server Error - content: - application/json: - schema: - $ref: '#/components/schemas/servererror' - '504': - description: Gateway Timeout - content: - application/json: - schema: - $ref: '#/components/schemas/gatewaytimeout' - security: - - APIAuthorizer: [] - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/input' - required: true - components: - schemas: - success: - type: object - properties: - LOC: - type: array - example: ["Beijing","Atlanta","Indonesia"] - description: "name of location found in the text string" - MISC: - type: array - example: [Twiight,Singaporean] - description: "name of miscellaneous names found in the text string" - ORG: - type: array - example: [CNA,Singapore Parliament] - description: "name of organizations found in the text string" - PER: - type: array - example: [Skip Navigation,Bookmarks] - description: "name of persons found in the text string" - - unauthorized: - type: object - properties: - message: - type: string - example: Missing Authentication Token - status: - type: string - example: Failure - forbidden: - type: object - properties: - message: - type: string - example: Access Denied Unauthorized User - status: - type: string - example: Failure - paymentrequired: - type: object - properties: - message: - type: string - example: Insufficient Credits Kindly Top Up - status: - type: string - example: Failure - notfound: - type: object - properties: - message: - type: string - example: Invalid Request URL - status: - type: string - example: Failure - servererror: - type: object - properties: - message: - type: string - example: Internal Server Error - status: - type: string - example: Failure - invalidinput: - type: object - properties: - message: - type: string - example: Invalid Input - status: - type: string - example: Failure - gatewaytimeout: - type: object - properties: - message: - type: string - example: Request Timeout - status: - type: string - example: Failure - inputfieldmissing: - type: object - properties: - message: - type: string - example: Input Field Missing - status: - type: string - example: Failure - inputlimitexceeded: - type: object - properties: - message: - type: string - example: Input Limit Exceeded - status: - type: string - example: Failure - versions: - type: object - properties: - v2.1.0: - type: array - items: - oneOf: - - type: string - example: Published Date - Oct 30, 2020 - description: Partial URL support - v2.0.0: - type: array - items: - oneOf: - - type: string - example: Published Date - Sep 30, 2020 - description: Standardizing Output JSON - v1.0.0: - type: array - items: - oneOf: - - type: string - example: Published Date - May 15, 2018 - description: Swaping the NLP with Named-Entity Recognition ENG - v0.1.0: - type: array - items: - oneOf: - - type: string - example: Published Date - Apr 16, 2018 - description: Initial version release - input: - type: object - required: - - url - properties: - url: - x-name: url - type: string - default: true - example: https://www.sentient.io/en/ - description: |+ - The URL of the page to be profiled. - - Note that the URL has to be spelt in full, including "https://www." - - securitySchemes: - APIAuthorizer: - type: apiKey - name: x-api-key - in: header - x-amazon-apigateway-authtype: custom - description: Authentication is done using the x-api-key in the request header diff --git a/yaml/page_profiler_eng_v2.0.yaml b/yaml/page_profiler_eng_v2.0.yaml deleted file mode 100644 index d36399d65..000000000 --- a/yaml/page_profiler_eng_v2.0.yaml +++ /dev/null @@ -1,228 +0,0 @@ - openapi: 3.0.1 - info: - title: Page Profiler ENG - description: |+ - This NLP microservice retrieves web content in English from the input URL. - - From the web content, the microservice then applies natural language processing to extracts named-entities and returns the output. - - The named-entity classes extracted are persons, locations, organisations and miscellaneous.

This microservice automatically extracts structured information from unstructured text data such as chatlogs, emails, news articles, etc. - x-subscribelink: page_profiler_eng - version: '2.0' - servers: - - url: 'https://apis.sentient.io' - tags: - - name: "v2.0" - description: "Published Date - Sep 30, 2020" - paths: - /microservices/nlp/pageprofiler/v2/getpredictions: - post: - tags: - - v2.0 - responses: - '200': - description: success response - content: - application/json: - schema: - $ref: '#/components/schemas/success' - example: {"message":"SuccessfullyProcessed","results":{"loc":["Hubei","Singapore","SINGAPORE","China","Immigration"],"misc":["ICA.They"],"org":["ImmigrationandCheckpointsAuthority","ICA","LOA"]},"status":"Success"} - '401': - description: Unauthorized - content: - application/json: - schema: - $ref: '#/components/schemas/unauthorized' - '402': - description: Payment Required - content: - application/json: - schema: - $ref: '#/components/schemas/paymentrequired' - '403': - description: Forbidden - content: - application/json: - schema: - $ref: '#/components/schemas/forbidden' - '404': - description: Not Found - content: - application/json: - schema: - $ref: '#/components/schemas/notfound' - '419': - description: Not Found - content: - application/json: - schema: - $ref: '#/components/schemas/inputfieldmissing' - '420': - description: Not Found - content: - application/json: - schema: - $ref: '#/components/schemas/inputlimitexceeded' - '500': - description: Internal Server Error - content: - application/json: - schema: - $ref: '#/components/schemas/servererror' - '504': - description: Gateway Timeout - content: - application/json: - schema: - $ref: '#/components/schemas/gatewaytimeout' - security: - - APIAuthorizer: [] - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/input' - required: true - components: - schemas: - success: - type: object - properties: - results: - type: object - example: { "" } - description: Json Object of returned results - properties: - loc: - type: array - example: ["Nat","Sentient.io","Home","Inte","CONTACT","Join"] - description: "name of location found in the text string" - misc: - type: array - example: ["Sentient.io","English"] - description: "name of misc found in the text string" - org: - type: array - example: ["Our Clients","AI","APIs","Sentient.io","Our Technology Partners","Named Entity Recognition","Our Investors"] - description: "name of org found in the text string" - per: - type: array - example: ["Sentient.io","Speech","LinkedIn"] - description: "name of persons found in the text string" - message: - type: string - example: Successfully Processed - description: Detail description on the API status - status: - type: string - example: Success - description: The status of the API call success/failure - unauthorized: - type: object - properties: - message: - type: string - example: Missing Authentication Token - status: - type: string - example: Failure - forbidden: - type: object - properties: - message: - type: string - example: Access Denied Unauthorized User - status: - type: string - example: Failure - paymentrequired: - type: object - properties: - message: - type: string - example: Insufficient Credits Kindly Top Up - status: - type: string - example: Failure - notfound: - type: object - properties: - message: - type: string - example: Invalid Request URL - status: - type: string - example: Failure - servererror: - type: object - properties: - message: - type: string - example: Internal Server Error - status: - type: string - example: Failure - gatewaytimeout: - type: object - properties: - message: - type: string - example: Request Timeout - status: - type: string - example: Failure - inputfieldmissing: - type: object - properties: - message: - type: string - example: Input Field Missing - status: - type: string - example: Failure - inputlimitexceeded: - type: object - properties: - message: - type: string - example: Input Limit Exceeded - status: - type: string - example: Failure - versions: - type: object - properties: - v2.0: - type: array - items: - oneOf: - - type: string - example: Published Date - Sep 30, 2020 - description: Updated version release - v1.0: - type: array - items: - oneOf: - - type: string - example: Published Date - Apr 11, 2018 - description: Initial version release - input: - type: object - required: - - url - properties: - url: - x-name: url - type: string - default: true - example: https://www.sentient.io/en/ - description: |+ - The URL of the page to be profile. Kindly note that the URL has to be spelt in full, including "https://www." - - securitySchemes: - APIAuthorizer: - type: apiKey - name: x-api-key - in: header - x-amazon-apigateway-authtype: custom - description: Authentication is done using the x-api-key in the request header diff --git a/yaml/page_profiler_eng_v2.1.yaml b/yaml/page_profiler_eng_v2.1.yaml deleted file mode 100644 index 5d3d6f532..000000000 --- a/yaml/page_profiler_eng_v2.1.yaml +++ /dev/null @@ -1,269 +0,0 @@ - openapi: 3.0.1 - info: - title: Page Profiler ENG - description: |+ - This NLP microservice retrieves web content in English from the input URL. - - From the web content, the microservice then applies natural language processing to extracts named-entities and returns the output. - - The named-entity classes extracted are persons, locations, organisations and miscellaneous.

This microservice automatically extracts structured information from unstructured text data such as chatlogs, emails, news articles, etc. - x-subscribelink: page_profiler_eng - x-additionalinfo: |+ - Suggested Use Cases: - - Gain insights from online customers - extract structured information from unstructured text data such as chatlogs, emails, news articles, etc. to find and label fields within a document and then apply sentiment analysis to understand customer opinions to find actionable product and UX insights. - - Entity analysis - identify entities within documents, including receipts, invoices, and contracts; and label them by types such as date, person, contact information, organization, location, events, products, and media. - version: '2.1.1' - servers: - - url: 'https://apis.sentient.io' - tags: - - name: "v2.1.1" - description: "Published Date - Dec 04, 2020" - paths: - /microservices/nlp/pageprofiler/v2/getpredictions: - post: - tags: - - v2.1.1 - responses: - '200': - description: success response - content: - application/json: - schema: - $ref: '#/components/schemas/success' - example: {"message":"SuccessfullyProcessed","results":{"loc":["Hubei","Singapore","SINGAPORE","China","Immigration"],"misc":["ICA.They"],"org":["ImmigrationandCheckpointsAuthority","ICA","LOA"]},"status":"Success"} - '401': - description: Unauthorized - content: - application/json: - schema: - $ref: '#/components/schemas/unauthorized' - '402': - description: Payment Required - content: - application/json: - schema: - $ref: '#/components/schemas/paymentrequired' - '403': - description: Forbidden - content: - application/json: - schema: - $ref: '#/components/schemas/forbidden' - '404': - description: Not Found - content: - application/json: - schema: - $ref: '#/components/schemas/notfound' - '419': - description: Not Found - content: - application/json: - schema: - $ref: '#/components/schemas/inputfieldmissing' - '413': - description: Not Found - content: - application/json: - schema: - $ref: '#/components/schemas/inputlimitexceeded' - '415': - description: Invalid Input - content: - application/json: - schema: - $ref: '#/components/schemas/invalidinput' - '500': - description: Internal Server Error - content: - application/json: - schema: - $ref: '#/components/schemas/servererror' - '504': - description: Gateway Timeout - content: - application/json: - schema: - $ref: '#/components/schemas/gatewaytimeout' - security: - - APIAuthorizer: [] - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/input' - required: true - components: - schemas: - success: - type: object - properties: - results: - type: object - example: { "" } - description: Json Object of returned results - properties: - loc: - type: array - example: ["Nat","Sentient.io","Home","Inte","CONTACT","Join"] - description: "name of location found in the text string" - misc: - type: array - example: ["Sentient.io","English"] - description: "name of misc found in the text string" - org: - type: array - example: ["Our Clients","AI","APIs","Sentient.io","Our Technology Partners","Named Entity Recognition","Our Investors"] - description: "name of org found in the text string" - per: - type: array - example: ["Sentient.io","Speech","LinkedIn"] - description: "name of persons found in the text string" - message: - type: string - example: Successfully Processed - description: Detail description on the API status - status: - type: string - example: Success - description: The status of the API call success/failure - unauthorized: - type: object - properties: - message: - type: string - example: Missing Authentication Token - status: - type: string - example: Failure - forbidden: - type: object - properties: - message: - type: string - example: Access Denied Unauthorized User - status: - type: string - example: Failure - paymentrequired: - type: object - properties: - message: - type: string - example: Insufficient Credits Kindly Top Up - status: - type: string - example: Failure - notfound: - type: object - properties: - message: - type: string - example: Invalid Request URL - status: - type: string - example: Failure - servererror: - type: object - properties: - message: - type: string - example: Internal Server Error - status: - type: string - example: Failure - gatewaytimeout: - type: object - properties: - message: - type: string - example: Request Timeout - status: - type: string - example: Failure - inputfieldmissing: - type: object - properties: - message: - type: string - example: Input Field Missing - status: - type: string - example: Failure - inputlimitexceeded: - type: object - properties: - message: - type: string - example: Input Limit Exceeded - status: - type: string - example: Failure - invalidinput: - type: object - properties: - message: - type: string - example: Invalid Input - status: - type: string - example: Failure - versions: - type: object - properties: - v2.1.1: - type: array - items: - oneOf: - - type: string - example: Published Date - Dec 04, 2020 - description: Patch Update - v2.1.0: - type: array - items: - oneOf: - - type: string - example: Published Date - Oct 30, 2020 - description: Partial URL support - v2.0.0: - type: array - items: - oneOf: - - type: string - example: Published Date - Sep 30, 2020 - description: Standardizing Output JSON - v1.0.0: - type: array - items: - oneOf: - - type: string - example: Published Date - May 15, 2018 - description: Swap the NLP with Named-Entity Recognition ENG - v0.1.0: - type: array - items: - oneOf: - - type: string - example: Published Date - Apr 16, 2018 - description: Initial version release - input: - type: object - required: - - url - properties: - url: - x-name: url - type: string - default: true - example: https://www.sentient.io/en/ - description: |+ - The URL of the page to be profiled. - - Supported formats: ASCII only - securitySchemes: - APIAuthorizer: - type: apiKey - name: x-api-key - in: header - x-amazon-apigateway-authtype: custom - description: Authentication is done using the x-api-key in the request header diff --git a/yaml/page_profiler_jp.yaml b/yaml/page_profiler_jp.yaml deleted file mode 100644 index 853994000..000000000 --- a/yaml/page_profiler_jp.yaml +++ /dev/null @@ -1,335 +0,0 @@ - openapi: 3.0.1 - info: - title: Page Profiler JP - description: |+ - This NLP microservice retrieves web content in Japanese from the input URL. From the web content, the microservice then applies natural language processing to extracts named-entities and returns the output. - - The named-entity classes extracted are persons, locations, organisations and miscellaneous. - - This microservice automatically extracts structured information from unstructured text data such as chatlogs, emails, news articles, etc. - x-additionalinfo: |+ - Suggested Use Cases: - - Insights from online customers - extract structured information from unstructured text data such as chatlogs, emails, news articles, etc. to find and label fields within a document and then apply sentiment analysis to understand customer opinions to find actionable product and UX insights. - - - Entity analysis - identify entities within documents, including receipts, invoices, and contracts; and label them by types such as date, person, contact information, organization, location, events, products, and media. - version: '1.1.0' - x-subscribelink: page_profiler_jp - servers: - - url: 'https://apis.sentient.io' - tags: - - name: "v1.1.0" - description: "Published Date - Dec 09, 2020" - paths: - /microservices/nlp/pageprofilerjp/v1/getpredictions: - post: - tags: - - v1.1.0 - responses: - '200': - description: success response - content: - application/json: - schema: - $ref: '#/components/schemas/success' - example: - message: Successfully Processed - results: - age: - - '56' - countx_other: - - 2稿 - - 8口 - doctrine_method_other: - - 険所コホ特室りょ - n_event: - - 受1 - numex_other: - - 百経 - ordinal_number: - - 30弾 - person: - - くぼ - - 壮 - - 琢紫 - - ナユ - product_other: - - 都合ヘラアニ限 - - 議帳 - show_organization: - - 左成相態 - status: Success - '401': - description: Unauthorized - content: - application/json: - schema: - $ref: '#/components/schemas/unauthorized' - '402': - description: Payment Required - content: - application/json: - schema: - $ref: '#/components/schemas/paymentrequired' - '403': - description: Forbidden - content: - application/json: - schema: - $ref: '#/components/schemas/forbidden' - '404': - description: Not Found - content: - application/json: - schema: - $ref: '#/components/schemas/notfound' - '419': - description: Not Found - content: - application/json: - schema: - $ref: '#/components/schemas/inputfieldmissing' - '413': - description: Not Found - content: - application/json: - schema: - $ref: '#/components/schemas/inputlimitexceeded' - '415': - description: Invalid Input - content: - application/json: - schema: - $ref: '#/components/schemas/invalidinput' - '500': - description: Internal Server Error - content: - application/json: - schema: - $ref: '#/components/schemas/servererror' - '504': - description: Gateway Timeout - content: - application/json: - schema: - $ref: '#/components/schemas/gatewaytimeout' - security: - - APIAuthorizer: [] - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/input' - required: true - components: - schemas: - success: - type: object - properties: - results: - type: object - example: { "" } - description: Json Object of returned results - properties: - age: - type: array - items: - type: string - example: - - 56 - description: "age details found in the text string" - countx_other: - type: array - items: - type: string - example: - - 2稿 - - 8口 - description: "countx other details found in the text string" - doctrine_method_other: - type: array - items: - type: string - example: - - 険所コホ特室りょ - description: "doctrine method in the text string" - n_event: - type: array - items: - type: string - example: - - 受1 - description: "n_event in the text string" - numex_other: - type: array - items: - type: string - example: - - 受1 - description: "numex_other details found in the text string" - ordinal_number: - type: array - items: - type: string - example: - -30弾 - description: "ordinal_number details in the text string" - person: - type: array - items: - type: string - example: - - person - - 壮 - - 琢紫 - - ナユ - description: "person details found in the text string" - product_other: - type: array - items: - type: string - example: - - 都合ヘラアニ限 - - 議帳 - description: "product found in the text string" - show_organization: - type: array - items: - type: string - example: - - 左成相態 - description: "organization details found in the text string" - message: - type: string - example: Successfully Processed - description: Detail description on the API status - status: - type: string - example: Success - description: The status of the API call success/failure - - unauthorized: - type: object - properties: - message: - type: string - example: Missing Authentication Token - status: - type: string - example: Failure - forbidden: - type: object - properties: - message: - type: string - example: Access Denied Unauthorized User - status: - type: string - example: Failure - paymentrequired: - type: object - properties: - message: - type: string - example: Insufficient Credits Kindly Top Up - status: - type: string - example: Failure - invalidinput: - type: object - properties: - message: - type: string - example: Invalid Input - status: - type: string - example: Failure - notfound: - type: object - properties: - message: - type: string - example: Invalid Request URL - status: - type: string - example: Failure - servererror: - type: object - properties: - message: - type: string - example: Internal Server Error - status: - type: string - example: Failure - gatewaytimeout: - type: object - properties: - message: - type: string - example: Request Timeout - status: - type: string - example: Failure - inputfieldmissing: - type: object - properties: - message: - type: string - example: Input Field Missing - status: - type: string - example: Failure - inputlimitexceeded: - type: object - properties: - message: - type: string - example: Input Limit Exceeded - status: - type: string - example: Failure - versions: - type: object - properties: - v1.1.0: - type: array - items: - oneOf: - - type: string - example: Published Date - Dec 09, 2020 - description: Patch Update - v1.0.0: - type: array - items: - oneOf: - - type: string - example: Published Date - Oct 30, 2020 - description: Partial URL support - v0.1.0: - type: array - items: - oneOf: - - type: string - example: Published Date - Sep 30, 2020 - description: Initial version release - input: - type: object - required: - - url - properties: - url: - x-name: url - type: string - default: true - example: https://www.bbc.com/japanese - description: |+ - The URL of the page to be profiled. - - Supported formats: ASCII only - securitySchemes: - APIAuthorizer: - type: apiKey - name: x-api-key - in: header - x-amazon-apigateway-authtype: custom - description: Authentication is done using the x-api-key in the request header diff --git a/yaml/page_profiler_thai.yaml b/yaml/page_profiler_thai.yaml deleted file mode 100644 index 396977e39..000000000 --- a/yaml/page_profiler_thai.yaml +++ /dev/null @@ -1,346 +0,0 @@ - openapi: 3.0.1 - info: - title: Page Profiler THAI - description: |+ - This NLP microservice retrieves web content in Thai from the input URL. From the web content, the microservice then applies natural language processing to extracts named-entities and returns the output. - - The named-entity classes extracted are persons, locations, organisations and miscellaneous. - - This microservice automatically extracts structured information from unstructured text data such as chatlogs, emails, news articles, etc. - x-additionalinfo: |+ - Suggested Use Cases: - - Insights from online customers - extract structured information from unstructured text data such as chatlogs, emails, news articles, etc. to find and label fields within a document and then apply sentiment analysis to understand customer opinions to find actionable product and UX insights. - - - Entity analysis - identify entities within documents, including receipts, invoices, and contracts; and label them by types such as date, person, contact information, organization, location, events, products, and media. - version: '1.1.0' - x-subscribelink: page_profiler_thai - servers: - - url: 'https://apis.sentient.io' - tags: - - name: "v1.1.0" - description: "Published Date - Dec 09, 2020" - paths: - /microservices/nlp/pageprofilerthai/v1/getpredictions: - post: - tags: - - v1.1.0 - responses: - '200': - description: success response - content: - application/json: - schema: - $ref: '#/components/schemas/success' - example: - message: Successfully Processed - results: - law: - - รุ้ง" จัดกิจกรรม"ตามหานาย" หน้ากองพันทหารม้าที่ 4 กองพล 1 รอ.ทวงถามความรับผิดชอบ - 28 กันยายน 2563 - ติดต่อโฆษณาออนไลน์ Worarak - location: - - กทม. - - เมียนมา - - อินเดีย - - ไทย - money: - - 7หมื่นชิ้น - - 33 ล้าน - organization: - - ทัพเพื่อไทย - - กรมอุตุฯ - - รฟม. - - มหาดไทย - - ปธ.อำนวยการ - person: - - น้องวีจิ - - สักงูเขียว รับผิดขอโทษ - - บิ๊กตู่ - - มาดามเดียร์"ติงนโยบายยกเว้นภาษี เปิดช่องรร.ทำกำไร - - ชูศักดิ์ - - รร.สารสาสน์ - - บิ๊กบราเธอร์" - - ครูจุ๋ม' - - ครูจุ๋ม" - status: Success - - '401': - description: Unauthorized - content: - application/json: - schema: - $ref: '#/components/schemas/unauthorized' - '402': - description: Payment Required - content: - application/json: - schema: - $ref: '#/components/schemas/paymentrequired' - '403': - description: Forbidden - content: - application/json: - schema: - $ref: '#/components/schemas/forbidden' - '404': - description: Not Found - content: - application/json: - schema: - $ref: '#/components/schemas/notfound' - '419': - description: Not Found - content: - application/json: - schema: - $ref: '#/components/schemas/inputfieldmissing' - '413': - description: Not Found - content: - application/json: - schema: - $ref: '#/components/schemas/inputlimitexceeded' - '415': - description: Invalid Input - content: - application/json: - schema: - $ref: '#/components/schemas/invalidinput' - '500': - description: Internal Server Error - content: - application/json: - schema: - $ref: '#/components/schemas/servererror' - '504': - description: Gateway Timeout - content: - application/json: - schema: - $ref: '#/components/schemas/gatewaytimeout' - security: - - APIAuthorizer: [] - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/input' - required: true - components: - schemas: - success: - type: object - properties: - results: - type: object - example: { "" } - description: Json Object of returned results - properties: - law: - x-name: law - type: array - example: [พ.ร.บ.โรคระบาด พ.ศ.2499, รัฐธรรมนูญ] - description: "law details found in the text string" - location: - x-name: location - type: array - example: - - ประเทศไทย - - มาเลเซีย - - ทะเลอันดามัน - - กรุงเทพมหานคร - - อินโดนีเซีย - - ราชอาณาจักรไทย - - อินเดียทางทะเลอันดามันทางตะวันตกเฉียงใต้ - - ลาวทางทิศตะวันออกติดกับลาว - - เอเชียตะวันออกเฉียงใต้ - - เวียดนาม - - ประเทศพม่า - - กัมพูชาทางทิศใต้ติดกับอ่าวไทย - description: "location found in the text string" - organization: - x-name: organization - type: array - example: - - รัฐสภา - description: "organization found in the text string" - date: - x-name: date - type: array - example: [2/21/2004, 16 ก.พ., จันทร์] - description: "date found in the text string" - money: - x-name: money - type: array - example: [2.7 ล้านบาท, 2,000 บาท] - description: "amount of currency found in the text string" - time: - x-name: time - type: array - example: [16.30 น., 5 วัน, 1-3 ปี] - description: "time found in the text string" - email: - x-name: email - type: array - example: [info@nrpsc.ac.th] - description: "email id found in the text string" - len: - x-name: len - type: array - example: [30 กิโลเมตร, 5 กม.] - description: "distance in km found in the text string" - person: - x-name: person - type: array - example: [น.พ.จรัล, นางประนอม ทองจันทร์] - description: "name of person found in the text string" - phone: - x-name: phone - type: array - example: [0 2670 8888] - description: "date found in the text string" - url: - x-name: url - type: array - example: [http://www.bangkokhealth.com/] - description: "url in the text string" - zip: - x-name: zip - type: array - example: [10400] - description: "zipcode found in the text string" - - message: - type: string - example: Successfully Processed - description: Detail description on the API status - status: - type: string - example: Success - description: The status of the API call success/failure - unauthorized: - type: object - properties: - message: - type: string - example: Missing Authentication Token - status: - type: string - example: Failure - forbidden: - type: object - properties: - message: - type: string - example: Access Denied Unauthorized User - status: - type: string - example: Failure - paymentrequired: - type: object - properties: - message: - type: string - example: Insufficient Credits Kindly Top Up - status: - type: string - example: Failure - notfound: - type: object - properties: - message: - type: string - example: Invalid Request URL - status: - type: string - example: Failure - invalidinput: - type: object - properties: - message: - type: string - example: Invalid Input - status: - type: string - example: Failure - servererror: - type: object - properties: - message: - type: string - example: Internal Server Error - status: - type: string - example: Failure - gatewaytimeout: - type: object - properties: - message: - type: string - example: Request Timeout - status: - type: string - example: Failure - inputfieldmissing: - type: object - properties: - message: - type: string - example: Input Field Missing - status: - type: string - example: Failure - inputlimitexceeded: - type: object - properties: - message: - type: string - example: Input Limit Exceeded - status: - type: string - example: Failure - versions: - type: object - properties: - v1.1.0: - type: array - items: - oneOf: - - type: string - example: Published Date - Dec 09, 2020 - description: Patch Update - v1.0.0: - type: array - items: - oneOf: - - type: string - example: Published Date - Oct 30, 2020 - description: Partial URL support - v0.1.0: - type: array - items: - oneOf: - - type: string - example: Published Date - Sep 30, 2020 - description: Initial version release - input: - type: object - required: - - url - properties: - url: - x-name: url - type: string - default: true - example: https://www.naewna.com/entertain/527527 - description: |+ - The URL of the page to be profiled. - - Supported formats: ASCII only - securitySchemes: - APIAuthorizer: - type: apiKey - name: x-api-key - in: header - x-amazon-apigateway-authtype: custom - description: Authentication is done using the x-api-key in the request header diff --git a/yaml/pdf_extractor.yaml b/yaml/pdf_extractor.yaml deleted file mode 100644 index 69e7aaf66..000000000 --- a/yaml/pdf_extractor.yaml +++ /dev/null @@ -1,267 +0,0 @@ -openapi: 3.0.1 -info: - title: PDF Extractor - description: |+ - This Utility microservice extracts the text content of the input PDF document with the options to extract specific pages. - - It also extracts from password-protected PDFs, if the correct password is provided. - - Output format supported: plain text or HTML. - - Supported languages: Hindi, German, Spanish, Portuguese, French, Turkish, Italian, Russian, Arabic, Indonesian, Chinese, Japanese and Korean. - - The size of your PDF file should **not exceed 7 MB**. - x-additionalinfo: |+ - Suggested Use Cases: - - Used for pre/post processing of documents so that the output can paired with another microservice to address a specific solution. For example, text extracted from the PDF document can be used with a Voice microservice such as Text-to-Speech. - - - Can be used for solutions related to processing workflows that are document-heavy so that the user can focus on the more value-added decisions. Documents in a variety of formats can be taken in to return cleanly structured data. Examples included mortgage processing, procurement data etc. - version: '1.0.0' - x-subscribelink: pdf_extractor -servers: - - url: 'https://apis.sentient.io' -tags: -- name: "v1.0.0" - description: "Published Date - Jul 30, 2020" -paths: - /microservices/utility/pdfextractor/v1.0/getresults: - post: - tags: - - v1.0.0 - responses: - '200': - description: success response - content: - application/json: - schema: - $ref: '#/components/schemas/success' - example: - results: "\\n L 328/84 \\n Official Journal of the European Union \\n EN \\n - 18.12.2019 \\n DECISIONS \\n COMMISSION IMPLEMENTING DECISION (EU) 2019/2166 \\n - of 16 December 2019 \\n amending Implementing Decision 2014/908/EU as regards the - inclusion of Serbia and South Korea in \\n the lists of third countries and - \ territories whose supervisory and regulatory requirements" - message: Successfully Processed - status: Success - extracted_details: "[1, 3] pages are Extracted...." - '401': - description: Unauthorized - content: - application/json: - schema: - $ref: '#/components/schemas/unauthorized' - '402': - description: Payment Required - content: - application/json: - schema: - $ref: '#/components/schemas/paymentrequired' - '403': - description: Forbidden - content: - application/json: - schema: - $ref: '#/components/schemas/forbidden' - '404': - description: Not Found - content: - application/json: - schema: - $ref: '#/components/schemas/notfound' - '419': - description: Input Field Missing - content: - application/json: - schema: - $ref: '#/components/schemas/inputfieldmissing' - '413': - description: Input Limit Exceeded - content: - application/json: - schema: - $ref: '#/components/schemas/inputlimitexceeded' - '415': - description: Invalid Input - content: - application/json: - schema: - $ref: '#/components/schemas/invalidinput' - '500': - description: Internal Server Error - content: - application/json: - schema: - $ref: '#/components/schemas/servererror' - '504': - description: Gateway Timeout - content: - application/json: - schema: - $ref: '#/components/schemas/gatewaytimeout' - security: - - APIAuthorizer: [] - requestBody: - content: - multipart/form-data: - schema: - $ref: '#/components/schemas/input' -components: - schemas: - success: - type: object - properties: - results: - type: string - example: \n L 328/84 \n Official Journal of the European Union \n EN \n 18.12.2019 \n DECISIONS \n COMMISSION IMPLEMENTING DECISION (EU) 2019/2166 \n of 16 December 2019 \n amending Implementing Decision 2014/908/EU as regards the inclusion of Serbia and South Korea in \n the lists of third countries and territories whose supervisory and regulatory requirements - description: The result of the API call. - message: - type: string - example: Successfully Processed - description: Detail description on the API status - status: - type: string - example: Success - description: The status of the API call success/failure - extracted_details: - type: string - example: "[1, 3] pages are Extracted...." - description: Extracted page and file details - unauthorized: - type: object - properties: - message: - type: string - example: Missing Authentication Token - status: - type: string - example: Failure - forbidden: - type: object - properties: - message: - type: string - example: Access Denied Unauthorized User - status: - type: string - example: Failure - invalidinput: - type: object - properties: - message: - type: string - example: Invalid Input - status: - type: string - example: Failure - paymentrequired: - type: object - properties: - message: - type: string - example: Insufficient Credits Kindly Top Up - status: - type: string - example: Failure - notfound: - type: object - properties: - message: - type: string - example: Invalid Request URL - status: - type: string - example: Failure - servererror: - type: object - properties: - message: - type: string - example: Internal Server Error - status: - type: string - example: Failure - gatewaytimeout: - type: object - properties: - message: - type: string - example: Request Timeout - status: - type: string - example: Failure - inputfieldmissing: - type: object - properties: - message: - type: string - example: Input Field Missing - status: - type: string - example: Failure - inputlimitexceeded: - type: object - properties: - message: - type: string - example: Input Limit Exceeded - status: - type: string - example: Failure - versions: - type: object - properties: - v1.0.0: - type: array - items: - oneOf: - - type: string - example: Published Date - Jul 30, 2020 - description: Initial version release - input: - type: object - required: - - filePath - properties: - filePath: - type: string - format: binary - default: true - example: sample.pdf - description: Text-only PDF files are supported. Image or mixed PDF files are not recommended. - pageNumbers: - type: number - default: false - example: "1,3,6" - description: Page numbers, example 1,3,6. Default all pages - maxPages: - type: number - default: false - example: "3" - description: Maximum of page number. Default all pages - startPage: - type: number - default: false - example: "1" - description: Starting page number, if used endPage parameter is mandatory - endPage: - type: number - default: false - example: "5" - description: End of page number, if used startPage parameter is mandatory - convertType: - type: string - default: false - example: "txt" - description: Convertion type (txt / html). Default type is txt - passWord: - type: string - default: false - example: "xxxxxxxx" - description: Password for protected pdf - securitySchemes: - APIAuthorizer: - type: apiKey - name: x-api-key - in: header - x-amazon-apigateway-authtype: custom - description: Authentication is done using the x-api-key in the request header diff --git a/yaml/people_counting.yaml b/yaml/people_counting.yaml deleted file mode 100644 index 56f42c7b0..000000000 --- a/yaml/people_counting.yaml +++ /dev/null @@ -1,247 +0,0 @@ -openapi: 3.0.1 -info: - title: People Counting - description: |+ - This Computer Vision microservice tracks and counts people appearing in the input video. - - This microservice returns the number of people detected in that video, the likelihood of overestimation/underestimation, the first appearance and the duration and confidence of each person detected. - - The size of your image file should **not exceed 10 MB**, and the image dimension should be **least more than 416x416 pixels**. - x-additionalinfo: |+ - Suggested Use Cases: - - Improve visitor experience and optimize operations in retail, leisure, and other sectors - build services to count visitor traffic in venues, measure detailed movements and interactions, and visualize that data to better understand what is happening in within a certain spaces. For example, one can optimize traffic, staff and marketing strategies to increase conversion rates and profits with actionable data. Businesses can use visitor count as a benchmark to figure out the conversion rate for a certain spot to see the real performance. Efficiently allocating the number of staff according to hourly visitor traffic will also create value in terms of revenue, profit and  efficiency. - version: '0.1.0' - x-subscribelink: people_counting -servers: - - url: 'https://apis.sentient.io' -tags: -- name: "v0.1.0" - description: "Published Date - Jul 30, 2020" -paths: - /microservices/cv/peoplecounting/v0.1/getpredictions: - post: - tags: - - v0.1.0 - - responses: - '200': - description: success response - content: - application/json: - schema: - $ref: '#/components/schemas/success' - example: {'counter': '11 people', 'likelihood of overestimation': '76.0%', 'likelihood of underestimation': '39.0%', 'people': [{'person id: 001': ['first appearance: 1.28s', 'duration appeared: 7.66s', 'detection confidence: 77%', 'assigning confidence: 100%']}, {'person id: 002': ['first appearance: 3.34s', 'duration appeared: 7.03s', 'detection confidence: 73%', 'assigning confidence: 82.0%']}]} - - '401': - description: Unauthorized - content: - application/json: - schema: - $ref: '#/components/schemas/unauthorized' - '402': - description: Payment Required - content: - application/json: - schema: - $ref: '#/components/schemas/paymentrequired' - '403': - description: Forbidden - content: - application/json: - schema: - $ref: '#/components/schemas/forbidden' - '404': - description: Not Found - content: - application/json: - schema: - $ref: '#/components/schemas/notfound' - '419': - description: Input Field Missing - content: - application/json: - schema: - $ref: '#/components/schemas/inputfieldmissing' - '413': - description: Input Limit Exceeded - content: - application/json: - schema: - $ref: '#/components/schemas/inputlimitexceeded' - '415': - description: Invalid Input - content: - application/json: - schema: - $ref: '#/components/schemas/invalidinput' - '500': - description: Internal Server Error - content: - application/json: - schema: - $ref: '#/components/schemas/servererror' - '504': - description: Gateway Timeout - content: - application/json: - schema: - $ref: '#/components/schemas/gatewaytimeout' - security: - - APIAuthorizer: [] - - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/input' - required: true - - -components: - schemas: - success: - type: object - example: {'counter': '11 people', 'likelihood of overestimation': '76.0%', 'likelihood of underestimation': '39.0%', 'people': [{'person id: 001': ['first appearance: 1.28s', 'duration appeared: 7.66s', 'detection confidence: 77%', 'assigning confidence: 100%']}, {'person id: 002': ['first appearance: 3.34s', 'duration appeared: 7.03s', 'detection confidence: 73%', 'assigning confidence: 82.0%']}]} - properties: - counter: - type: string - example: 11 people - description: Number of people detected in video - likelihood of overestimation: - type: string - example: 76.0% - description: How likely would there be ID spikes causing counter to increase People - likelihood of underestimation: - type: string - example: 39.0% - description: How likely the model might miss out detecting people in the video - people: - type: array - example: [{'person ID: 001': ['first appearance: 1.28s', 'duration appeared: 7.66s', 'detection confidence: 77%', 'assigning confidence: 100%']}, {'person ID: 002': ['first appearance: 3.34s', 'duration appeared: 7.03s', 'detection confidence: 73%', 'assigning confidence: 82.0%']}] - description: Contains a list of individual Persons and their metadata. - items: - oneOf: - - type: object - example: {'person ID: 001': ['first appearance: 1.28s', 'duration appeared: 7.66s', 'detection confidence: 77%', 'assigning confidence: 100%']} - unauthorized: - type: object - properties: - message: - type: string - example: Missing Authentication Token - status: - type: string - example: Failure - restricted: - type: object - properties: - message: - type: string - example: The content is restricted - status: - type: string - example: Failure - forbidden: - type: object - properties: - message: - type: string - example: Access Denied Unauthorized User - status: - type: string - example: Failure - paymentrequired: - type: object - properties: - message: - type: string - example: Insufficient Credits Kindly Top Up - status: - type: string - example: Failure - invalidinput: - type: object - properties: - message: - type: string - example: Invalid Input - status: - type: string - example: Failure - notfound: - type: object - properties: - message: - type: string - example: Invalid Request - status: - type: string - example: Failure - servererror: - type: object - properties: - message: - type: string - example: Internal Server Error - status: - type: string - example: Failure - gatewaytimeout: - type: object - properties: - message: - type: string - example: Request Timeout - status: - type: string - example: Failure - inputfieldmissing: - type: object - properties: - message: - type: string - example: Input Field Missing - status: - type: string - example: Failure - inputlimitexceeded: - type: object - properties: - message: - type: string - example: Input Limit Exceeded - status: - type: string - example: Failure - versions: - type: object - properties: - v0.1.0: - type: array - items: - oneOf: - - type: string - example: Published Date - Jul 30,2020 - description: Initial version release - input: - type: object - required: - - video_base64 - properties: - video_base64: - x-name: video_base64 - type: string - default: true - example: UklGRkbiBABXQVZFZm10IBAAAAABA... - description: |+ - Input video in base64 format. - - Supported formats: acm, anm, apc, au, avi, bfi, bmp_pipe, bmv, codec2, dsf, dss, dvd, fifo, genh, gif, gxf, hls, iff, ifv, ipod, jpeg_pipe, jv, m4v, mjpeg, mlp, mlv, mov, mp2, mp3, mp4, pbm_pipe, pmp, png_pipe, psd_pipe, psp, rawvideo, sdp, sds, sdx, tmv, uncodedframecrc, vcd, vidc, vmd, voc, vpk, wav, webm, wsd, wsvqa, wtv, xmv, xpm_pipe. - - securitySchemes: - APIAuthorizer: - type: apiKey - name: x-api-key - in: header - x-amazon-apigateway-authtype: custom - description: Authentication is done using the x-api-key in the request header diff --git a/yaml/people_counting_v1.0.yaml b/yaml/people_counting_v1.0.yaml deleted file mode 100644 index bf40d0cc3..000000000 --- a/yaml/people_counting_v1.0.yaml +++ /dev/null @@ -1,259 +0,0 @@ -openapi: 3.0.1 -info: - title: People Counting - description: |+ - This Computer Vision microservice tracks and counts people appearing in the input video. - - This microservice returns the number of people detected in that video, the likelihood of overestimation/underestimation, the first appearance and the duration and confidence of each person detected. - - The size of your image file should **not exceed 10 MB**, and the image dimension should be **least more than 416x416 pixels**. - x-additionalinfo: |+ - Suggested Use Cases: - - Improve visitor experience and optimize operations in retail, leisure, and other sectors - build services to count visitor traffic in venues, measure detailed movements and interactions, and visualize that data to better understand what is happening in within a certain spaces. For example, one can optimize traffic, staff and marketing strategies to increase conversion rates and profits with actionable data. Businesses can use visitor count as a benchmark to figure out the conversion rate for a certain spot to see the real performance. Efficiently allocating the number of staff according to hourly visitor traffic will also create value in terms of revenue, profit and  efficiency. - version: '1.0.0' - x-subscribelink: people_counting -servers: - - url: 'https://dev-apis.sentient.io' -tags: -- name: "v1.0.0" - description: "Published Date - Dec 31, 2020" -paths: - /microservices/cv/peoplecounting/v1/getpredictions: - post: - tags: - - v1.0.0 - - responses: - '200': - description: success response - content: - application/json: - schema: - $ref: '#/components/schemas/success' - example: {"results": {"counter": 11, "likelihood of overestimation": 0.76,"likelihood of underestimation": 0.39,"people": [{"assigning confidence": 1,"bounding boxes": {"frame": {"294": {"bottom": 420,"left": 249,"right": 417,"top": 207},"300": {"bottom": 420,"left": 249,"right": 417,"top": 207}}},"detection confidence": 0.76,"duration appeared": 0.20689655172413793,"first appearance": 10.137931034482758,"person id": "011"}]},"message": "Successfully Processed","status": "Success"} - '401': - description: Unauthorized - content: - application/json: - schema: - $ref: '#/components/schemas/unauthorized' - '402': - description: Payment Required - content: - application/json: - schema: - $ref: '#/components/schemas/paymentrequired' - '403': - description: Forbidden - content: - application/json: - schema: - $ref: '#/components/schemas/forbidden' - '404': - description: Not Found - content: - application/json: - schema: - $ref: '#/components/schemas/notfound' - '419': - description: Input Field Missing - content: - application/json: - schema: - $ref: '#/components/schemas/inputfieldmissing' - '420': - description: Input Limit Exceeded - content: - application/json: - schema: - $ref: '#/components/schemas/inputlimitexceeded' - '422': - description: Invalid Input - content: - application/json: - schema: - $ref: '#/components/schemas/invalidinput' - '500': - description: Internal Server Error - content: - application/json: - schema: - $ref: '#/components/schemas/servererror' - '504': - description: Gateway Timeout - content: - application/json: - schema: - $ref: '#/components/schemas/gatewaytimeout' - security: - - APIAuthorizer: [] - - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/input' - required: true - - -components: - schemas: - success: - type: object - properties: - results: - type: object - description: The result of the API call. - example: { "" } - properties: - counter: - type: integer - example: 11 - description: Number of people detected in video - likelihood of overestimation: - type: number - format: float - example: 0.76 - description: How likely would there be ID spikes causing counter to increase People - likelihood of underestimation: - type: number - format: float - example: 0.39 - description: How likely the model might miss out detecting people in the video - people: - type: array - example: [{'person id': "001",'first appearance': 1.28, 'duration appeared': 7.66, 'detection confidence': 0.77, 'assigning confidence': 1,"bounding boxes": {"frame": {"294": {"bottom": 420,"left": 249,"right": 417,"top": 207},"300": {"bottom": 420,"left": 249,"right": 417,"top": 207}}}}] - description: Contains a list of individual Persons and their metadata. - items: - oneOf: - - type: object - example: {'person id': "001",'first appearance': 1.28, 'duration appeared': 7.66, 'detection confidence': 0.77, 'assigning confidence': 1,"bounding boxes": {"frame": {"294": {"bottom": 420,"left": 249,"right": 417,"top": 207},"300": {"bottom": 420,"left": 249,"right": 417,"top": 207}}}} - unauthorized: - type: object - properties: - message: - type: string - example: Missing Authentication Token - status: - type: string - example: Failure - restricted: - type: object - properties: - message: - type: string - example: The content is restricted - status: - type: string - example: Failure - forbidden: - type: object - properties: - message: - type: string - example: Access Denied Unauthorized User - status: - type: string - example: Failure - paymentrequired: - type: object - properties: - message: - type: string - example: Insufficient Credits Kindly Top Up - status: - type: string - example: Failure - invalidinput: - type: object - properties: - message: - type: string - example: Invalid Input - status: - type: string - example: Failure - notfound: - type: object - properties: - message: - type: string - example: Invalid Request - status: - type: string - example: Failure - servererror: - type: object - properties: - message: - type: string - example: Internal Server Error - status: - type: string - example: Failure - gatewaytimeout: - type: object - properties: - message: - type: string - example: Request Timeout - status: - type: string - example: Failure - inputfieldmissing: - type: object - properties: - message: - type: string - example: Input Field Missing - status: - type: string - example: Failure - inputlimitexceeded: - type: object - properties: - message: - type: string - example: Input Limit Exceeded - status: - type: string - example: Failure - versions: - type: object - properties: - v1.0.0: - type: array - items: - oneOf: - - type: string - example: Published Date - Dec 31, 2020 - description: Standardizing Output JSON - v0.1.0: - type: array - items: - oneOf: - - type: string - example: Published Date - Jul 30,2020 - description: Initial version release - input: - type: object - required: - - video_base64 - properties: - video_base64: - x-name: video_base64 - type: string - default: true - example: UklGRkbiBABXQVZFZm10IBAAAAABA... - description: |+ - Input video file in base64 format. - - Supported formats: acm, anm, apc, au, avi, bfi, bmp_pipe, bmv, codec2, dsf, dss, dvd, fifo, genh, gif, gxf, hls, iff, ifv, ipod, jpeg_pipe, jv, m4v, mjpeg, mlp, mlv, mov, mp2, mp3, mp4, pbm_pipe, pmp, png_pipe, psd_pipe, psp, rawvideo, sdp, sds, sdx, tmv, uncodedframecrc, vcd, vidc, vmd, voc, vpk, wav, webm, wsd, wsvqa, wtv, xmv, xpm_pipe. - - securitySchemes: - APIAuthorizer: - type: apiKey - name: x-api-key - in: header - x-amazon-apigateway-authtype: custom - description: Authentication is done using the x-api-key in the request header diff --git a/yaml/pki_key_generator.yaml b/yaml/pki_key_generator.yaml deleted file mode 100644 index 4bb84d56a..000000000 --- a/yaml/pki_key_generator.yaml +++ /dev/null @@ -1,216 +0,0 @@ -openapi: 3.0.1 -info: - title: PKI Key Generator - description: |+ - This Utiltiy microservice generates Public key and Private key pair, and is useful for encryption purposes. - x-additionalinfo: |+ - Suggested Use Cases: - - This microservice can be used to simplify the deployment, management, and security of one's enterprise PKI with a microservice that helps to automate time-consuming, risky, and error-prone infrastructure tasks, freeing users to focus on higher-value projects. - version: '0.1.0' - x-subscribelink: pki_key_generator -servers: - - url: 'https://apis.sentient.io' -tags: -- name: "v0.1.0" - description: "Published Date - Aug 30, 2019" -paths: - /microservices/utility/rsa_getkeys/v0.1/getresults: - post: - tags: - - v0.1.0 - responses: - '200': - description: success response - content: - application/json: - schema: - $ref: '#/components/schemas/success' - example: - keyLength: 1024 - publicKey: MIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQK... - privateKey: MIICdQIBADANBgkqhkiG9w0BAQEFAASCAl.... - '401': - description: Unauthorized - content: - application/json: - schema: - $ref: '#/components/schemas/unauthorized' - '402': - description: Payment Required - content: - application/json: - schema: - $ref: '#/components/schemas/paymentrequired' - '403': - description: Forbidden - content: - application/json: - schema: - $ref: '#/components/schemas/forbidden' - '404': - description: Not Found - content: - application/json: - schema: - $ref: '#/components/schemas/notfound' - '419': - description: Input Field Missing - content: - application/json: - schema: - $ref: '#/components/schemas/inputfieldmissing' - '413: - description: Input Limit Exceeded - content: - application/json: - schema: - $ref: '#/components/schemas/inputlimitexceeded' - '415': - description: Invalid Input - content: - application/json: - schema: - $ref: '#/components/schemas/invalidinput' - '500': - description: Internal Server Error - content: - application/json: - schema: - $ref: '#/components/schemas/servererror' - '504': - description: Gateway Timeout - content: - application/json: - schema: - $ref: '#/components/schemas/gatewaytimeout' - security: - - APIAuthorizer: [] - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/input' - required: true -components: - schemas: - success: - type: object - properties: - keyLength: - type: string - example: 1024 - description: byte value of generated key - publicKey: - type: string - example: MIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQK... - description: generated public key for encoding the text - privateKey: - type: string - example: MIICdQIBADANBgkqhkiG9w0BAQEFAASCAl.... - description: private key to decoding. this private key should decode when the text encoded by the public key which generate with this only. - unauthorized: - type: object - properties: - message: - type: string - example: Missing Authentication Token - status: - type: string - example: Failure - forbidden: - type: object - properties: - message: - type: string - example: Access Denied Unauthorized User - status: - type: string - example: Failure - paymentrequired: - type: object - properties: - message: - type: string - example: Insufficient Credits Kindly Top Up - status: - type: string - example: Failure - notfound: - type: object - properties: - message: - type: string - example: Invalid Request URL - status: - type: string - example: Failure - servererror: - type: object - properties: - message: - type: string - example: Internal Server Error - status: - type: string - example: Failure - invalidinput: - type: object - properties: - message: - type: string - example: Invalid Input - status: - type: string - example: Failure - gatewaytimeout: - type: object - properties: - message: - type: string - example: Request Timeout - status: - type: string - example: Failure - inputfieldmissing: - type: object - properties: - message: - type: string - example: Input Field Missing - status: - type: string - example: Failure - inputlimitexceeded: - type: object - properties: - message: - type: string - example: Input Limit Exceeded - status: - type: string - example: Failure - versions: - type: object - properties: - v0.1.0: - type: array - items: - oneOf: - - type: string - example: Published Date - Aug 30, 2019 - description: Initial version release - input: - type: object - properties: - bitcode: - type: string - example: "1" - default: true - description: bitcode to generate the key by byte-length. Maximum up to 5. Empty string and above 5 should be consider as 1. - securitySchemes: - APIAuthorizer: - type: apiKey - name: x-api-key - in: header - x-amazon-apigateway-authtype: custom - description: Authentication is done using the x-api-key in the request header diff --git a/yaml/residential_sales_and_rental_hdb_sg.yaml b/yaml/residential_sales_and_rental_hdb_sg.yaml deleted file mode 100644 index 3e298bc09..000000000 --- a/yaml/residential_sales_and_rental_hdb_sg.yaml +++ /dev/null @@ -1,496 +0,0 @@ -openapi: 3.0.1 -info: - title: HDB Residential Occupancy Status (SG) - x-subscribelink: residential_sales_and_rental_hdb_sg - description: |+ - This Data microservice retreives comprehensive details of each HDB block in Singapore including the number of units for each type of flats and whether they were sold or leased. Queries based on keywords and proximity to particular locations can be performed. Updated weekly. - - The HDB POTH programme makes selected public and non-public datasets available to developers and companies to improve their service offerings to benefit the lives of Singapore citizens. Sentient.io is proud to partner with HDB to manage and facilitate the sharing of data for the POTH Programme. - - **Note:** As this microservice uses the GET method, developers using this microservice must remember to have their app encode all the input values to be URL friendly (i.e. all spaces and special characters must be replaced). Here’s a reference on [URL encoding](https://www.w3schools.com/tags/ref_urlencode.ASP). - - x-additionalinfo : |+ - Suggested Use Cases: - - Information can be used to build a community app that benefits from geo-targeting family types and income groups by areas for non-profit charity/social organizations, real estate developers, property agencies, retail shops, marketing for educational sector, government agencies. - - **Refining queries in the filterdata field using filter types and match types** - - The filterdata fields use elasticsearch’s syntax (specifically filter types and match types) to help further refine search results and provide greater flexibility in structuring more sophisticated queries. - - **Filter Types:** - - A filter type is a logic operator to which the search results must fulfill certain logical conditions to be returned. The supported match types are: - - * **must** - All of the stated conditions must match. Equivalent to an AND operator. - - > {"must":[{"match_phrase":{"street":"serangoon north avenue 4"}}]} - - * **must_not** - All of the stated conditions must not match. Equivalent to a NOT operator. - > {"must_not":[{"match":{"postalcode":"570251"}}]} - - * **should** - At least one of the stated conditions should match. Equivalent to an OR operator. - > {"should":[{"match_phrase":{"street":"serangoon north avenue 4"}}]} - - * **filter** - All of the stated conditions that must match. However, results are not scored unlike the other filter types which returns results based on how well the conditions are met. - > {"filter":[{"range":{"year_completed":{"gte":1}}}]} - - For a more detailed guide on filter types, [refer to this](https://www.elastic.co/guide/en/elasticsearch/reference/6.8/query-dsl-bool-query.html). - - Filter types cannot be used alone and must be used in conjunction with a match type to complete the query. - - **Match Types:** - - A match type is a match operator nested within a filter type that fine-tunes the matching condition of the text search. The supported match types are: - - * **match** - Search within a full text field for a single word - > {"match":{"street":"serangoon"}} - * **match_phrase** - Search within a full text field - > {"match_phrase":{"street":"serangoon central"}} - * **match_phrase_prefix** - Search within a full text field with prefix - > {"match_phrase_prefix":{"street":"serangoon central"}} - * **term** - Returns results that contain an exact term in a provided field - > {"term":{"postalcode":"650634"}} - * **terms** - Returns results that contain one or more exact terms in a provided field - > {"terms":{"postalcode":["650634","650633"]}} - - * **range** - Returns results that contain terms within a stipulated range - - > {"range":{"4room_sold":{"gte":50}}} - > {"range":{"4room_sold":{"lte":50}}} - > {"range":{"4room_sold":{"gte":50,"lte":70}}} - - - * **exists** - Returns results that contain any indexed value for a field - - > {"exists":{ "field": "postalcode"}} - - For a more detailed guide to match types, [refer to this](https://www.elastic.co/guide/en/elasticsearch/reference/7.9/term-level-queries.html). - - **Forming sophisticated queries using combinations of filter types (in JSON)** - - Multiple filter types can be combined together in one query (written in JSON format) to form a very sophisticated query. Here’s one example below: - - > { - > "must":[{"match_phrase":{"street":"serangoon+central"}}], - > "filter":[{"range":{"year_completed":{"gte":1}}}], - > "should":[{"match":{"postalcode":"650633"}}], - > "must_not":[{"match":{"postalcode":"650634"}}] - > } - - - **Sample Queries Based on Use Cases** - - 1. **Search for all the four room units sold at Bishan Street 24.** - - Using a filterdata only: - - > filterdata = {"filter":[{"match_phrase": {"street":"bishan street 24"}},{"range": {"4room_sold":{"gte":1}}}]} - - version: '0.1.0' -servers: - - url: 'https://api.sentient.io' -tags: -- name: "v0.1.0" - description: "Published Date - Nov 25, 2019" -paths: - /DaaS/prod/hdb/buildinginfo: - get: - tags: - - v0.1.0 - parameters: - - in: query - name: querystring - schema: - type: string - description: |+ - Simple keyword search for matches in all searchable fields. Keywords separated by spaces will return results containing any of those keywords. For exact phrase match, put entire phrase in double quotes (" "). - - If this field is set to null, by default the microservice will return all buildings (within the stated limit), which can be further refined through the filterdata field for more sophisticated queries. - - example: "serangoon" - default: false - - in: query - name: offset - schema: - type: integer - description: The offset of the record list ie the starting index - example: "0" - default: false - - in: query - name: limit - schema: - type: integer - description: The max records to return for the request. Default - 10, Max - 10000 - example: "10" - default: false - - in: query - name: filterdata - schema: - type: string - description: |+ - Refine the search further on any of the possible through the 4 filter types : - * must - * must_not - * should - * filter - default: false - example: |+ - {"must":[{"match_phrase":{"street":"serangoon+central"}}],"filter":[{"range":{"year_completed":{"gte":1}}}],"should":[{"match":{"postalcode":"650633"}}],"must_not":[{"match":{"postalcode":"650634"}}]} - responses: - '200': - description: success response - content: - application/json: - schema: - $ref: '#/components/schemas/success' - example: - results: - total: 12150 - max_score: 1 - hits: - - _index: sentient_buildinginfo_hdb_index - _type: dir_doc - _id: '750405' - _score: 1 - _source: - postalcode: '750405' - year_completed: 1999 - total_dwelling_units: 112 - 1room_sold: 0 - 2room_sold: 0 - 3room_sold: 0 - 4room_sold: 112 - 5room_sold: 0 - exec_sold: 0 - multigen_sold: 0 - studio_apartment_sold: 0 - 1room_rental: 0 - 2room_rental: 0 - 3room_rental: 0 - other_room_rental: 0 - block: 405 - street: ADMIRALTY LINK - xcoord: 26086.0996 - ycoord: 48325.8008 - address: 405 ADMIRALTY LINK - createddate: '2019-10-17' - lastupdated: '2019-10-17' - location: - lat: 1.37179535 - lon: 103.8469821 - source: hdb - message: Successfully Processed - status: Success - '401': - description: Unauthorized - content: - application/json: - schema: - $ref: '#/components/schemas/unauthorized' - '402': - description: Payment Required - content: - application/json: - schema: - $ref: '#/components/schemas/paymentrequired' - '403': - description: Forbidden - content: - application/json: - schema: - $ref: '#/components/schemas/forbidden' - '404': - description: Not Found - content: - application/json: - schema: - $ref: '#/components/schemas/notfound' - '419': - description: Input Field Missing - content: - application/json: - schema: - $ref: '#/components/schemas/inputfieldmissing' - '413': - description: Input Limit Exceeded - content: - application/json: - schema: - $ref: '#/components/schemas/inputlimitexceeded' - '415': - description: Invalid Input - content: - application/json: - schema: - $ref: '#/components/schemas/invalidinput' - '500': - description: Internal Server Error - content: - application/json: - schema: - $ref: '#/components/schemas/servererror' - '504': - description: Gateway Timeout - content: - application/json: - schema: - $ref: '#/components/schemas/gatewaytimeout' - security: - - APIAuthorizer: [] -components: - schemas: - success: - type: object - properties: - results: - type: object - example: {} - description: Json Object of returned results - properties: - total: - type: number - example: 12150 - description: Total number of records - max_score: - type: number - example: 1 - description: The highest score value - hits: - type: array - example: [{} - description: Json Object of returned hits - properties: - postalcode: - type: string - description: Postal code - example: '750405' - year_completed: - type: number - description: Completed year of the Building - example: 1999 - total_dwelling_units: - type: number - description: Total Dwelling units - example: 112 - 1room_sold: - type: number - description: No. of one room units sold - example: 0 - 2room_sold: - type: number - description: No. of two room units sold - example: 0 - 3room_sold: - type: number - description: No. of three room units sold - example: 0 - 4room_sold: - type: number - description: No. of four room units sold - example: 112 - 5room_sold: - type: number - description: No. of five room units sold - example: 0 - exec_sold: - type: number - description: No. of executive units sold - example: 0 - multigen_sold: - type: number - description: No. of multi generation units sold - example: 0 - studio_apartment_sold: - type: number - description: No. of studio units sold - example: 0 - 1room_rental: - type: number - description: No. of one room units rented - example: 0 - 2room_rental: - type: number - description: No. of two room units rented - example: 0 - 3room_rental: - type: number - description: No. of three room units rented - example: 0 - other_room_rental: - type: number - description: No. of other units rented - example: 0 - block: - type: string - description: Block Number - example: 405 - street: - type: string - description: Street - example: ADMIRALTY LINK - xcoord: - type: string - description: SVY21 X coordinates - example: 26086.0996 - ycoord: - type: string - description: SVY21 Y coordinates - example: 48325.8008 - address: - type: string - description: Full address - example: 405 ADMIRALTY LINK - createddate: - type: string - description: Record first release date on sentient - example: '2019-10-17' - lastupdated: - type: string - description: Record last updated date on sentient - example: '2019-10-17' - location: - type: object - description: WGS84 coordinates lat/long - example: {"lat":1.350748,"lon":103.872798} - properties: - lat: - type: string - description: WGS84 latitude - example: 1.37179535 - lon: - type: string - description: WGS84 longitude - example: 103.8469821 - source: - type: string - description: Dataset source - example: hdb - message: - type: string - example: Successfully Processed - description: The detail description on the status - status: - type: string - example: Success - description: The status of the API call Success/Failure - unauthorized: - type: object - properties: - message: - type: string - example: Missing Authentication Token - status: - type: string - example: Failure - forbidden: - type: object - properties: - message: - type: string - example: Access Denied Unauthorized User - status: - type: string - example: Failure - paymentrequired: - type: object - properties: - message: - type: string - example: Insufficient Credits Kindly Top Up - status: - type: string - example: Failure - notfound: - type: object - properties: - message: - type: string - example: Invalid Request URL - status: - type: string - example: Failure - servererror: - type: object - properties: - message: - type: string - example: Internal Server Error - status: - type: string - example: Failure - invalidinput: - type: object - properties: - message: - type: string - example: Invalid Input - status: - type: string - example: Failure - gatewaytimeout: - type: object - properties: - message: - type: string - example: Request Timeout - status: - type: string - example: Failure - inputfieldmissing: - type: object - properties: - message: - type: string - example: Input Field Missing - status: - type: string - example: Failure - inputlimitexceeded: - type: object - properties: - message: - type: string - example: Input Limit Exceeded - status: - type: string - example: Failure - versions: - type: object - properties: - v0.1.0: - type: array - items: - oneOf: - - type: string - example: Published Date - Nov 25,2019 - description: Initial version release - securitySchemes: - APIAuthorizer: - type: apiKey - name: x-api-key - in: header - x-amazon-apigateway-authtype: custom - description: Authentication is done using the x-api-key in the request header. diff --git a/yaml/script_alignment.yaml b/yaml/script_alignment.yaml deleted file mode 100644 index a01255526..000000000 --- a/yaml/script_alignment.yaml +++ /dev/null @@ -1,277 +0,0 @@ -openapi: 3.0.1 -info: - title: Script Alignment - description: |+ - This NLP microservice aligns the input time-coded transcript with high-quality script. - - The output is the time-coded high-quality script. - - Do ensure that your text is within **5000 characters**. - x-additionalinfo: |+ - Suggested Use Cases: - - Can be used to create time-coded high-quality script for services like radio broadcasting, television broadcasting and digital content creation. - version: '0.1.0' - x-subscribelink: script_alignment -servers: - - url: 'https://apis.sentient.io' -tags: -- name: "v0.1.0" - description: "Published Date - Jun 05, 2020" -paths: - /microservices/nlp/scriptalignment/v0.1/getpredictions: - post: - tags: - - v0.1.0 - responses: - '200': - description: success response - content: - application/json: - schema: - $ref: '#/components/schemas/success' - example: [{"end": 4,"seqNum": 1,"start": 1,"text": "Hello World"},{"end": 8.2,"seqNum": 2,"start": 4.92,"text": "This is a test"},{"end": 12.04,"seqNum": 3,"start": 8.88,"text": "This is another test"}] - '401': - description: Unauthorized - content: - application/json: - schema: - $ref: '#/components/schemas/unauthorized' - '402': - description: Payment Required - content: - application/json: - schema: - $ref: '#/components/schemas/paymentrequired' - '403': - description: Forbidden - content: - application/json: - schema: - $ref: '#/components/schemas/forbidden' - '404': - description: Not Found - content: - application/json: - schema: - $ref: '#/components/schemas/notfound' - '419': - description: Input Field Missing - content: - application/json: - schema: - $ref: '#/components/schemas/inputfieldmissing' - '413': - description: Input Limit Exceeded - content: - application/json: - schema: - $ref: '#/components/schemas/inputlimitexceeded' - '415': - description: Invalid Input - content: - application/json: - schema: - $ref: '#/components/schemas/invalidinput' - '500': - description: Internal Server Error - content: - application/json: - schema: - $ref: '#/components/schemas/servererror' - '504': - description: Gateway Timeout - content: - application/json: - schema: - $ref: '#/components/schemas/gatewaytimeout' - security: - - APIAuthorizer: [] - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/input' - required: true -components: - schemas: - success: - type: object - properties: - results: - type: array - example: [{"end": 4,"seqNum": 1,"start": 1,"text": "Hello World"},{"end": 8.2,"seqNum": 2,"start": 4.92,"text": "This is a test"},{"end": 12.04,"seqNum": 3,"start": 8.88,"text": "This is another test"}] - description: The time-coded high-quality script - items: - oneOf: - - type: object - properties: - end: - type: string - example: 4 - description: End time of word, in seconds. Offset from the start of stream. - seqNum: - type: integer - example: 1 - description: Running sequence. Start from 1. - start: - type: string - example: 1 - description: Start time of word, in seconds. Offset from the start of stream. - text: - type: string - example: Hello World - description: Content of the utterance. - unauthorized: - type: object - properties: - message: - type: string - example: Missing Authentication Token - status: - type: string - example: Failure - forbidden: - type: object - properties: - message: - type: string - example: Access Denied Unauthorized User - status: - type: string - example: Failure - paymentrequired: - type: object - properties: - message: - type: string - example: Insufficient Credits Kindly Top Up - status: - type: string - example: Failure - notfound: - type: object - properties: - message: - type: string - example: Invalid Request URL - status: - type: string - example: Failure - invalidinput: - type: object - properties: - message: - type: string - example: Invalid Input - status: - type: string - example: Failure - servererror: - type: object - properties: - message: - type: string - example: Internal Server Error - status: - type: string - example: Failure - gatewaytimeout: - type: object - properties: - message: - type: string - example: Request Timeout - status: - type: string - example: Failure - inputfieldmissing: - type: object - properties: - message: - type: string - example: Input Field Missing - status: - type: string - example: Failure - inputlimitexceeded: - type: object - properties: - message: - type: string - example: Input Limit Exceeded - status: - type: string - example: Failure - versions: - type: object - properties: - v0.1.0: - type: array - items: - oneOf: - - type: string - example: Published Date - Jun 05, 2020 - description: Initial version release - input: - type: object - required: - - script - - transcript - properties: - script: - x-name: script - type: array - default: true - example: ["Hello World, This is a test. This is another test."] - description: |+ - An ordered array of text. Each element contains a line of the script. - - Supported formats: ASCII only - transcript: - x-name: transcript - type: array - default: true - example: [{"seqNum":1,"start":1.0,"end":4.0,"text":"HELLO WORLD"}] - description: |+ - An ordered array of utterance struct. - items: - oneOf: - - type: object - properties: - seqNum: - x-name: seqNum - type: number - default: true - example: 1 - description: |+ - Running sequence. Start from 1. - start: - x-name: start - type: number - format: float - default: true - example: 1.0 - description: |+ - Start time of utterance, in seconds. Offset from the start of stream. - end: - x-name: end - type: number - format: float - default: true - example: 4.0 - description: |+ - End time of utterance, in seconds. Offset from the end of stream. - text: - x-name: text - type: string - default: true - example: HELLO WORLD - description: |+ - Content of the utterance. - securitySchemes: - APIAuthorizer: - type: apiKey - name: x-api-key - in: header - x-amazon-apigateway-authtype: custom - description: Authentication is done using the x-api-key in the request header diff --git a/yaml/script_alignment_v1.0.yaml b/yaml/script_alignment_v1.0.yaml deleted file mode 100644 index c5df6824b..000000000 --- a/yaml/script_alignment_v1.0.yaml +++ /dev/null @@ -1,302 +0,0 @@ -openapi: 3.0.1 -info: - title: Script Alignment - description: |+ - This NLP microservice aligns the input time-coded transcript with high-quality script. - - The output is the time-coded high-quality script. - - Do ensure that your text is within **5000 characters**. - version: '1.0.0' - x-additionalinfo: |+ - Suggested Use Cases: - - Can be used to create time-coded high-quality script for services like radio broadcasting, television broadcasting and digital content creation. - x-subscribelink: script_alignment -servers: - - url: 'https://apis.sentient.io' -tags: -- name: "v1.0.0" - description: "Published Date - Oct 30, 2020" -paths: - /microservices/nlp/scriptalignment/v1/getpredictions: - post: - tags: - - v1.0.0 - responses: - '200': - description: success response - content: - application/json: - schema: - $ref: '#/components/schemas/success' - example: - results: - output: - [{"end": 4,"seqNum": 1,"start": 1,"text": "Hello World"},{"end": 8.2,"seqNum": 2,"start": 4.92,"text": "This is a test"},{"end": 12.04,"seqNum": 3,"start": 8.88,"text": "This is another test"}] - message: Successfully Processed - status: Success - '401': - description: Unauthorized - content: - application/json: - schema: - $ref: '#/components/schemas/unauthorized' - '402': - description: Payment Required - content: - application/json: - schema: - $ref: '#/components/schemas/paymentrequired' - '403': - description: Forbidden - content: - application/json: - schema: - $ref: '#/components/schemas/forbidden' - '404': - description: Not Found - content: - application/json: - schema: - $ref: '#/components/schemas/notfound' - '419': - description: Input Field Missing - content: - application/json: - schema: - $ref: '#/components/schemas/inputfieldmissing' - '413': - description: Input Limit Exceeded - content: - application/json: - schema: - $ref: '#/components/schemas/inputlimitexceeded' - '415': - description: Invalid Input - content: - application/json: - schema: - $ref: '#/components/schemas/invalidinput' - '500': - description: Internal Server Error - content: - application/json: - schema: - $ref: '#/components/schemas/servererror' - '504': - description: Gateway Timeout - content: - application/json: - schema: - $ref: '#/components/schemas/gatewaytimeout' - security: - - APIAuthorizer: [] - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/input' - required: true -components: - schemas: - success: - type: object - properties: - results: - type: object - description: The result of the API call. - example: { "" } - properties: - output: - type: array - example: [{"end": 4,"seqNum": 1,"start": 1,"text": "Hello World"},{"end": 8.2,"seqNum": 2,"start": 4.92,"text": "This is a test"},{"end": 12.04,"seqNum": 3,"start": 8.88,"text": "This is another test"}] - description: The time-coded high-quality script - items: - oneOf: - - type: object - properties: - end: - type: string - example: 4 - description: End time of word, in seconds. Offset from the start of stream. - seqNum: - type: integer - example: 1 - description: Running sequence. Start from 1. - start: - type: string - example: 1 - description: Start time of word, in seconds. Offset from the start of stream. - text: - type: string - example: Hello World - description: Content of the utterance. - message: - type: string - example: Successfully Processed - description: Detail description on the API status - status: - type: string - example: Success - description: The status of the API call success/failure - unauthorized: - type: object - properties: - message: - type: string - example: Missing Authentication Token - status: - type: string - example: Failure - forbidden: - type: object - properties: - message: - type: string - example: Access Denied Unauthorized User - status: - type: string - example: Failure - paymentrequired: - type: object - properties: - message: - type: string - example: Insufficient Credits Kindly Top Up - status: - type: string - example: Failure - notfound: - type: object - properties: - message: - type: string - example: Invalid Request URL - status: - type: string - example: Failure - servererror: - type: object - properties: - message: - type: string - example: Internal Server Error - status: - type: string - example: Failure - gatewaytimeout: - type: object - properties: - message: - type: string - example: Request Timeout - status: - type: string - example: Failure - invalidinput: - type: object - properties: - message: - type: string - example: Invalid Input - status: - type: string - example: Failure - inputfieldmissing: - type: object - properties: - message: - type: string - example: Input Field Missing - status: - type: string - example: Failure - inputlimitexceeded: - type: object - properties: - message: - type: string - example: Input Limit Exceeded - status: - type: string - example: Failure - versions: - type: object - properties: - v1.0.0: - type: array - items: - oneOf: - - type: string - example: Published Date - Oct 30,2020 - description: Standardizing Output JSON - v0.1.0: - type: array - items: - oneOf: - - type: string - example: Published Date - Jun 05, 2020 - description: Initial version release - input: - type: object - required: - - script - - transcript - properties: - script: - x-name: script - type: array - default: true - example: ["Hello World, This is a test. This is another test."] - description: |+ - An ordered array of text. Each element contains a line of the script. - - Supported formats: ASCII only - transcript: - x-name: transcript - type: array - default: true - example: [{"seqNum":1,"start":1.0,"end":4.0,"text":"HELLO WORLD"}] - description: |+ - An ordered array of utterance struct. - items: - oneOf: - - type: object - properties: - seqNum: - x-name: seqNum - type: number - default: true - example: 1 - description: |+ - Running sequence. Start from 1. - start: - x-name: start - type: number - format: float - default: true - example: 1.0 - description: |+ - Start time of utterance, in seconds. Offset from the start of stream. - end: - x-name: end - type: number - format: float - default: true - example: 4.0 - description: |+ - End time of utterance, in seconds. Offset from the end of stream. - text: - x-name: text - type: string - default: true - example: HELLO WORLD - description: |+ - Content of the utterance. - securitySchemes: - APIAuthorizer: - type: apiKey - name: x-api-key - in: header - x-amazon-apigateway-authtype: custom - description: Authentication is done using the x-api-key in the request header diff --git a/yaml/season_parking_availability_hdb_sg.yaml b/yaml/season_parking_availability_hdb_sg.yaml deleted file mode 100644 index ffe3d2bd6..000000000 --- a/yaml/season_parking_availability_hdb_sg.yaml +++ /dev/null @@ -1,440 +0,0 @@ -openapi: 3.0.1 -info: - title: HDB Season Parking Availability (SG) - x-subscribelink: season_parking_availability_hdb_sg - description: |+ - This Data microservice returns information on season car park availability within Housing Development Board of Singapore (HDB) estates and includes the location address, postal code, branch office, vehicle type and parking lot availability for different types of vehicle by carpark location. - The HDB POTH programme makes selected public and non-public datasets available to developers and companies to improve their service offerings to benefit the lives of Singapore citizens. Sentient.io is proud to partner with HDB to manage and facilitate the sharing of data for the POTH Programme. - **Note:** As this microservice uses the GET method, developers using this microservice must remember to have their app encode all the input values to be URL friendly (i.e. all spaces and special characters must be replaced). Here’s a reference on [URL encoding](https://www.w3schools.com/tags/ref_urlencode.ASP). - - x-additionalinfo : |+ - Suggested Use Cases: - - Real estate services - can be used as a background check solution to extract information related to season car park availability in an area for people with certain preferences when buying or renting a HDB home. - - Can also be integrated into apps related to maps or parking for more detailed carpark information within Singapore HDB estates - - **Refining queries in the filterdata field using filter types and match types** - The filterdata fields use elasticsearch’s syntax (specifically filter types and match types) to help further refine search results and provide greater flexibility in structuring more sophisticated queries. - - **Filter Types:** - A filter type is a logic operator to which the search results must fulfill certain logical conditions to be returned. The supported match types are: - - * **must** - All of the stated conditions must match. Equivalent to an AND operator. - - > {"must":[{"match_phrase":{"street":"serangoon north avenue 4"}}]} - - * **must_not** - All of the stated conditions must not match. Equivalent to a NOT operator. - > {"must_not":[{"match":{"postalcode":"570251"}}]} - - * **should** - At least one of the stated conditions should match. Equivalent to an OR operator. - > {"should":[{"match_phrase":{"street":"serangoon north avenue 4"}}]} - - * **filter** - All of the stated conditions that must match. However, results are not scored unlike the other filter types which returns results based on how well the conditions are met. - > {"filter":[{"match":{"street":"serangoon"}}]} - - For a more detailed guide on filter types, [refer to this](https://www.elastic.co/guide/en/elasticsearch/reference/6.8/query-dsl-bool-query.html). - - Filter types cannot be used alone and must be used in conjunction with a match type to complete the query. - - **Match Types:** - - A match type is a match operator nested within a filter type that fine-tunes the matching condition of the text search. The supported match types are: - - * **match** - Search within a full text field for a single word - > {"match":{"street":"serangoon"}} - * **match_phrase** - Search within a full text field - > {"match_phrase":{"street":"bishan street 24"}} - * **match_phrase_prefix** - Search within a full text field with prefix - > {"match_phrase_prefix":{"street":"bishan street 24"}} - * **term** - Returns results that contain an exact term in a provided field - > {"term":{"car_park_group":"G15"}} - * **terms** - Returns results that contain one or more exact terms in a provided field - > {"terms":{"car_park_group":["G15","G39"]}} - - * **range** - Returns results that contain terms within a stipulated range - - > {"range":{"car_park_availability":{"gte":10}}} - > {"range":{"car_park_availability":{"lte":50}}} - > {"range":{"car_park_availability":{"gte":10,"lte":50}}} - - * **exists** - Returns results that contain any indexed value for a field - - > {"exists":{ "field": "postalcode"}} - For a more detailed guide to match types, [refer to this](https://www.elastic.co/guide/en/elasticsearch/reference/7.9/term-level-queries.html). - - **Forming sophisticated queries using combinations of filter types (in JSON)** - Multiple filter types can be combined together in one query (written in JSON format) to form a very sophisticated query. Here’s one example below: - - > { - > "must":[{"match_phrase":{"street":"serangoon north avenue 4"}}], - > "filter":[{"match":{"vehicle_type":"Y"}}], - > "should":[{"match":{"car_park_group":"G18"}}], - > "must_not":[{"match":{"postalcode":"550409"}}] - > } - **Sample Queries Based on Use Cases** - - 1. **Search for the parking lot availability for commercial vehicle at the carpark of 503 Serangoon North Avenue 4.** - - Using a filterdata only: - - > filterdata = {"filter":[{"match":{"street":"serangoon north avenue 4"}},{"match":{"block":"503"}},{"match":{"vehicle_type":"H"}}]} - - version: '0.1.0' -servers: - - url: 'https://api.sentient.io' -tags: -- name: "v0.1.0" - description: "Published Date - May 15, 2020" -paths: - /DaaS/prod/hdb/carparkavailability: - get: - tags: - - v0.1.0 - parameters: - - in: query - name: querystring - schema: - type: string - description: |+ - Simple keyword search for matches in all searchable fields. Keywords separated by spaces will return results containing any of those keywords. For exact phrase match, put entire phrase in double quotes (" "). - - If this field is set to null, by default the microservice will return all carparks (within the stated limit), which can be further refined through the filterdata field for more sophisticated queries. - - example: serangoon - default: false - - in: query - name: offset - schema: - type: integer - description: The offset of the record list ie the starting index - example: "0" - default: false - - in: query - name: limit - schema: - type: integer - description: The max records to return for the request. Default - 10, Max - 10000 - example: "10" - default: false - - in: query - name: filterdata - schema: - type: string - description: |+ - Refine the search further on any of the possible through the 4 filter types : - * must - * must_not - * should - * filter - default: false - example: |+ - {"must":[{"match_phrase":{"street":"serangoon north avenue 4"}}],"filter":[{"match":{"vehicle_type":"Y"}}],"should":[{"match":{"car_park_group":"G18"}}],"must_not":[{"match":{"postalcode":"550409"}}]} - responses: - '200': - description: success response - content: - application/json: - schema: - $ref: '#/components/schemas/success' - example: - results: - total: 1 - max_score: 13.663734 - hits: - - _index: sentient_carparklotsavailble_hdb_index - _type: dir_doc - _id: AM/G40/Y/552506 - _score: 13.663734 - _source: - branch_office: AM - car_park_group: G40 - vehicle_type: Y - car_park_availability: 15 - postalcode: '552506' - block: 506B - street: serangoon north avenue 4 - xcoord: 32714.002 - ycoord: 39399.7461 - address: 506B serangoon north avenue 4 - createddate: '2020-05-07' - lastupdated: '2020-05-07' - location: - lat: 1.37259145 - lon: 103.8756772 - source: hdb - message: Successfully Processed - status: Success - '401': - description: Unauthorized - content: - application/json: - schema: - $ref: '#/components/schemas/unauthorized' - '402': - description: Payment Required - content: - application/json: - schema: - $ref: '#/components/schemas/paymentrequired' - '403': - description: Forbidden - content: - application/json: - schema: - $ref: '#/components/schemas/forbidden' - '404': - description: Not Found - content: - application/json: - schema: - $ref: '#/components/schemas/notfound' - '419': - description: Input Field Missing - content: - application/json: - schema: - $ref: '#/components/schemas/inputfieldmissing' - '413': - description: Input Limit Exceeded - content: - application/json: - schema: - $ref: '#/components/schemas/inputlimitexceeded' - '415': - description: Invalid Input - content: - application/json: - schema: - $ref: '#/components/schemas/invalidinput' - '500': - description: Internal Server Error - content: - application/json: - schema: - $ref: '#/components/schemas/servererror' - '504': - description: Gateway Timeout - content: - application/json: - schema: - $ref: '#/components/schemas/gatewaytimeout' - security: - - APIAuthorizer: [] -components: - schemas: - success: - type: object - properties: - results: - type: object - example: {} - description: Json Object of returned results - properties: - total: - type: number - example: 1 - description: Total number of records - max_score: - type: number - example: 13.663734 - description: The highest score value - hits: - type: array - example: [{} - description: Json Object of returned hits - properties: - branch_office: - type: string - description: Branch Office - example: AM - car_park_group: - type: string - description: Car Park Group - example: "G40" - vehicle_type: - type: string - description: |+ - Vehicle Type: - - Y - Motorcycle - H - Commercial Vehicle (>1800kg) - C - Car - S - Season (Car) - example: "Y" - car_park_availability: - type: number - description: Car Park Availability - example: 15 - postalcode: - type: array - description: Postal code - example: "552506" - block: - type: array - description: Block - example: "506B" - street: - type: array - description: street - example: "serangoon north avenue 4" - xcoord: - type: string - description: SVY21 X coordinates - example: 32714.002 - ycoord: - type: string - description: SVY21 Y coordinates - example: 39399.7461 - address: - type: string - description: address - example: 506B serangoon north avenue 4 - source: - type: string - description: Dataset source - example: hdb - location: - type: object - description: WGS84 coordinates lat/long - example: {"lat":1.37259145,"lon":103.8756772} - properties: - lat: - type: string - description: WGS84 latitude - example: 1.37259145 - lon: - type: string - description: WGS84 longitude - example: 103.8756772 - createddate: - type: string - description: Record first release date on sentient - example: "2019-10-17" - lastupdated: - type: string - description: Record last updated date on sentient - example: "2019-10-17" - message: - type: string - example: Successfully Processed - description: The detail description on the status - status: - type: string - example: Success - description: The status of the API call Success/Failure - unauthorized: - type: object - properties: - message: - type: string - example: Missing Authentication Token - status: - type: string - example: Failure - forbidden: - type: object - properties: - message: - type: string - example: Access Denied Unauthorized User - status: - type: string - example: Failure - paymentrequired: - type: object - properties: - message: - type: string - example: Insufficient Credits Kindly Top Up - status: - type: string - example: Failure - invalidinput: - type: object - properties: - message: - type: string - example: Invalid Input - status: - type: string - example: Failure - notfound: - type: object - properties: - message: - type: string - example: Invalid Request URL - status: - type: string - example: Failure - servererror: - type: object - properties: - message: - type: string - example: Internal Server Error - status: - type: string - example: Failure - gatewaytimeout: - type: object - properties: - message: - type: string - example: Request Timeout - status: - type: string - example: Failure - inputfieldmissing: - type: object - properties: - message: - type: string - example: Input Field Missing - status: - type: string - example: Failure - inputlimitexceeded: - type: object - properties: - message: - type: string - example: Input Limit Exceeded - status: - type: string - example: Failure - versions: - type: object - properties: - v0.1.0: - type: array - items: - oneOf: - - type: string - example: Published Date - May 15,2020 - description: Initial version release - securitySchemes: - APIAuthorizer: - type: apiKey - name: x-api-key - in: header - x-amazon-apigateway-authtype: custom - description: Authentication is done using the x-api-key in the request header. diff --git a/yaml/sentiment-analysis-aws.yaml b/yaml/sentiment-analysis-aws.yaml deleted file mode 100644 index 61cef6373..000000000 --- a/yaml/sentiment-analysis-aws.yaml +++ /dev/null @@ -1,186 +0,0 @@ -openapi: 3.0.1 -info: - title: Sentiment Analysis AWS - description: >- - The sentiment analysis will help to determine the expressed emotional state of person by using natural language processing to analyse a range of parameters, including tone of voice, choice of words.

This is a passthrough to AWS’s sentiment analyser. - version: '0.1.0' -servers: - - url: 'https://api.sentient.io' -paths: - /sentimentanalysis/prod/awssa: - post: - tags: - - v0.1.0 - responses: - '200': - description: success response - content: - application/json: - schema: - $ref: '#/components/schemas/success' - '401': - description: Unauthorized - content: - application/json: - schema: - $ref: '#/components/schemas/unauthorized' - '402': - description: Payment Required - content: - application/json: - schema: - $ref: '#/components/schemas/paymentrequired' - '403': - description: Forbidden - content: - application/json: - schema: - $ref: '#/components/schemas/forbidden' - '404': - description: Not Found - content: - application/json: - schema: - $ref: '#/components/schemas/notfound' - '419': - description: Input Field Missing - content: - application/json: - schema: - $ref: '#/components/schemas/inputfieldmissing' - '420': - description: Input Limit Exceeded - content: - application/json: - schema: - $ref: '#/components/schemas/inputlimitexceeded' - '422': - description: Invalid Input - content: - application/json: - schema: - $ref: '#/components/schemas/invalidinput' - '500': - description: Internal Server error - content: - application/json: - schema: - $ref: '#/components/schemas/servererror' - '504': - description: Gateway Timeout - content: - application/json: - schema: - $ref: '#/components/schemas/gatewaytimeout' - security: - - APIAuthorizer: [] - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/input' - required: true -components: - schemas: - success: - type: object - properties: - Sentiment: - type: string - example: NEUTRAL - SentimentScore: - items: - type: string - example: 'Positive: 0.05698205158114433, Negative: 0.030973462387919426, Neutral: 0.912034809589386, Mixed: 0.00000966900734056253' - unauthorized: - type: object - properties: - message: - type: string - example: Missing Authentication Token - status: - type: string - example: Failure - forbidden: - type: object - properties: - message: - type: string - example: Access Denied Unauthorized User - status: - type: string - example: Failure - invalidinput: - type: object - properties: - message: - type: string - example: Invalid Input - status: - type: string - example: Failure - paymentrequired: - type: object - properties: - message: - type: string - example: Insufficient Credits Kindly Top Up - status: - type: string - example: Failure - notfound: - type: object - properties: - message: - type: string - example: Invalid Request URL - status: - type: string - example: Failure - servererror: - type: object - properties: - message: - type: string - example: Internal Server error - status: - type: string - example: Failure - gatewaytimeout: - type: object - properties: - message: - type: string - example: Request Timeout - status: - type: string - example: Failure - inputfieldmissing: - type: object - properties: - message: - type: string - example: Input Field Missing - status: - type: string - example: Failure - inputlimitexceeded: - type: object - properties: - message: - type: string - example: Input Limit Exceeded - status: - type: string - example: Failure - input: - type: object - properties: - key: - type: string - securitySchemes: - APIAuthorizer: - type: apiKey - name: x-api-key - in: header - x-amazon-apigateway-authtype: custom diff --git a/yaml/sentiment-analysis-google.yaml b/yaml/sentiment-analysis-google.yaml deleted file mode 100644 index d55a210b5..000000000 --- a/yaml/sentiment-analysis-google.yaml +++ /dev/null @@ -1,176 +0,0 @@ -openapi: 3.0.1 -info: - title: Sentiment Analysis Google - description: >- - The sentiment analysis will help to determine the expressed emotional state of person by using natural language processing to analyse a range of parameters, including tone of voice, choice of words.

This is a passthrough to Google’s sentiment analyser. - version: '0.1.0' -servers: - - url: 'https://api.sentient.io' -paths: - /sentimentanalysis/prod/googlesa: - post: - tags: - - v0.1.0 - responses: - '200': - description: success response - content: - application/json: - schema: - $ref: '#/components/schemas/success' - '401': - description: Unauthorized - content: - application/json: - schema: - $ref: '#/components/schemas/unauthorized' - '402': - description: Payment Required - content: - application/json: - schema: - $ref: '#/components/schemas/paymentrequired' - '403': - description: Forbidden - content: - application/json: - schema: - $ref: '#/components/schemas/forbidden' - '404': - description: Not Found - content: - application/json: - schema: - $ref: '#/components/schemas/notfound' - '419': - description: Input Field Missing - content: - application/json: - schema: - $ref: '#/components/schemas/inputfieldmissing' - '420': - description: Input Limit Exceeded - content: - application/json: - schema: - $ref: '#/components/schemas/inputlimitexceeded' - '500': - description: Internal Server error - content: - application/json: - schema: - $ref: '#/components/schemas/servererror' - '504': - description: Gateway Timeout - content: - application/json: - schema: - $ref: '#/components/schemas/gatewaytimeout' - security: - - APIAuthorizer: [] - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/input' - required: true -components: - schemas: - success: - type: object - properties: - documentSentiment: - items: - type: string - example: 'magnitude: 0.1,score: 0.1' - language: - type: string - example: en - sentences: - items: - type: string - example: 'text: {content: hi there, - beginOffset: 0},sentiment:{magnitude: 0.1,score: 0.1}' - unauthorized: - type: object - properties: - message: - type: string - example: Missing Authentication Token - status: - type: string - example: Failure - forbidden: - type: object - properties: - message: - type: string - example: Access Denied Unauthorized User - status: - type: string - example: Failure - paymentrequired: - type: object - properties: - message: - type: string - example: Insufficient Credits Kindly Top Up - status: - type: string - example: Failure - notfound: - type: object - properties: - message: - type: string - example: Invalid Request URL - status: - type: string - example: Failure - servererror: - type: object - properties: - message: - type: string - example: Internal Server error - status: - type: string - example: Failure - gatewaytimeout: - type: object - properties: - message: - type: string - example: Request Timeout - status: - type: string - example: Failure - inputfieldmissing: - type: object - properties: - message: - type: string - example: Input Field Missing - status: - type: string - example: Failure - inputlimitexceeded: - type: object - properties: - message: - type: string - example: Input Limit Exceeded - status: - type: string - example: Failure - input: - type: object - properties: - key: - type: string - securitySchemes: - APIAuthorizer: - type: apiKey - name: x-api-key - in: header - x-amazon-apigateway-authtype: custom diff --git a/yaml/spacy_named-entity_recognition_eng.yaml b/yaml/spacy_named-entity_recognition_eng.yaml deleted file mode 100644 index e911077c7..000000000 --- a/yaml/spacy_named-entity_recognition_eng.yaml +++ /dev/null @@ -1,317 +0,0 @@ -openapi: 3.0.1 -info: - title: spaCy NER - description: |+ - This NLP microservice locates and classifies the named-entities classes from input unstructured English text, based on the spaCy model. - - The named-entity classes extracted include persons, nationalities, religious groups, political groups, buildings and facilities, organisations, geopolitical, locations, products, events, works of art, laws, languages, dates and time, percentages, monetary values, quantities, ordinals and cardinals. - - This microservice automatically extracts structured information from unstructured text data such as chatlogs, emails, news articles, etc. - - Do ensure that your text is **within 5000 characters**. - x-additionalinfo: |+ - Suggested Use Cases: - - Can be used to build information extraction or natural language understanding systems, or to pre-process text for deep learning -e.g. tokenization, Parts-of-Speech (PoS) Tagging, Text Classification and Named Entity Recognition. - version: '0.1.0' - x-subscribelink: spacy_ner -servers: - - url: 'https://apis.sentient.io' -tags: -- name: "v0.1.0" - description: "Published Date - Sep 30, 2020" -paths: - /microservices/nlp/spacyner/v1/getpredictions: - post: - tags: - - v0.1.0 - responses: - '200': - description: success response - content: - application/json: - schema: - $ref: '#/components/schemas/success' - example: {"message": "Successfully Processed","results": {"fac": ["Changi Airport","the first Airport"],"gpe": ["Changi","Singapore"],"loc": ["Marina Bay","Asia"],"org": ["WSSS","BOC Aviation","Jetstar Asia Airways","Changi Airport Group","FAA","Skytrax","ICAO","the World's Best Airport"],"quantity": ["5.0 sq mi","approximately 20 km"]},"status": "Success"} - '401': - description: Unauthorized - content: - application/json: - schema: - $ref: '#/components/schemas/unauthorized' - '402': - description: Payment Required - content: - application/json: - schema: - $ref: '#/components/schemas/paymentrequired' - '403': - description: Forbidden - content: - application/json: - schema: - $ref: '#/components/schemas/forbidden' - '404': - description: Not Found - content: - application/json: - schema: - $ref: '#/components/schemas/notfound' - '419': - description: Input Field Missing - content: - application/json: - schema: - $ref: '#/components/schemas/inputfieldmissing' - '413': - description: Input Limit Exceeded - content: - application/json: - schema: - $ref: '#/components/schemas/inputlimitexceeded' - '415': - description: Invalid Input - content: - application/json: - schema: - $ref: '#/components/schemas/invalidinput' - '500': - description: Internal Server Error - content: - application/json: - schema: - $ref: '#/components/schemas/servererror' - '504': - description: Gateway Timeout - content: - application/json: - schema: - $ref: '#/components/schemas/gatewaytimeout' - security: - - APIAuthorizer: [] - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/input' - required: true -components: - schemas: - success: - type: object - properties: - results: - type: object - example: { "" } - description: Json Object of returned results - properties: - person: - x-name: person - type: array - example: [DONALD TRUMP,Mike Pompeo] - description: People, including fictional. - norp: - x-name: norp - type: array - example: [Chinese,Singaporean,Malay] - description: Nationalities or religious or political groups. - fac: - x-name: fac - type: array - example: [Changi Airport, the first Airport] - description: Buildings, airports, highways, bridges, etc. - org: - x-name: org - type: array - example: [WSSS,BOC Aviation] - description: Companies, agencies, institutions, etc. - gpe: - x-name: gpe - type: array - example: [Changi,Singapore] - description: Countries, cities, states. - loc: - x-name: loc - type: array - example: [Marina Bay, Asia] - description: Non-GPE locations, mountain ranges, bodies of water. - product: - x-name: product - type: array - example: [Formula 1,Motorrad] - description: Objects, vehicles, foods, etc. (Not services.) - event: - x-name: event - type: array - example: [the Second World War] - description: Named hurricanes, battles, wars, sports events, etc. - work_of_art: - x-name: work_of_art - type: array - example: [Wizardry] - description: Titles of books, songs, etc. - law: - x-name: law - type: array - example: [the Penal Code,the Internal Security Act,the Constitution of the Republic of Singapore",the Evidence Act,the Societies Act] - description: Named documents made into laws. - language: - x-name: language - type: array - example: [English] - description: Any named language. - date: - x-name: date - type: array - example: [Tuesday] - description: Absolute or relative dates or periods. - time: - x-name: time - type: array - example: [twenty-four hours] - description: Times smaller than a day. - percent: - x-name: percent - type: array - example: [91%,25%,61%] - description: Percentage, including ”%“. - money: - x-name: money - type: array - example: [up to $1000] - description: Monetary values, including unit. - quantity: - x-name: quantity - type: array - example: [about one degree,85 miles,137 kilometres] - description: Measurements, as of weight or distance. - ordinal: - x-name: ordinal - type: array - example: [ninth,seventh,second] - description: “first”, “second”, etc. - cardinal: - x-name: cardinal - type: array - example: [four] - description: Numerals that do not fall under another type. - message: - x-name: message - type: string - example: Successfully Processed - description: Detail description on the API status - - status: - x-name: status - type: string - example: Success - description: The status of the API call success/failure - invalidinput: - type: object - properties: - message: - type: string - example: Invalid Input - status: - type: string - example: Failure - unauthorized: - type: object - properties: - message: - type: string - example: Missing Authentication Token - status: - type: string - example: Failure - forbidden: - type: object - properties: - message: - type: string - example: Access Denied Unauthorized User - status: - type: string - example: Failure - paymentrequired: - type: object - properties: - message: - type: string - example: Insufficient Credits Kindly Top Up - status: - type: string - example: Failure - notfound: - type: object - properties: - message: - type: string - example: Invalid Request URL - status: - type: string - example: Failure - servererror: - type: object - properties: - message: - type: string - example: Internal Server Error - status: - type: string - example: Failure - gatewaytimeout: - type: object - properties: - message: - type: string - example: Request Timeout - status: - type: string - example: Failure - inputfieldmissing: - type: object - properties: - message: - type: string - example: Input Field Missing - status: - type: string - example: Failure - inputlimitexceeded: - type: object - properties: - message: - type: string - example: Input Limit Exceeded - status: - type: string - example: Failure - versions: - type: object - properties: - v0.1.0: - type: array - items: - oneOf: - - type: string - example: Published Date - Sep 30, 2020 - description: Initial version release - input: - type: object - required: - - text - properties: - text: - x-name: text - type: string - default: true - example: "Singapore Changi Airport, commonly known as Changi Airport (IATA: SIN, ICAO: WSSS, FAA LID: SIN), is a major civilian airport that serves Singapore, and is one of the largest transportation hubs in Asia. As one of the world's busiest airports by international passenger and cargo traffic, it is currently rated the World's Best Airport by Skytrax, the first Airport in the world to do so for eight consecutive years.[10][11] It has also been rated as the one of the world's cleanest airports and highly rated international transit airports.[12][13]The airport is located in Changi, at the eastern end of Singapore, approximately 20 km (12 mi)[14] from Marina Bay (Singapore's Downtown Core), on a 13-square-kilometre (5.0 sq mi) site. The airport is operated by Changi Airport Group and it is the home base of Singapore Airlines,[15] Singapore Airlines Cargo,[15] SilkAir,[15] Scoot, Jetstar Asia Airways and BOC Aviation." - description: |+ - Input text - securitySchemes: - APIAuthorizer: - type: apiKey - name: x-api-key - in: header - x-amazon-apigateway-authtype: custom - description: Authentication is done using the x-api-key in the request header diff --git a/yaml/staple_invoice.yaml b/yaml/staple_invoice.yaml deleted file mode 100644 index d91b728d6..000000000 --- a/yaml/staple_invoice.yaml +++ /dev/null @@ -1,223 +0,0 @@ -openapi: 3.0.1 -info: - title: Staple Invoice - description: |+ - Scan the Invoice document from file and explore the data by catagorywise. - Supported formats are : pdf, jpg, png, docx, doc - version: '1.0.0' - x-subscribelink: staple_receipt -servers: - - url: 'https://dev-apis.sentient.io' -tags: -- name: "v1.0.0" - description: "Published Date - Oct 30, 2020" -paths: - /microservices/nlp/scaninvoice/v1/getresults: - post: - tags: - - v1.0.0 - responses: - '200': - description: success response - content: - application/json: - schema: - $ref: '#/components/schemas/success' - example: {"message": "Successfully Processed","results":{"scanDocuments":{"data":{"BigBoxes":[{"box":[102,131,227,166,164.5,148.5],"page":0}],"Currency":{"UICategory":"VAT&Amounts","UIName":"Currency","UIType":"Text","matches":[{"keyword":[1160,1594,1171,1616,1165.5,1605,"$","$"],"match":"$","matchmulti":"$","page":0,"value":[1160,1594,1171,1616,1165.5,1605,"$","$"]}]},"Customer":null,"DetectedText":"GSSAINVOICEThankyouc/oGregDerderianTreasurer32TinkerRoadNashuaNH03064Phone603-595-4357faxnoneDATE:INVOICE#FOR:May22009100AnnualDuesBillTo:GSSAMember2009PhoneDESCRIPTIONAMOUNTAnnualDuesperteam2009summerswimseason$100.00TOTAL$100.00MakeallcheckspayabletoGSSAIfyouhaveanyquestionsconcerningthisinvoicecontactNaGregDerderianTreasurerTHANKYOUFORYOURMEMBERSHIP!","DocSize":[[2000,1545]],"Email":{"UICategory":"Vendor&Customer","UIName":"Email","UIType":"Text","matches":[{"keyword":null,"match":null,"matchmulti":null,"page":null,"value":null}]},"GSTNumber":{"UICategory":"Vendor&Customer","UIName":"GSTNumber","UIType":"Text","matches":[{"keyword":null,"match":null,"matchmulti":null,"page":null,"value":null}]},"LineItems":[[{"Amount":[22009],"Description":["32TinkerRoad","DATE:"]}]],"LineItems_standardHeader":[[{"Description":"32TinkerRoadDATE:","LineAmount":22009,"Quantity":1,"UnitAmount":22009}]],"OtherDate":{"UICategory":"BasicInformation","UIName":"OtherDate","UIType":"Date","matches":[{"keyword":null,"match":"2009-05-02","matchmulti":"May22009","page":0,"value":[1232,260]}]},"SenderAddress":{"UICategory":"Vendor&Customer","UIName":"VendorAddress","UIType":"Text","matches":[{"keyword":[102,131,227,166,164.5,148.5,"GSSA\n","GSSA\n"],"match":"c/oGregDerderianTreasurer\n32TinkerRoad\nNashua\nNH03064\nPhone603-595-4357\nfaxnone\n","matchmulti":"c/oGregDerderianTreasurer32TinkerRoadNashuaNH03064Phone603-595-4357Faxnone","page":0,"value":[97,231,457,349,277,290,"c/oGregDerderianTreasurer\n32TinkerRoad\nNashua\nNH03064\nPhone603-595-4357\nfaxnone\n","c/oGregDerderianTreasurer\n32TinkerRoad\nNashua\nNH03064\nPhone603-595-4357\nFaxnone\n"]}]},"ServiceCharge":{"UICategory":"VAT&Amounts","UIName":"ServiceCharge","UIType":"Amount","matches":[{"keyword":null,"match":null,"matchmulti":null,"page":null,"value":null}]},"docId":7905,"status":"COMPLETED"}},"status":"Success"}} - '401': - description: Unauthorized - content: - application/json: - schema: - $ref: '#/components/schemas/unauthorized' - '402': - description: Payment Required - content: - application/json: - schema: - $ref: '#/components/schemas/paymentrequired' - '403': - description: Forbidden - content: - application/json: - schema: - $ref: '#/components/schemas/forbidden' - '404': - description: Not Found - content: - application/json: - schema: - $ref: '#/components/schemas/notfound' - '419': - description: Input Field Missing - content: - application/json: - schema: - $ref: '#/components/schemas/inputfieldmissing' - '420': - description: Input Limit Exceeded - content: - application/json: - schema: - $ref: '#/components/schemas/inputlimitexceeded' - '422': - description: Invalid Input - content: - application/json: - schema: - $ref: '#/components/schemas/invalidinput' - '500': - description: Internal Server Error - content: - application/json: - schema: - $ref: '#/components/schemas/servererror' - '504': - description: Gateway Timeout - content: - application/json: - schema: - $ref: '#/components/schemas/gatewaytimeout' - security: - - APIAuthorizer: [] - requestBody: - content: - multipart/form-data: - schema: - $ref: '#/components/schemas/input' - required: true -components: - schemas: - success: - type: object - properties: - results: - type: object - example: { "" } - description: The result of the API call - properties: - scanDocuments: - type: object - example: { "" } - description: The details of documents - message: - type: string - example: Successfully Processed - description: Detail description on the API status - status: - type: string - example: Success - description: The status of the API call success/failure - unauthorized: - type: object - properties: - message: - type: string - example: Missing Authentication Token - status: - type: string - example: Failure - forbidden: - type: object - properties: - message: - type: string - example: Access Denied Unauthorized User - status: - type: string - example: Failure - invalidinput: - type: object - properties: - message: - type: string - example: Invalid Input - status: - type: string - example: Failure - paymentrequired: - type: object - properties: - message: - type: string - example: Insufficient Credits Kindly Top Up - status: - type: string - example: Failure - notfound: - type: object - properties: - message: - type: string - example: Invalid Request URL - status: - type: string - example: Failure - servererror: - type: object - properties: - message: - type: string - example: Internal Server Error - status: - type: string - example: Failure - gatewaytimeout: - type: object - properties: - message: - type: string - example: Request Timeout - status: - type: string - example: Failure - inputfieldmissing: - type: object - properties: - message: - type: string - example: Input Field Missing - status: - type: string - example: Failure - inputlimitexceeded: - type: object - properties: - message: - type: string - example: Input Limit Exceeded - status: - type: string - example: Failure - versions: - type: object - properties: - v1.0.0: - type: array - items: - oneOf: - - type: string - example: Published Date - Oct 30, 2020 - description: Initial version release - input: - type: object - required: - - file - - endpointUrl - properties: - file: - type: string - format: binary - default: true - example: upload file - description: The receipt document - handwritten: - type: string - description: Sholud be true of false. Default is false - securitySchemes: - APIAuthorizer: - type: apiKey - name: x-api-key - in: header - x-amazon-apigateway-authtype: custom - description: Authentication is done using the x-api-key in the request header diff --git a/yaml/staple_receipt.yaml b/yaml/staple_receipt.yaml deleted file mode 100644 index 050b4655e..000000000 --- a/yaml/staple_receipt.yaml +++ /dev/null @@ -1,1573 +0,0 @@ -openapi: 3.0.1 -info: - title: Staple Receipt - description: |+ - Scan the Receipt document from file and explore the data by catagorywise. - Supported formats are : pdf, jpg, png, docx, doc - version: '1.0.0' - x-subscribelink: staple_receipt -servers: - - url: 'https://dev-apis.sentient.io' -tags: -- name: "v1.0.0" - description: "Published Date - Oct 30, 2020" -paths: - /microservices/nlp/scanreceipt/v1/getresults: - post: - tags: - - v1.0.0 - responses: - '200': - description: success response - content: - application/json: - schema: - $ref: '#/components/schemas/success' - example: - message: Successfully Processed - results: - scanDocuments: - data: - AccountName: - UICategory: Payment Instructions - UIName: Account Name - UIType: Text - matches: - - keyword: - match: - matchmulti: - page: - value: - AccountNumber: - UICategory: Payment Instructions - UIName: Account Number - UIType: Text - matches: - - keyword: - match: - matchmulti: - page: - value: - BigBoxes: - - box: - - 106 - - 134 - - 385 - - 174 - - 245.5 - - 154 - - East Repair Inc. - - East Repair Inc. - page: 0 - - box: - - 1148 - - 129 - - 1308 - - 171 - - 1228 - - 150 - - RECEIPT - - RECEIPT - page: 0 - - box: - - 102 - - 208 - - 322 - - 273 - - 212 - - 240.5 - - |- - 1912 Harvest Lane - New York, NY 12210 - - |- - 1912 Harvest Lane - New York , NY 12210 - page: 0 - - box: - - 1232 - - 455 - - 1307 - - 479 - - 1269.5 - - 467 - - US-001 - - US-001 - page: 0 - - box: - - 102 - - 452 - - 322 - - 591 - - 212 - - 521.5 - - |- - Bill To - John Smith - 2 Court Square - New York, NY 12210 - - |- - Bill To - John Smith - 2 Court Square - New York , NY 12210 - page: 0 - - box: - - 529 - - 454 - - 766 - - 595 - - 647.5 - - 524.5 - - |- - Ship To - John Smith - 3787 Pineview Drive - Cambridge, MA 12210 - - |- - Ship To - John Smith - 3787 Pineview Drive - Cambridge , MA 12210 - page: 0 - - box: - - 972 - - 452 - - 1113 - - 531 - - 1042.5 - - 491.5 - - |- - Receipt # - Receipt Date - - |- - Receipt # - Receipt Date - page: 0 - - box: - - 1193 - - 500 - - 1309 - - 527 - - 1251 - - 513.5 - - 11/02/2019 - - 11/02/2019 - page: 0 - - box: - - 1055 - - 553 - - 1114 - - 575 - - 1084.5 - - 564 - - 'PO #' - - 'P.O. #' - page: 0 - - box: - - 1200 - - 553 - - 1310 - - 576 - - 1255 - - 564.5 - - 2312/2019 - - 2312/2019 - page: 0 - - box: - - 1012 - - 600 - - 1112 - - 622 - - 1062 - - 611 - - Due Date - - Due Date - page: 0 - - box: - - 1193 - - 600 - - 1310 - - 623 - - 1251.5 - - 611.5 - - 26/02/2019 - - 26/02/2019 - page: 0 - - box: - - 130 - - 732 - - 178 - - 751 - - 154 - - 741.5 - - QTY - - QTY - page: 0 - - box: - - 422 - - 731 - - 580 - - 752 - - 501 - - 741.5 - - DESCRIPTION - - DESCRIPTION - page: 0 - - box: - - 831 - - 722 - - 962 - - 759 - - 896.5 - - 740.5 - - UNIT PRICE - - UNIT PRICE - page: 0 - - box: - - 1102 - - 730 - - 1205 - - 752 - - 1153.5 - - 741 - - AMOUNT - - AMOUNT - page: 0 - - box: - - 149 - - 793 - - 155 - - 813 - - 152 - - 803 - - '1' - - '1' - page: 0 - - box: - - 229 - - 793 - - 518 - - 816 - - 373.5 - - 804.5 - - Front and rear brake cables - - Front and rear brake cables - page: 0 - - box: - - 911 - - 793 - - 981 - - 814 - - 946 - - 803.5 - - '100.00' - - '100.00' - page: 0 - - box: - - 1220 - - 793 - - 1289 - - 816 - - 1254.5 - - 804.5 - - '100.00' - - '100.00' - page: 0 - - box: - - 148 - - 857 - - 159 - - 876 - - 153.5 - - 866.5 - - '2' - - '2' - page: 0 - - box: - - 229 - - 852 - - 463 - - 884 - - 346 - - 868 - - New set of pedal arms - - New set of pedal arms - page: 0 - - box: - - 925 - - 857 - - 981 - - 879 - - 953 - - 868 - - '15.00' - - '15.00' - page: 0 - - box: - - 1231 - - 856 - - 1290 - - 879 - - 1260.5 - - 867.5 - - '30.00' - - '30.00' - page: 0 - - box: - - 149 - - 920 - - 160 - - 939 - - 154.5 - - 929.5 - - '3' - - '3' - page: 0 - - box: - - 229 - - 918 - - 340 - - 939 - - 284.5 - - 928.5 - - Labor 3hrs - - Labor 3hrs - page: 0 - - box: - - 936 - - 920 - - 980 - - 940 - - 958 - - 930 - - '5.00' - - '5.00' - page: 0 - - box: - - 1233 - - 920 - - 1289 - - 941 - - 1261 - - 930.5 - - '15.00' - - '15.00' - page: 0 - - box: - - 897 - - 981 - - 981 - - 1003 - - 939 - - 992 - - Subtotal - - Subtotal - page: 0 - - box: - - 1219 - - 980 - - 1288 - - 1002 - - 1253.5 - - 991 - - '145.00' - - '145.00' - page: 0 - - box: - - 803 - - 1042 - - 980 - - 1063 - - 891.5 - - 1052.5 - - Sales Tax 6.25% - - Sales Tax 6.25% - page: 0 - - box: - - 1244 - - 1042 - - 1289 - - 1065 - - 1266.5 - - 1053.5 - - '9.06' - - '9.06' - page: 0 - - box: - - 872 - - 1104 - - 981 - - 1137 - - 926.5 - - 1120.5 - - TOTAL - - TOTAL - page: 0 - - box: - - 1172 - - 1101 - - 1289 - - 1140 - - 1230.5 - - 1120.5 - - "$ 154.06" - - "$ 154.06" - page: 0 - - box: - - 102 - - 1728 - - 422 - - 1801 - - 262 - - 1764.5 - - |- - Terms & Conditions - Payment is due within 15 days - - |- - Terms & Conditions - Payment is due within 15 days - page: 0 - - box: - - 104 - - 1841 - - 616 - - 1871 - - 360 - - 1856 - - 'Please make checks payable to: East Repair Inc.' - - 'Please make checks payable to: East Repair Inc.' - page: 0 - BillingAddress: - UICategory: Vendor & Customer - UIName: Billing Address - UIType: Text - matches: - - keyword: - - 102 - - 452 - - 322 - - 591 - - 212 - - 521.5 - - |- - Bill To - John Smith - 2 Court Square - New York, NY 12210 - - |- - Bill To - John Smith - 2 Court Square - New York , NY 12210 - match: |- - John Smith - 2 Court Square - New York, NY 12210 - matchmulti: Bill To John Smith 2 Court Square New York , NY 12210 - page: 0 - value: - - 102 - - 452 - - 322 - - 591 - - 212 - - 521.5 - - |- - Bill To - John Smith - 2 Court Square - New York, NY 12210 - - |- - Bill To - John Smith - 2 Court Square - New York , NY 12210 - CompanyName: - UICategory: Vendor & Customer - UIName: Vendor Name - UIType: Text - matches: - - keyword: - - 106 - - 134 - - 385 - - 174 - - 245.5 - - 154 - - East Repair Inc. - - East Repair Inc. - match: East Repair Inc. - matchmulti: East Repair Inc. - page: 0 - value: - - 106 - - 134 - - 385 - - 174 - - 245.5 - - 154 - - East Repair Inc. - - East Repair Inc. - Currency: - UICategory: VAT & Amounts - UIName: Currency - UIType: Text - matches: - - keyword: - - 872 - - 1104 - - 981 - - 1137 - - 926.5 - - 1120.5 - - TOTAL - - TOTAL - match: "$" - matchmulti: "$ 154.06" - page: 0 - value: - - 1172 - - 1101 - - 1289 - - 1140 - - 1230.5 - - 1120.5 - - "$ 154.06" - - "$ 154.06" - Customer: - DetectedText: 'East Repair Inc. RECEIPT 1912 Harvest Lane New York, NY 12210 - US-001 Bill To John Smith 2 Court Square New York, NY 12210 Ship To John Smith - 3787 Pineview Drive Cambridge, MA 12210 Receipt # Receipt Date 11/02/2019 - PO # 2312/2019 Due Date 26/02/2019 QTY DESCRIPTION UNIT PRICE AMOUNT 1 Front - and rear brake cables 100.00 100.00 2 New set of pedal arms 15.00 30.00 3 - Labor 3hrs 5.00 15.00 Subtotal 145.00 Sales Tax 6.25% 9.06 TOTAL $ 154.06 - Terms & Conditions Payment is due within 15 days Please make checks payable - to: East Repair Inc. ' - DocSize: - - - 2000 - - 1413 - Email: - UICategory: Vendor & Customer - UIName: Email - UIType: Text - matches: - - keyword: - match: - matchmulti: - page: - value: - Freight: - UICategory: VAT & Amounts - UIName: Freight - UIType: Amount - matches: - - keyword: - match: - matchmulti: - page: - value: - IBAN: - UICategory: Payment Instructions - UIName: IBAN - UIType: Text - matches: - - keyword: - match: - matchmulti: - page: - value: - InvoiceDate: - UICategory: Basic Information - UIName: Invoice Date - UIType: Date - matches: - - keyword: - - 972 - - 499 - - 1113 - - 531 - - 1042.5 - - 515 - - Receipt Date - - Receipt Date - match: '2019-11-02' - matchmulti: 11/02/2019 - page: 0 - value: - - 1193 - - 500 - - 1309 - - 527 - - 1251 - - 513.5 - - 11/02/2019 - - 11/02/2019 - InvoiceNumber: - UICategory: Basic Information - UIName: Invoice Number - UIType: Text - matches: - - keyword: - match: - matchmulti: - page: - value: - LineItems: - - - 'AMOUNT ': - - '100.00' - 'DESCRIPTION ': - - Front and rear brake cables - 'QTY ': - - '1' - 'UNIT PRICE ': - - '100.00' - - 'AMOUNT ': - - '30.00' - 'DESCRIPTION ': - - New set of pedal arms - 'QTY ': - - '2' - 'UNIT PRICE ': - - '15.00' - - 'AMOUNT ': - - '15.00' - 'DESCRIPTION ': - - Labor 3hrs - 'QTY ': - - '3' - 'UNIT PRICE ': - - '5.00' - LineItems_standardHeader: - - - Description: Front and rear brake cables - LineAmount: 100 - Quantity: 1 - UnitAmount: 100 - - Description: New set of pedal arms - LineAmount: 30 - Quantity: 2 - UnitAmount: 15 - - Description: Labor 3hrs - LineAmount: 15 - Quantity: 3 - UnitAmount: 5 - OtherAddress: - UICategory: Vendor & Customer - UIName: Other Address - UIType: Text - matches: - - keyword: - match: - matchmulti: - page: - value: - OtherDate: - UICategory: Basic Information - UIName: Other Date - UIType: Date - matches: - - keyword: - match: - matchmulti: - page: - value: - PONumber: - UICategory: Vendor & Customer - UIName: PO Number - UIType: Text - matches: - - keyword: - - 1055 - - 553 - - 1114 - - 575 - - 1084.5 - - 564 - - 'PO #' - - 'P.O. #' - match: 2312/2019 - matchmulti: 2312/2019 - page: 0 - value: - - 1200 - - 553 - - 1310 - - 576 - - 1255 - - 564.5 - - 2312/2019 - - 2312/2019 - PaymentDate: - UICategory: Basic Information - UIName: Payment Date - UIType: Date - matches: - - keyword: - - 1012 - - 600 - - 1112 - - 622 - - 1062 - - 611 - - Due Date - - Due Date - match: '2019-02-26' - matchmulti: 26/02/2019 - page: 0 - value: - - 1193 - - 600 - - 1310 - - 623 - - 1251.5 - - 611.5 - - 26/02/2019 - - 26/02/2019 - SenderAddress: - UICategory: Vendor & Customer - UIName: Vendor Address - UIType: Text - matches: - - keyword: - - 106 - - 134 - - 385 - - 174 - - 245.5 - - 154 - - East Repair Inc. - - East Repair Inc. - match: East Repair Inc. - matchmulti: East Repair Inc. - page: 0 - value: - - 106 - - 134 - - 385 - - 174 - - 245.5 - - 154 - - East Repair Inc. - - East Repair Inc. - ShippingAddress: - UICategory: Vendor & Customer - UIName: Shipping Address - UIType: Text - matches: - - keyword: - - 529 - - 454 - - 766 - - 595 - - 647.5 - - 524.5 - - |- - Ship To - John Smith - 3787 Pineview Drive - Cambridge, MA 12210 - - |- - Ship To - John Smith - 3787 Pineview Drive - Cambridge , MA 12210 - match: |- - John Smith - 3787 Pineview Drive - Cambridge, MA 12210 - matchmulti: Ship To John Smith 3787 Pineview Drive Cambridge , MA 12210 - page: 0 - value: - - 529 - - 454 - - 766 - - 595 - - 647.5 - - 524.5 - - |- - Ship To - John Smith - 3787 Pineview Drive - Cambridge, MA 12210 - - |- - Ship To - John Smith - 3787 Pineview Drive - Cambridge , MA 12210 - SmallBoxes: - - box: - - 106 - - 134 - - 385 - - 174 - - 245.5 - - 154 - - East Repair Inc. - - East Repair Inc. - page: 0 - - box: - - 1148 - - 129 - - 1308 - - 171 - - 1228 - - 150 - - RECEIPT - - RECEIPT - page: 0 - - box: - - 105 - - 208 - - 302 - - 241 - - 203.5 - - 224.5 - - 1912 Harvest Lane - - 1912 Harvest Lane - page: 0 - - box: - - 102 - - 242 - - 322 - - 273 - - 212 - - 257.5 - - New York, NY 12210 - - New York , NY 12210 - page: 0 - - box: - - 1232 - - 455 - - 1307 - - 479 - - 1269.5 - - 467 - - US-001 - - US-001 - page: 0 - - box: - - 104 - - 452 - - 174 - - 481 - - 139 - - 466.5 - - Bill To - - Bill To - page: 0 - - box: - - 103 - - 492 - - 220 - - 524 - - 161.5 - - 508 - - John Smith - - John Smith - page: 0 - - box: - - 103 - - 527 - - 262 - - 559 - - 182.5 - - 543 - - 2 Court Square - - 2 Court Square - page: 0 - - box: - - 102 - - 560 - - 322 - - 591 - - 212 - - 575.5 - - New York, NY 12210 - - New York , NY 12210 - page: 0 - - box: - - 529 - - 454 - - 616 - - 482 - - 572.5 - - 468 - - Ship To - - Ship To - page: 0 - - box: - - 530 - - 494 - - 647 - - 523 - - 588.5 - - 508.5 - - John Smith - - John Smith - page: 0 - - box: - - 530 - - 527 - - 744 - - 555 - - 637 - - 541 - - 3787 Pineview Drive - - 3787 Pineview Drive - page: 0 - - box: - - 529 - - 559 - - 766 - - 595 - - 647.5 - - 577 - - Cambridge, MA 12210 - - Cambridge , MA 12210 - page: 0 - - box: - - 1009 - - 452 - - 1113 - - 483 - - 1061 - - 467.5 - - 'Receipt #' - - 'Receipt #' - page: 0 - - box: - - 972 - - 499 - - 1113 - - 531 - - 1042.5 - - 515 - - Receipt Date - - Receipt Date - page: 0 - - box: - - 1193 - - 500 - - 1309 - - 527 - - 1251 - - 513.5 - - 11/02/2019 - - 11/02/2019 - page: 0 - - box: - - 1055 - - 553 - - 1114 - - 575 - - 1084.5 - - 564 - - 'PO #' - - 'P.O. #' - page: 0 - - box: - - 1200 - - 553 - - 1310 - - 576 - - 1255 - - 564.5 - - 2312/2019 - - 2312/2019 - page: 0 - - box: - - 1012 - - 600 - - 1112 - - 622 - - 1062 - - 611 - - Due Date - - Due Date - page: 0 - - box: - - 1193 - - 600 - - 1310 - - 623 - - 1251.5 - - 611.5 - - 26/02/2019 - - 26/02/2019 - page: 0 - - box: - - 130 - - 732 - - 178 - - 751 - - 154 - - 741.5 - - QTY - - QTY - page: 0 - - box: - - 422 - - 731 - - 580 - - 752 - - 501 - - 741.5 - - DESCRIPTION - - DESCRIPTION - page: 0 - - box: - - 831 - - 722 - - 962 - - 759 - - 896.5 - - 740.5 - - UNIT PRICE - - UNIT PRICE - page: 0 - - box: - - 1102 - - 730 - - 1205 - - 752 - - 1153.5 - - 741 - - AMOUNT - - AMOUNT - page: 0 - - box: - - 149 - - 793 - - 155 - - 813 - - 152 - - 803 - - '1' - - '1' - page: 0 - - box: - - 229 - - 793 - - 518 - - 816 - - 373.5 - - 804.5 - - Front and rear brake cables - - Front and rear brake cables - page: 0 - - box: - - 911 - - 793 - - 981 - - 814 - - 946 - - 803.5 - - '100.00' - - '100.00' - page: 0 - - box: - - 1220 - - 793 - - 1289 - - 816 - - 1254.5 - - 804.5 - - '100.00' - - '100.00' - page: 0 - - box: - - 148 - - 857 - - 159 - - 876 - - 153.5 - - 866.5 - - '2' - - '2' - page: 0 - - box: - - 229 - - 852 - - 463 - - 884 - - 346 - - 868 - - New set of pedal arms - - New set of pedal arms - page: 0 - - box: - - 925 - - 857 - - 981 - - 879 - - 953 - - 868 - - '15.00' - - '15.00' - page: 0 - - box: - - 1231 - - 856 - - 1290 - - 879 - - 1260.5 - - 867.5 - - '30.00' - - '30.00' - page: 0 - - box: - - 149 - - 920 - - 160 - - 939 - - 154.5 - - 929.5 - - '3' - - '3' - page: 0 - - box: - - 229 - - 918 - - 340 - - 939 - - 284.5 - - 928.5 - - Labor 3hrs - - Labor 3hrs - page: 0 - - box: - - 936 - - 920 - - 980 - - 940 - - 958 - - 930 - - '5.00' - - '5.00' - page: 0 - - box: - - 1233 - - 920 - - 1289 - - 941 - - 1261 - - 930.5 - - '15.00' - - '15.00' - page: 0 - - box: - - 897 - - 981 - - 981 - - 1003 - - 939 - - 992 - - Subtotal - - Subtotal - page: 0 - - box: - - 1219 - - 980 - - 1288 - - 1002 - - 1253.5 - - 991 - - '145.00' - - '145.00' - page: 0 - - box: - - 803 - - 1042 - - 980 - - 1063 - - 891.5 - - 1052.5 - - Sales Tax 6.25% - - Sales Tax 6.25% - page: 0 - - box: - - 1244 - - 1042 - - 1289 - - 1065 - - 1266.5 - - 1053.5 - - '9.06' - - '9.06' - page: 0 - - box: - - 872 - - 1104 - - 981 - - 1137 - - 926.5 - - 1120.5 - - TOTAL - - TOTAL - page: 0 - - box: - - 1172 - - 1101 - - 1289 - - 1140 - - 1230.5 - - 1120.5 - - "$ 154.06" - - "$ 154.06" - page: 0 - - box: - - 102 - - 1728 - - 327 - - 1760 - - 214.5 - - 1744 - - Terms & Conditions - - Terms & Conditions - page: 0 - - box: - - 104 - - 1767 - - 422 - - 1801 - - 263 - - 1784 - - Payment is due within 15 days - - Payment is due within 15 days - page: 0 - - box: - - 104 - - 1841 - - 616 - - 1871 - - 360 - - 1856 - - 'Please make checks payable to: East Repair Inc.' - - 'Please make checks payable to: East Repair Inc.' - page: 0 - Subtotal: - UICategory: VAT & Amounts - UIName: Subtotal - UIType: Amount - matches: - - keyword: - - 897 - - 775 - - 981 - - 797 - - 939 - - 992 - - Subtotal - - Subtotal - match: 145 - matchmulti: '145.00' - page: 0 - value: - - 1219 - - 980 - - 1288 - - 1002 - - 1253.5 - - 991 - - '145.00' - - '145.00' - Supplier: - SwiftCode: - UICategory: Payment Instructions - UIName: Swift Code - UIType: Text - matches: - - keyword: - match: - matchmulti: - page: - value: - TableDetected: true - Tables: - - GridX: - - 106 - - 212 - - 797 - - 1002 - - 1309 - GridY: - - 775 - - 833 - - 895 - - 958 - GridYPages: - - 0 - - 0 - - 0 - - 0 - HeaderPage: 0 - header: - - 120 - - 720 - - 1293 - - 761 - headernum: 4 - TaxTotal: - UICategory: VAT & Amounts - UIName: Tax Total - UIType: Amount - matches: - - keyword: - - 803 - - 836 - - 980 - - 857 - - 891.5 - - 1052.5 - - Sales Tax 6.25% - - Sales Tax 6.25% - match: 6.2 - matchmulti: Sales Tax 6.25% - page: 0 - value: - - 803 - - 1042 - - 980 - - 1063 - - 891.5 - - 1052.5 - - Sales Tax 6.25% - - Sales Tax 6.25% - Total: - UICategory: VAT & Amounts - UIName: Total - UIType: Amount - matches: - - keyword: - - 872 - - 898 - - 981 - - 931 - - 926.5 - - 1120.5 - - TOTAL - - TOTAL - match: 154.06 - matchmulti: "$ 154.06" - page: 0 - value: - - 1172 - - 1101 - - 1289 - - 1140 - - 1230.5 - - 1120.5 - - "$ 154.06" - - "$ 154.06" - Type: invoice_image - URL: - UICategory: Vendor & Customer - UIName: URL - UIType: Text - matches: - - keyword: - match: - matchmulti: - page: - value: - num_pages: 1 - docId: 7650 - status: COMPLETED - status: Success - - '401': - description: Unauthorized - content: - application/json: - schema: - $ref: '#/components/schemas/unauthorized' - '402': - description: Payment Required - content: - application/json: - schema: - $ref: '#/components/schemas/paymentrequired' - '403': - description: Forbidden - content: - application/json: - schema: - $ref: '#/components/schemas/forbidden' - '404': - description: Not Found - content: - application/json: - schema: - $ref: '#/components/schemas/notfound' - '419': - description: Input Field Missing - content: - application/json: - schema: - $ref: '#/components/schemas/inputfieldmissing' - '420': - description: Input Limit Exceeded - content: - application/json: - schema: - $ref: '#/components/schemas/inputlimitexceeded' - '422': - description: Invalid Input - content: - application/json: - schema: - $ref: '#/components/schemas/invalidinput' - '500': - description: Internal Server Error - content: - application/json: - schema: - $ref: '#/components/schemas/servererror' - '504': - description: Gateway Timeout - content: - application/json: - schema: - $ref: '#/components/schemas/gatewaytimeout' - security: - - APIAuthorizer: [] - requestBody: - content: - multipart/form-data: - schema: - $ref: '#/components/schemas/input' - required: true -components: - schemas: - success: - type: object - properties: - results: - type: object - example: { "" } - description: The result of the API call - properties: - scanDocuments: - type: object - example: { "" } - description: The details of documents - message: - type: string - example: Successfully Processed - description: Detail description on the API status - status: - type: string - example: Success - description: The status of the API call success/failure - unauthorized: - type: object - properties: - message: - type: string - example: Missing Authentication Token - status: - type: string - example: Failure - forbidden: - type: object - properties: - message: - type: string - example: Access Denied Unauthorized User - status: - type: string - example: Failure - paymentrequired: - type: object - properties: - message: - type: string - example: Insufficient Credits Kindly Top Up - status: - type: string - example: Failure - notfound: - type: object - properties: - message: - type: string - example: Invalid Request URL - status: - type: string - example: Failure - invalidinput: - type: object - properties: - message: - type: string - example: Invalid Input - status: - type: string - example: Failure - servererror: - type: object - properties: - message: - type: string - example: Internal Server Error - status: - type: string - example: Failure - gatewaytimeout: - type: object - properties: - message: - type: string - example: Request Timeout - status: - type: string - example: Failure - inputfieldmissing: - type: object - properties: - message: - type: string - example: Input Field Missing - status: - type: string - example: Failure - inputlimitexceeded: - type: object - properties: - message: - type: string - example: Input Limit Exceeded - status: - type: string - example: Failure - versions: - type: object - properties: - v1.0.0: - type: array - items: - oneOf: - - type: string - example: Published Date - Oct 30, 2020 - description: Initial version release - input: - type: object - required: - - file - - endpointUrl - properties: - file: - type: string - format: binary - default: true - example: upload file - description: The receipt document - handwritten: - type: string - description: Sholud be true of false. Default is false - securitySchemes: - APIAuthorizer: - type: apiKey - name: x-api-key - in: header - x-amazon-apigateway-authtype: custom - description: Authentication is done using the x-api-key in the request header diff --git a/yaml/taxonomy_matcher_eng.yaml b/yaml/taxonomy_matcher_eng.yaml deleted file mode 100644 index 8d91029eb..000000000 --- a/yaml/taxonomy_matcher_eng.yaml +++ /dev/null @@ -1,235 +0,0 @@ -openapi: 3.0.1 -info: - title: Taxonomy Matcher ENG - description: |+ - This NLP microservice matches the input word with the name of a leaf nodes in the predefined English taxonomy. The entire branch from the matched leaf node to the root of the corresponding taxonomy tree is returned. - - The full taxonomy consists of major categories (for e.g. retail, cars, etc.). Each category is stored as a separate taxonomy tree within the Taxonomy instance. Each node in a taxonomy tree is identified using a node_id. It has attributes: name (a human readable string), level (how far it is from the root node) and type (whether it is a root node, leaf node or body node). - - This microservice can help identify the types of concept that are frequently mentioned in an article. - - Do ensure that your text is within **5000 characters**. - x-additionalinfo: |+ - Suggested Use Cases: - - Categorise a particular word to pre-built taxonomy tree. - - - This microservice can be used to manage taxonomies, such as a hierarchy of product categories used for an eCommerce site. The information in a taxonomy is meta-information about the categories used to classify a set of things. For an eCommerce site, the set of things are items in the product catalog. Users can use this meta-information to enhance search. - version: '0.1.0' - x-subscribelink: taxonomy_matcher_eng -servers: - - url: 'https://apis.sentient.io' -tags: -- name: "v0.1.0" - description: "Published Date - Jan 24, 2020" -paths: - /microservices/nlp/taxonomy/v0.1/getpredictions: - post: - tags: - - v0.1.0 - responses: - '200': - description: success response - content: - application/json: - schema: - $ref: '#/components/schemas/success' - example: - bus: - - - - careers/job by industry/travel/bus - - 1 - - - - news/business news/travel/bus - - 1 - - '401': - description: Unauthorized - content: - application/json: - schema: - $ref: '#/components/schemas/unauthorized' - '402': - description: Payment Required - content: - application/json: - schema: - $ref: '#/components/schemas/paymentrequired' - '403': - description: Forbidden - content: - application/json: - schema: - $ref: '#/components/schemas/forbidden' - '404': - description: Not Found - content: - application/json: - schema: - $ref: '#/components/schemas/notfound' - '419': - description: Input Field Missing - content: - application/json: - schema: - $ref: '#/components/schemas/inputfieldmissing' - '413': - description: Input Limit Exceeded - content: - application/json: - schema: - $ref: '#/components/schemas/inputlimitexceeded' - '415': - description: Invalid Input - content: - application/json: - schema: - $ref: '#/components/schemas/invalidinput' - '500': - description: Internal Server Error - content: - application/json: - schema: - $ref: '#/components/schemas/servererror' - '504': - description: Gateway Timeout - content: - application/json: - schema: - $ref: '#/components/schemas/gatewaytimeout' - security: - - APIAuthorizer: [] - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/input' - required: true -components: - schemas: - success: - type: object - properties: - : - type: array - example: [["news/sport/swimming/bike",1]] - description: List of taxonomy for the requested object name - unauthorized: - type: object - properties: - message: - type: string - example: Missing Authentication Token - status: - type: string - example: Failure - forbidden: - type: object - properties: - message: - type: string - example: Access Denied Unauthorized User - status: - type: string - example: Failure - paymentrequired: - type: object - properties: - message: - type: string - example: Insufficient Credits Kindly Top Up - status: - type: string - example: Failure - notfound: - type: object - properties: - message: - type: string - example: Invalid Request URL - status: - type: string - example: Failure - invalidinput: - type: object - properties: - message: - type: string - example: Invalid Input - status: - type: string - example: Failure - servererror: - type: object - properties: - message: - type: string - example: Internal Server Error - status: - type: string - example: Failure - gatewaytimeout: - type: object - properties: - message: - type: string - example: Request Timeout - status: - type: string - example: Failure - inputfieldmissing: - type: object - properties: - message: - type: string - example: Input Field Missing - status: - type: string - example: Failure - inputlimitexceeded: - type: object - properties: - message: - type: string - example: Input Limit Exceeded - status: - type: string - example: Failure - - versions: - type: object - properties: - v0.1.0: - type: array - items: - oneOf: - - type: string - example: Published Date - Jan 24, 2020 - description: Initial version release - input: - type: object - required: - - text - properties: - text: - x-name: text - type: array - default: true - example: ["bus","cars","bike","train","buildings","Audi R8"] - description: |+ - A list of object names to be classified. Up to a maximum of 20 search terms can be processed each time. - - Supported formats: ASCII only - threshold: - x-name: threshold - type: number - default: true - example: 1 - description: |+ - The "threshold" specifies the level of similarity that the search term must match with terms in the taxonomy tree. Values range between 0.0 and 1.0 .It is optional. The default value is 1 (which means an exact match is required). Lowering the threshold will allow matches that are similar but not identical. - securitySchemes: - APIAuthorizer: - type: apiKey - name: x-api-key - in: header - x-amazon-apigateway-authtype: custom - description: Authentication is done using the x-api-key in the request header diff --git a/yaml/taxonomy_matcher_eng_v1.0.yaml b/yaml/taxonomy_matcher_eng_v1.0.yaml deleted file mode 100644 index 5ed626a30..000000000 --- a/yaml/taxonomy_matcher_eng_v1.0.yaml +++ /dev/null @@ -1,257 +0,0 @@ -openapi: 3.0.1 -info: - title: Taxonomy Matcher ENG - description: |+ - This NLP microservice matches the input word with the name of a leaf nodes in the predefined English taxonomy. The entire branch from the matched leaf node to the root of the corresponding taxonomy tree is returned. - - The full taxonomy consists of major categories (for e.g. retail, cars, etc.). Each category is stored as a separate taxonomy tree within the Taxonomy instance. Each node in a taxonomy tree is identified using a node_id. It has attributes: name (a human readable string), level (how far it is from the root node) and type (whether it is a root node, leaf node or body node). - - This microservice can help identify the types of concept that are frequently mentioned in an article. - - Do ensure that your text is within **5000 characters**. - version: '1.0.0' - x-additionalinfo: |+ - Suggested Use Cases: - - Categorise a particular word to pre-built taxonomy tree. - - This microservice can be used to manage taxonomies, such as a hierarchy of product categories used for an eCommerce site. The information in a taxonomy is meta-information about the categories used to classify a set of things. For an eCommerce site, the set of things are items in the product catalog. Users can use this meta-information to enhance search. - x-subscribelink: taxonomy_matcher_eng -servers: - - url: 'https://apis.sentient.io' -tags: -- name: "v1.0.0" - description: "Published Date - Oct 30, 2020" -paths: - /microservices/nlp/taxonomy/v1/getpredictions: - post: - tags: - - v1.0.0 - responses: - '200': - description: success response - content: - application/json: - schema: - $ref: '#/components/schemas/success' - example: - results: - bus: - - - - careers/job by industry/travel/bus - - 1 - - - - news/business news/travel/bus - - 1 - message: Successfully Processed - status: Success - - '401': - description: Unauthorized - content: - application/json: - schema: - $ref: '#/components/schemas/unauthorized' - '402': - description: Payment Required - content: - application/json: - schema: - $ref: '#/components/schemas/paymentrequired' - '403': - description: Forbidden - content: - application/json: - schema: - $ref: '#/components/schemas/forbidden' - '404': - description: Not Found - content: - application/json: - schema: - $ref: '#/components/schemas/notfound' - '419': - description: Input Field Missing - content: - application/json: - schema: - $ref: '#/components/schemas/inputfieldmissing' - '413': - description: Input Limit Exceeded - content: - application/json: - schema: - $ref: '#/components/schemas/inputlimitexceeded' - '415': - description: Invalid Input - content: - application/json: - schema: - $ref: '#/components/schemas/invalidinput' - '500': - description: Internal Server Error - content: - application/json: - schema: - $ref: '#/components/schemas/servererror' - '504': - description: Gateway Timeout - content: - application/json: - schema: - $ref: '#/components/schemas/gatewaytimeout' - security: - - APIAuthorizer: [] - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/input' - required: true -components: - schemas: - success: - type: object - properties: - results: - type: object - description: The result of the API call. - example: { "" } - properties: - : - type: array - example: [["news/sport/swimming/bike",1]] - description: List of taxonomy for the requested object name - message: - type: string - example: Successfully Processed - description: Detail description on the API status - status: - type: string - example: Success - description: The status of the API call success/failure - unauthorized: - type: object - properties: - message: - type: string - example: Missing Authentication Token - status: - type: string - example: Failure - invalidinput: - type: object - properties: - message: - type: string - example: Invalid Input - status: - type: string - example: Failure - forbidden: - type: object - properties: - message: - type: string - example: Access Denied Unauthorized User - status: - type: string - example: Failure - paymentrequired: - type: object - properties: - message: - type: string - example: Insufficient Credits Kindly Top Up - status: - type: string - example: Failure - notfound: - type: object - properties: - message: - type: string - example: Invalid Request URL - status: - type: string - example: Failure - servererror: - type: object - properties: - message: - type: string - example: Internal Server Error - status: - type: string - example: Failure - gatewaytimeout: - type: object - properties: - message: - type: string - example: Request Timeout - status: - type: string - example: Failure - inputfieldmissing: - type: object - properties: - message: - type: string - example: Input Field Missing - status: - type: string - example: Failure - inputlimitexceeded: - type: object - properties: - message: - type: string - example: Input Limit Exceeded - status: - type: string - example: Failure - - versions: - type: object - properties: - v1.0.0: - type: array - items: - oneOf: - - type: string - example: Published Date - Oct 30,2020 - description: Standardizing Output JSON - v0.1.0: - type: array - items: - oneOf: - - type: string - example: Published Date - Jan 24, 2020 - description: Initial version release - input: - type: object - required: - - text - properties: - text: - x-name: text - type: array - default: true - example: ["bus","cars","bike","train","buildings","Audi R8"] - description: |+ - A list of object names to be classified. Up to a maximum of 20 search terms can be processed each time. - - Supported formats: ASCII only - threshold: - x-name: threshold - type: number - default: true - example: 1 - description: |+ - The "threshold" specifies the level of similarity that the search term must match with terms in the taxonomy tree. Values range between 0.0 and 1.0 .It is optional. The default value is 1 (which means an exact match is required). Lowering the threshold will allow matches that are similar but not identical. - securitySchemes: - APIAuthorizer: - type: apiKey - name: x-api-key - in: header - x-amazon-apigateway-authtype: custom - description: Authentication is done using the x-api-key in the request header diff --git a/yaml/text-to-speech_chi.yaml b/yaml/text-to-speech_chi.yaml deleted file mode 100644 index 9b7fccfe3..000000000 --- a/yaml/text-to-speech_chi.yaml +++ /dev/null @@ -1,228 +0,0 @@ -openapi: 3.0.1 -info: - title: Text-To-Speech CHI - description: |+ - This Voice microservice converts Mandarin text into speech in a female voice. - - The Text-to-Speech AI generated synthesized voice speaks with native Mandarin accent. - - Do ensure that your text is **within 750 characters**. - x-additionalinfo: |+ - Suggested Use Cases: - - Voice bots in contact centers - Deliver a better voice experience for customer service by dynamically generating speech, instead of playing static, pre-recorded audio. Engage with synthesized voices that give callers a sense of familiarity and personalization. - - - Voice generation in devices - Enable natural communications with users by empowering your devices to speak humanlike voices. Build an end-to-end voice user interface together with Speech-to-Text and improve user experience with easy and engaging interactions. - - - Accessible EPGs (Electronic Program Guides) - Implement text-to-speech functionality in EPGs to provide a better user experience to customers and meet accessibility requirements for services and applications. - version: '0.1.0' - x-subscribelink: text-to-speech_chi -servers: - - url: 'https://apis.sentient.io' -tags: -- name: "v0.1.0" - description: "Published Date - Sep 28, 2018" -paths: - /microservices/voice/ttssch/v0.1/getpredictions: - post: - tags: - - v0.1.0 - responses: - '200': - description: success response - content: - application/json: - schema: - $ref: '#/components/schemas/success' - example: - audioContent: UklGRiQAAABXQVZFZm10IBAAAAABAAEAgD4AAAB9AAACABAAZGF0YQAAAAA= - message: Successfully Processed - status: Success - '401': - description: Unauthorized - content: - application/json: - schema: - $ref: '#/components/schemas/unauthorized' - '402': - description: Payment Required - content: - application/json: - schema: - $ref: '#/components/schemas/paymentrequired' - '403': - description: Forbidden - content: - application/json: - schema: - $ref: '#/components/schemas/forbidden' - '404': - description: Not Found - content: - application/json: - schema: - $ref: '#/components/schemas/notfound' - '419': - description: Input Field Missing - content: - application/json: - schema: - $ref: '#/components/schemas/inputfieldmissing' - '413': - description: Input Limit Exceeded - content: - application/json: - schema: - $ref: '#/components/schemas/inputlimitexceeded' - '415': - description: Invalid Input - content: - application/json: - schema: - $ref: '#/components/schemas/invalidinput' - '500': - description: Internal Server Error - content: - application/json: - schema: - $ref: '#/components/schemas/servererror' - '504': - description: Gateway Timeout - content: - application/json: - schema: - $ref: '#/components/schemas/gatewaytimeout' - security: - - APIAuthorizer: [] - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/input' - required: true -components: - schemas: - success: - type: object - properties: - message: - type: string - example: Successfully Processed - description: Detail description on the api status - status: - type: string - example: Success - description: The status of the API call success/failure - audioContent: - type: string - example: UklGRiQAAABXQVZFZm10IBAAAAABAAEAgD4AAAB9AAACABAAZGF0YQAAAAA= - description: Audio file converted to base64 encoded string. - unauthorized: - type: object - properties: - message: - type: string - example: Missing Authentication Token - status: - type: string - example: Failure - forbidden: - type: object - properties: - message: - type: string - example: Access Denied Unauthorized User - status: - type: string - example: Failure - invalidinput: - type: object - properties: - message: - type: string - example: Invalid Input - status: - type: string - example: Failure - paymentrequired: - type: object - properties: - message: - type: string - example: Insufficient Credits Kindly Top Up - status: - type: string - example: Failure - notfound: - type: object - properties: - message: - type: string - example: Invalid Request URL - status: - type: string - example: Failure - servererror: - type: object - properties: - message: - type: string - example: Internal Server Error - status: - type: string - example: Failure - gatewaytimeout: - type: object - properties: - message: - type: string - example: Request Timeout - status: - type: string - example: Failure - inputfieldmissing: - type: object - properties: - message: - type: string - example: Input Field Missing - status: - type: string - example: Failure - inputlimitexceeded: - type: object - properties: - message: - type: string - example: Input Limit Exceeded - status: - type: string - example: Failure - versions: - type: object - properties: - v0.1.0: - type: array - items: - oneOf: - - type: string - example: Published Date - Sep 28,2018 - description: Initial version release - input: - type: object - required: - - text - properties: - text: - x-name: text - type: string - default: true - example: 大家好 我叫 墓园 - description: |+ - Input text - securitySchemes: - APIAuthorizer: - type: apiKey - name: x-api-key - in: header - x-amazon-apigateway-authtype: custom - description: Authentication is done using the x-api-key in the request header diff --git a/yaml/text-to-speech_eng.yaml b/yaml/text-to-speech_eng.yaml deleted file mode 100644 index b40128aff..000000000 --- a/yaml/text-to-speech_eng.yaml +++ /dev/null @@ -1,347 +0,0 @@ -openapi: 3.0.1 -info: - title: Text-To-Speech ENG - description: | - "This Voice microservice converts English text into speech in a female voice. - - The Text-to-Speech AI generated synthesized voice speaks with Singapore English accent. - - Do ensure that your text is within **2000 characters**. - x-additionalinfo: |+ - Suggested Use Cases: - - Transcribes spoken English words, sentences or phrases into written forms - - - Voice bots in contact centers - deliver a better voice experience for customer service by dynamically generating speech, instead of playing static, pre-recorded audio. Engage with synthesized voices that give callers a sense of familiarity and personalization. - - - Voice generation in devices - enable natural communications with users by empowering your devices to speak humanlike voices. Build an end-to-end voice user interface together with Speech-to-Text and improve user experience with easy and engaging interactions. - - - Accessible EPGs (Electronic Program Guides) - implement text-to-speech functionality in EPGs to provide a better user experience to customers and meet accessibility requirements for services and applications. - version: '0.1.0' - x-subscribelink: text-to-speech_eng -servers: - - url: 'https://apis.sentient.io' -tags: - - name: v0.1.0 - description: 'Published Date - Sep 28, 2018' -paths: - /microservices/voice/ttseng/v0.1/getpredictions: - post: - tags: - - v0.1.0 - responses: - '200': - description: success response - content: - application/json: - schema: - $ref: '#/components/schemas/success' - example: - audioContent: UklGRiQAAABXQVZFZm10IBAAAAABAAEAgD4AAAB9AAACABAAZGF0YQAAAAA= - message: Successfully Processed - status: Success - '401': - description: Unauthorized - content: - application/json: - schema: - $ref: '#/components/schemas/unauthorized' - '402': - description: Payment Required - content: - application/json: - schema: - $ref: '#/components/schemas/paymentrequired' - '403': - description: Forbidden - content: - application/json: - schema: - $ref: '#/components/schemas/forbidden' - '404': - description: Not Found - content: - application/json: - schema: - $ref: '#/components/schemas/notfound' - '419': - description: Input Field Missing - content: - application/json: - schema: - $ref: '#/components/schemas/inputfieldmissing' - '413': - description: Input Limit Exceeded - content: - application/json: - schema: - $ref: '#/components/schemas/inputlimitexceeded' - '415': - description: Invalid Input - content: - application/json: - schema: - $ref: '#/components/schemas/invalidinput' - '500': - description: Internal Server Error - content: - application/json: - schema: - $ref: '#/components/schemas/servererror' - '504': - description: Gateway Timeout - content: - application/json: - schema: - $ref: '#/components/schemas/gatewaytimeout' - security: - - APIAuthorizer: [] - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/input' - required: true - x-codeSamples: - - lang: Python + Python3 - source: |- - import http.client - - conn = http.client.HTTPSConnection("apis.sentient.io") - - payload = "{\"text\":\"Testing microservice\"}" - - headers = { - 'content-type': "application/json", - 'x-api-key': "REPLACE_KEY_VALUE" - } - - conn.request("POST", "/microservices/voice/ttseng/v0.1/getpredictions", payload, headers) - - res = conn.getresponse() - data = res.read() - - print(data.decode("utf-8")) - - lang: Csharp + Restsharp - source: |- - var client = new RestClient("https://apis.sentient.io/microservices/voice/ttseng/v0.1/getpredictions"); - var request = new RestRequest(Method.POST); - request.AddHeader("content-type", "application/json"); - request.AddHeader("x-api-key", "REPLACE_KEY_VALUE"); - request.AddParameter("application/json", "{\"text\":\"Testing microservice\"}", ParameterType.RequestBody); - IRestResponse response = client.Execute(request); - - lang: Go + Native - source: "package main\n\nimport (\n\t\"fmt\"\n\t\"strings\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://apis.sentient.io/microservices/voice/ttseng/v0.1/getpredictions\"\n\n\tpayload := strings.NewReader(\"{\\\"text\\\":\\\"Testing microservice\\\"}\")\n\n\treq, _ := http.NewRequest(\"POST\", url, payload)\n\n\treq.Header.Add(\"content-type\", \"application/json\")\n\treq.Header.Add(\"x-api-key\", \"REPLACE_KEY_VALUE\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}" - - lang: Java + Unirest - source: |- - HttpResponse response = Unirest.post("https://apis.sentient.io/microservices/voice/ttseng/v0.1/getpredictions") - .header("content-type", "application/json") - .header("x-api-key", "REPLACE_KEY_VALUE") - .body("{\"text\":\"Testing microservice\"}") - .asString(); - - lang: Node + Native - source: |- - const http = require("https"); - - const options = { - "method": "POST", - "hostname": "apis.sentient.io", - "port": null, - "path": "/microservices/voice/ttseng/v0.1/getpredictions", - "headers": { - "content-type": "application/json", - "x-api-key": "REPLACE_KEY_VALUE" - } - }; - - const req = http.request(options, function (res) { - const chunks = []; - - res.on("data", function (chunk) { - chunks.push(chunk); - }); - - res.on("end", function () { - const body = Buffer.concat(chunks); - console.log(body.toString()); - }); - }); - - req.write(JSON.stringify({text: 'Testing microservice'})); - req.end(); - - lang: Php + Curl - source: |- - "https://apis.sentient.io/microservices/voice/ttseng/v0.1/getpredictions", - CURLOPT_RETURNTRANSFER => true, - CURLOPT_ENCODING => "", - CURLOPT_MAXREDIRS => 10, - CURLOPT_TIMEOUT => 30, - CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, - CURLOPT_CUSTOMREQUEST => "POST", - CURLOPT_POSTFIELDS => "{\"text\":\"Testing microservice\"}", - CURLOPT_HTTPHEADER => [ - "content-type: application/json", - "x-api-key: REPLACE_KEY_VALUE" - ], - ]); - - $response = curl_exec($curl); - $err = curl_error($curl); - - curl_close($curl); - - if ($err) { - echo "cURL Error #:" . $err; - } else { - echo $response; - } - - lang: Ruby + Native - source: |- - require 'uri' - require 'net/http' - require 'openssl' - - url = URI("https://apis.sentient.io/microservices/voice/ttseng/v0.1/getpredictions") - - http = Net::HTTP.new(url.host, url.port) - http.use_ssl = true - http.verify_mode = OpenSSL::SSL::VERIFY_NONE - - request = Net::HTTP::Post.new(url) - request["content-type"] = 'application/json' - request["x-api-key"] = 'REPLACE_KEY_VALUE' - request.body = "{\"text\":\"Testing microservice\"}" - - response = http.request(request) - puts response.read_body -components: - schemas: - success: - type: object - properties: - message: - type: string - example: Successfully Processed - description: Detail description on the api status - status: - type: string - example: Success - description: The status of the API call success/failure - audioContent: - type: string - example: UklGRiQAAABXQVZFZm10IBAAAAABAAEAgD4AAAB9AAACABAAZGF0YQAAAAA= - description: Audio file converted to base64 encoded string. - unauthorized: - type: object - properties: - message: - type: string - example: Missing Authentication Token - status: - type: string - example: Failure - invalidinput: - type: object - properties: - message: - type: string - example: Invalid Input - status: - type: string - example: Failure - forbidden: - type: object - properties: - message: - type: string - example: Access Denied Unauthorized User - status: - type: string - example: Failure - paymentrequired: - type: object - properties: - message: - type: string - example: Insufficient Credits Kindly Top Up - status: - type: string - example: Failure - notfound: - type: object - properties: - message: - type: string - example: Invalid Request URL - status: - type: string - example: Failure - servererror: - type: object - properties: - message: - type: string - example: Internal Server Error - status: - type: string - example: Failure - gatewaytimeout: - type: object - properties: - message: - type: string - example: Request Timeout - status: - type: string - example: Failure - inputfieldmissing: - type: object - properties: - message: - type: string - example: Input Field Missing - status: - type: string - example: Failure - inputlimitexceeded: - type: object - properties: - message: - type: string - example: Input Limit Exceeded - status: - type: string - example: Failure - versions: - type: object - properties: - v0.1.0: - type: array - items: - oneOf: - - type: string - example: 'Published Date - Sep 28,2018' - description: Initial version release - input: - type: object - required: - - text - properties: - text: - x-name: text - type: string - default: true - example: Testing microservice - description: | - Input text - securitySchemes: - APIAuthorizer: - type: apiKey - name: x-api-key - in: header - x-amazon-apigateway-authtype: custom - description: Authentication is done using the x-api-key in the request header diff --git a/yaml/urls_retrieval.yaml b/yaml/urls_retrieval.yaml deleted file mode 100644 index fe63ae65d..000000000 --- a/yaml/urls_retrieval.yaml +++ /dev/null @@ -1,271 +0,0 @@ -openapi: 3.0.1 -info: - title: URLs Retrieval - description: |+ - This Utility microservice crawls and retrieves content from the input URLs, up to the specified depth. - - Default depth is 0 and maximum number of URLs is 500. - x-additionalinfo: |+ - Suggested Use Cases: - - Use this microservice to update web content or indices of other sites' web content. - version: '0.2.1' - x-subscribelink: urls_retrieval -servers: - - url: 'https://apis.sentient.io' -tags: -- name: "v0.2.1" - description: "Published Date - Dec 04, 2020" -paths: - /microservices/utility/crawlurls/v0/getresults: - post: - tags: - - v0.2.1 - responses: - '200': - description: success response - content: - application/json: - schema: - $ref: '#/components/schemas/success' - example: - message: Successfully Processed - results: - urls: - - https://www.sentient.io/ja/ - - https://www.sentient.io/ja/ai-data - - https://www.sentient.io/ja/ai-colab - - https://www.sentient.io/ja/data-alliance - - https://www.sentient.io/ja/team - - https://www.sentient.io/ja/contact - - https://www.sentient.io/ja - status: Success - '401': - description: Unauthorized - content: - application/json: - schema: - $ref: '#/components/schemas/unauthorized' - '402': - description: Payment Required - content: - application/json: - schema: - $ref: '#/components/schemas/paymentrequired' - '403': - description: Forbidden - content: - application/json: - schema: - $ref: '#/components/schemas/forbidden' - '404': - description: Not Found - content: - application/json: - schema: - $ref: '#/components/schemas/notfound' - '419': - description: Input Field Missing - content: - application/json: - schema: - $ref: '#/components/schemas/inputfieldmissing' - '413': - description: Input Limit Exceeded - content: - application/json: - schema: - $ref: '#/components/schemas/inputlimitexceeded' - '415': - description: Invalid Input - content: - application/json: - schema: - $ref: '#/components/schemas/invalidinput' - '500': - description: Internal Server Error - content: - application/json: - schema: - $ref: '#/components/schemas/servererror' - '504': - description: Gateway Timeout - content: - application/json: - schema: - $ref: '#/components/schemas/gatewaytimeout' - security: - - APIAuthorizer: [] - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/input' - required: true -components: - schemas: - success: - type: object - properties: - message: - type: string - example: Successfully Processed - description: Response message - results: - type: object - example: {} - description: Json Object of returned results - properties: - urls: - type: array - example: [https://www.sentient.io/ja/,https://www.sentient.io/ja/ai-data] - description: Scrapped urls from the webpage. - items: - oneOf: - - type: string - example: https://www.sentient.io/ja/ - - type: string - example: https://www.sentient.io/ja/ai-data - - type: string - example: https://www.sentient.io/ja/ai-colab - - type: string - example: https://www.sentient.io/ja/data-alliance - - type: string - example: https://www.sentient.io/ja/team - - type: string - example: https://www.sentient.io/ja/contact - - type: string - example: https://www.sentient.io/ja - status: - type: string - example: Success - description: API success call. - unauthorized: - type: object - properties: - message: - type: string - example: Missing Authentication Token - status: - type: string - example: Failure - forbidden: - type: object - properties: - message: - type: string - example: Access Denied Unauthorized User - status: - type: string - example: Failure - paymentrequired: - type: object - properties: - message: - type: string - example: Insufficient Credits Kindly Top Up - status: - type: string - example: Failure - invalidinput: - type: object - properties: - message: - type: string - example: Invalid Input - status: - type: string - example: Failure - notfound: - type: object - properties: - message: - type: string - example: Invalid Request URL - status: - type: string - example: Failure - servererror: - type: object - properties: - message: - type: string - example: Internal Server Error - status: - type: string - example: Failure - gatewaytimeout: - type: object - properties: - message: - type: string - example: Request Timeout - status: - type: string - example: Failure - inputfieldmissing: - type: object - properties: - message: - type: string - example: Input Field Missing - status: - type: string - example: Failure - inputlimitexceeded: - type: object - properties: - message: - type: string - example: Input Limit Exceeded - status: - type: string - example: Failure - versions: - type: object - properties: - v0.2.1: - type: array - items: - oneOf: - - type: string - example: Published Date - Dec 04, 2020 - description: Patch Update - v0.2.0: - type: array - items: - oneOf: - - type: string - example: Published Date - Oct 30, 2020 - description: Partial URL support - v0.1.0: - type: array - items: - oneOf: - - type: string - example: Published Date - Sep 1, 2020 - description: Initial version release - input: - type: object - properties: - url: - type: string - default: true - example: https://www.sentient.io/ja/ - description: url - depth: - type: integer - example: "2" - default: false - description: Default is 0. - numberofurls: - type: integer - example: "10" - default: false - description: Default value is 100. - securitySchemes: - APIAuthorizer: - type: apiKey - name: x-api-key - in: header - x-amazon-apigateway-authtype: custom - description: Authentication is done using the x-api-key in the request header diff --git a/yaml/video-to-audio_convertor.yaml b/yaml/video-to-audio_convertor.yaml deleted file mode 100644 index febe39416..000000000 --- a/yaml/video-to-audio_convertor.yaml +++ /dev/null @@ -1,239 +0,0 @@ -openapi: 3.0.1 -info: - title: Video-To-Audio Converter - description: |+ - This API is used to extract the sound from a video file and save it in an audio file. - - The size of your video file should **not exceed 3.5 MB**. - version: '0.1.0' - x-additionalinfo: |+ - Suggested Use Cases: - - For building applications that extracts audio from videos in batches. Users can further pipe the audio into microservices involving ASR for further transciption. - x-subscribelink: video-to-audio_convertor -servers: - - url: 'https://apis.sentient.io' -tags: -- name: "v0.1.0" - description: "Published Date - Mar 06, 2020" -paths: - /microservices/utility/videotoaudio/v0.1/getresults: - post: - tags: - - v0.1.0 - responses: - '200': - description: success response - content: - application/json: - schema: - $ref: '#/components/schemas/success' - example: - results: - AudioContent: UklGRoboDgBXQVZFZm10IBAAAAABAAEAgD4AAAB9AAACABAATElTVBoAAABJTkZPSVNGVA4AAABMYXZmNTguMjAuMTAwAGRhdGFA6A4AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA.... - message: Successfully Processed - status: Success - '401': - description: Unauthorized - content: - application/json: - schema: - $ref: '#/components/schemas/unauthorized' - '402': - description: Payment Required - content: - application/json: - schema: - $ref: '#/components/schemas/paymentrequired' - '403': - description: Forbidden - content: - application/json: - schema: - $ref: '#/components/schemas/forbidden' - '404': - description: Not Found - content: - application/json: - schema: - $ref: '#/components/schemas/notfound' - '419': - description: Input Field Missing - content: - application/json: - schema: - $ref: '#/components/schemas/inputfieldmissing' - '413': - description: Input Limit Exceeded - content: - application/json: - schema: - $ref: '#/components/schemas/inputlimitexceeded' - '415': - description: Invalid Input - content: - application/json: - schema: - $ref: '#/components/schemas/invalidinput' - '500': - description: Internal Server Error - content: - application/json: - schema: - $ref: '#/components/schemas/servererror' - '504': - description: Gateway Timeout - content: - application/json: - schema: - $ref: '#/components/schemas/gatewaytimeout' - security: - - APIAuthorizer: [] - requestBody: - description: Input parameters

FieldType Description
filePathFileRequired. The file object
Maximum file size up to - 3.5MB
samplerateStringOptional. Sample rate of the audio file in Hz
channelStringOptional. Indicates the type of audio channel. Value must be 1 for mono or 2 for Stereo. Default is 2(Stereo)


- content: - multipart/form-data: - schema: - $ref: '#/components/schemas/input' - # required: true -components: - schemas: - success: - type: object - properties: - results: - type: object - example: { "" } - description: Json Object of returned results - properties: - AudioContent: - type: string - description: Audio file converted to base64 encoded string. - example: UklGRoboDgBXQVZFZm10IBAAAAABAAEAgD4AAAB9AAACABAATElTVBoAAABJTkZPSVNGVA4AAABMYXZmNTguMjAuMTAwAGRhdGFA6A4AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA.... - message: - type: string - example: Successfully Processed - description: Detail description on the API status - status: - type: string - example: Success - description: The status of the API call success/failure - unauthorized: - type: object - properties: - message: - type: string - example: Missing Authentication Token - status: - type: string - example: Failure - forbidden: - type: object - properties: - message: - type: string - example: Access Denied Unauthorized User - status: - type: string - example: Failure - paymentrequired: - type: object - properties: - message: - type: string - example: Insufficient Credits Kindly Top Up - status: - type: string - example: Failure - notfound: - type: object - properties: - message: - type: string - example: Invalid Request URL - status: - type: string - example: Failure - servererror: - type: object - properties: - message: - type: string - example: Internal Server Error - status: - type: string - example: Failure - gatewaytimeout: - type: object - properties: - message: - type: string - example: Request Timeout - status: - type: string - example: Failure - inputfieldmissing: - type: object - properties: - message: - type: string - example: Input Field Missing - status: - type: string - example: Failure - invalidinput: - type: object - properties: - message: - type: string - example: Invalid Input - status: - type: string - example: Failure - inputlimitexceeded: - type: object - properties: - message: - type: string - example: Input Limit Exceeded - status: - type: string - example: Failure - input: - type: object - required: - - filePath - properties: - filePath: - type: string - format: binary - example: sample.mp4 - default: true - description: The file object. - Supported formats: 3g2, avi, flv, mkv, mov, mp4, ogv, webm, wmv, m4v. - samplerate: - type: string - example: "16000" - default: false - description: Sample rate of the audio file in Hz. That there is no set Hz range. Note that decimals and negative values are not supported. - channel: - type: string - example: "1" - default: false - description: Indicates the type of audio channel. Value must be 1 for mono or 2 for Stereo. Default is 2(Stereo) - versions: - type: object - properties: - v0.1.0: - type: array - items: - oneOf: - - type: string - example: Published Date - Mar 06, 2020 - description: Initial version release - securitySchemes: - APIAuthorizer: - type: apiKey - name: x-api-key - in: header - x-amazon-apigateway-authtype: custom - description: Authentication is done using the x-api-key in the request header diff --git a/yaml/video-to-image_convertor.yaml b/yaml/video-to-image_convertor.yaml deleted file mode 100644 index bb2b996ee..000000000 --- a/yaml/video-to-image_convertor.yaml +++ /dev/null @@ -1,240 +0,0 @@ -openapi: 3.0.1 -info: - title: Video-to-Image Convertor - description: |+ - This Utility microservice captures the images from the input video file at the frame rate of 1 frame per second. - - Supported formats are : 3g2, avi, flv, mkv, mov, mp4, ogv, webm, wmv, m4v with H.264 codec encoded. - x-additionalinfo: |+ - Suggested Use Cases: - - Can be integrated into video editing software to create a quick preview of the footage the user is editing. - version: '0.1.0' - x-subscribelink: video-to-image_convertor -servers: - - url: 'https://apis.sentient.io' -tags: -- name: "v0.1.0" - description: "Published Date - Aug 07, 2020" -paths: - /microservices/utility/videotoimage/v0.1/getresults: - post: - tags: - - v0.1.0 - responses: - '200': - description: success response - content: - application/json: - schema: - $ref: '#/components/schemas/success' - example: - results: - fileContent: document text content - message: Successfully Processed - status: Success - '401': - description: Unauthorized - content: - application/json: - schema: - $ref: '#/components/schemas/unauthorized' - '402': - description: Payment Required - content: - application/json: - schema: - $ref: '#/components/schemas/paymentrequired' - '403': - description: Forbidden - content: - application/json: - schema: - $ref: '#/components/schemas/forbidden' - '404': - description: Not Found - content: - application/json: - schema: - $ref: '#/components/schemas/notfound' - '419': - description: Input Field Missing - content: - application/json: - schema: - $ref: '#/components/schemas/inputfieldmissing' - '413': - description: Input Limit Exceeded - content: - application/json: - schema: - $ref: '#/components/schemas/inputlimitexceeded' - '415': - description: Invalid Input - content: - application/json: - schema: - $ref: '#/components/schemas/invalidinput' - '500': - description: Internal Server Error - content: - application/json: - schema: - $ref: '#/components/schemas/servererror' - '504': - description: Gateway Timeout - content: - application/json: - schema: - $ref: '#/components/schemas/gatewaytimeout' - '406': - description: Not Acceptable - content: - application/json: - schema: - $ref: '#/components/schemas/notaccceptable' - security: - - APIAuthorizer: [] - requestBody: - content: - multipart/form-data: - schema: - $ref: '#/components/schemas/input' - # required: true -components: - schemas: - success: - type: object - properties: - results: - type: object - description: The result of the API call. - example: - fileContent: document text content - message: - type: string - example: Successfully Processed - description: Detail description on the API status - status: - type: string - example: Success - description: The status of the API call success/failure - unauthorized: - type: object - properties: - message: - type: string - example: Missing Authentication Token - status: - type: string - example: Failure - forbidden: - type: object - properties: - message: - type: string - example: Access Denied Unauthorized User - status: - type: string - example: Failure - paymentrequired: - type: object - properties: - message: - type: string - example: Insufficient Credits Kindly Top Up - status: - type: string - example: Failure - notfound: - type: object - properties: - message: - type: string - example: Invalid Request URL - status: - type: string - example: Failure - invalidinput: - type: object - properties: - message: - type: string - example: Invalid Input - status: - type: string - example: Failure - servererror: - type: object - properties: - message: - type: string - example: Internal Server Error - status: - type: string - example: Failure - gatewaytimeout: - type: object - properties: - message: - type: string - example: Request Timeout - status: - type: string - example: Failure - inputfieldmissing: - type: object - properties: - message: - type: string - example: Input Field Missing - status: - type: string - example: Failure - inputlimitexceeded: - type: object - properties: - message: - type: string - example: Input Limit Exceeded - status: - type: string - example: Failure - notaccceptable: - type: object - properties: - message: - type: string - example: Unable to Convert, Video is Encoded Using Non-H.264 Codec - status: - type: string - example: Failure - versions: - type: object - properties: - v0.1.0: - type: array - items: - oneOf: - - type: string - example: Published Date - Aug 07, 2020 - description: Initial version release - input: - type: object - required: - - filePath - properties: - filePath: - type: string - format: binary - default: true - example: sample.mp4 - description: The Video file object. - - Supported formats are : 3g2, avi, flv, mkv, mov, mp4, ogv, webm, wmv, m4v with H.264 codec encoded. - securitySchemes: - APIAuthorizer: - type: apiKey - name: x-api-key - in: header - x-amazon-apigateway-authtype: custom - description: Authentication is done using the x-api-key in the request header diff --git a/yaml/voice_activity_detection_eng.yaml b/yaml/voice_activity_detection_eng.yaml deleted file mode 100644 index 021359beb..000000000 --- a/yaml/voice_activity_detection_eng.yaml +++ /dev/null @@ -1,245 +0,0 @@ -openapi: 3.0.1 -info: - title: Voice Activity Detection ENG - description: |+ - This Voice microservice detects utterances in the input audio and outputs the start and end time of these utterances. - - An utterance is the smallest unit of speech. It is a continuous piece of speech beginning and ending with a clear pause. - x-additionalinfo: |+ - Suggested Use Cases: - - Narrate a blurb or chunk of text in English - - - Improve customer service - empower a customer service system by adding IVR (interactive voice response) and agent conversations to call centers. Perform analytics on conversation data to gain more insights into the calls and customers. - - - Enable voice control - implement voice commands such as “turn the volume up,” and voice search such as saying “what is the temperature in Paris?” - - - Transcribe multimedia content - transcribe audio and video to include captions and improve audience reach and experience. For example, this microservice can be used for indexing or subtitling video and/or multispeaker content; similar to video captioning on YouTube. - version: '0.1.0' - x-subscribelink: voice_activity_detection_eng -servers: - - url: 'https://apis.sentient.io' -tags: -- name: "v0.1.0" - description: "Published Date - Jul 03, 2020" -paths: - /microservices/voice/vad/v0.1/getpredictions: - post: - tags: - - v0.1.0 - responses: - '200': - description: success response - content: - application/json: - schema: - $ref: '#/components/schemas/success' - example: - results: [{end: 23.72,seqNum: 1,start: 0.64}] - - '401': - description: Unauthorized - content: - application/json: - schema: - $ref: '#/components/schemas/unauthorized' - '402': - description: Payment Required - content: - application/json: - schema: - $ref: '#/components/schemas/paymentrequired' - '403': - description: Forbidden - content: - application/json: - schema: - $ref: '#/components/schemas/forbidden' - '404': - description: Not Found - content: - application/json: - schema: - $ref: '#/components/schemas/notfound' - '419': - description: Input Field Missing - content: - application/json: - schema: - $ref: '#/components/schemas/inputfieldmissing' - '420': - description: Input Limit Exceeded - content: - application/json: - schema: - $ref: '#/components/schemas/inputlimitexceeded' - '422': - description: Invalid Input - content: - application/json: - schema: - $ref: '#/components/schemas/invalidinput' - '500': - description: Internal Server Error - content: - application/json: - schema: - $ref: '#/components/schemas/servererror' - '504': - description: Gateway Timeout - content: - application/json: - schema: - $ref: '#/components/schemas/gatewaytimeout' - security: - - APIAuthorizer: [] - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/input' - required: true -components: - schemas: - success: - type: object - properties: - results: - type: array - example: [{end: 23.72,seqNum: 1,start: 0.64}] - description: List of details of start and end time of utterances in the input audio - items: - oneOf: - - type: object - properties: - end: - type: number - format: float - example: 23.72 - description: End time of utterance, in seconds. Offset from the start of stream. - seqNum: - type: number - example: 1 - description: Running sequence. Starts from 1. - start: - type: number - format: float - example: 0.64 - description: Start time of utterance, in seconds. Offset from the start of stream. - unauthorized: - type: object - properties: - message: - type: string - example: Missing Authentication Token - status: - type: string - example: Failure - forbidden: - type: object - properties: - message: - type: string - example: Access Denied Unauthorized User - status: - type: string - example: Failure - paymentrequired: - type: object - properties: - message: - type: string - example: Insufficient Credits Kindly Top Up - status: - type: string - example: Failure - notfound: - type: object - properties: - message: - type: string - example: Invalid Request URL - status: - type: string - example: Failure - invalidinput: - type: object - properties: - message: - type: string - example: Invalid Input - status: - type: string - example: Failure - servererror: - type: object - properties: - message: - type: string - example: Internal Server Error - status: - type: string - example: Failure - gatewaytimeout: - type: object - properties: - message: - type: string - example: Request Timeout - status: - type: string - example: Failure - inputfieldmissing: - type: object - properties: - message: - type: string - example: Input Field Missing - status: - type: string - example: Failure - inputlimitexceeded: - type: object - properties: - message: - type: string - example: Input Limit Exceeded - status: - type: string - example: Failure - input: - type: object - required: - - wav_base64 - properties: - wav_base64: - x-name: wav_base64 - type: string - default: true - example: UklGRkbiBABXQVZFZm10IBAAAAABA... - description: |+ - Required. Input audio file in base64 format - threshold: - x-name: threshold - type: number - format: float - default: false - example: 0.2 - description: |+ - Optional. Threshold ranges between 0.0 and 1.0 and default is 0.4 - versions: - type: object - properties: - v0.1.0: - type: array - items: - oneOf: - - type: string - example: Published Date - Jul 03,2020 - description: Initial version release - securitySchemes: - APIAuthorizer: - type: apiKey - name: x-api-key - in: header - x-amazon-apigateway-authtype: custom - description: Authentication is done using the x-api-key in the request header diff --git a/yaml/voice_activity_detection_eng_v1.0.yaml b/yaml/voice_activity_detection_eng_v1.0.yaml deleted file mode 100644 index 0ec7ac1cf..000000000 --- a/yaml/voice_activity_detection_eng_v1.0.yaml +++ /dev/null @@ -1,265 +0,0 @@ -openapi: 3.0.1 -info: - title: Voice Activity Detection ENG - description: |+ - This Voice microservice detects utterances in the input audio and outputs the start and end time of these utterances. - - An utterance is the smallest unit of speech. It is a continuous piece of speech beginning and ending with a clear pause. - version: '1.0.0' - x-additionalinfo: |+ - Suggested Use Cases: - - Narrate a blurb or chunk of text in English - - Improve customer service - empower a customer service system by adding IVR (interactive voice response) and agent conversations to call centers. Perform analytics on conversation data to gain more insights into the calls and customers. - - Enable voice control - implement voice commands such as “turn the volume up,” and voice search such as saying “what is the temperature in Paris?” - - Transcribe multimedia content - transcribe audio and video to include captions and improve audience reach and experience. For example, this microservice can be used for indexing or subtitling video and/or multispeaker content; similar to video captioning on YouTube. - x-subscribelink: voice_activity_detection_eng -servers: - - url: 'https://apis.sentient.io' -tags: -- name: "v1.0.0" - description: "Published Date - Dec 09, 2020" -paths: - /microservices/voice/vad/v1/getpredictions: - post: - tags: - - v1.0.0 - responses: - '200': - description: success response - content: - application/json: - schema: - $ref: '#/components/schemas/success' - example: - results: - output: [{end: 23.72,seqNum: 1,start: 0.64}] - message: Successfully Processed - status: Success - - '401': - description: Unauthorized - content: - application/json: - schema: - $ref: '#/components/schemas/unauthorized' - '402': - description: Payment Required - content: - application/json: - schema: - $ref: '#/components/schemas/paymentrequired' - '403': - description: Forbidden - content: - application/json: - schema: - $ref: '#/components/schemas/forbidden' - '404': - description: Not Found - content: - application/json: - schema: - $ref: '#/components/schemas/notfound' - '419': - description: Input Field Missing - content: - application/json: - schema: - $ref: '#/components/schemas/inputfieldmissing' - '413': - description: Input Limit Exceeded - content: - application/json: - schema: - $ref: '#/components/schemas/inputlimitexceeded' - '415': - description: Invalid Input - content: - application/json: - schema: - $ref: '#/components/schemas/invalidinput' - '500': - description: Internal Server Error - content: - application/json: - schema: - $ref: '#/components/schemas/servererror' - '504': - description: Gateway Timeout - content: - application/json: - schema: - $ref: '#/components/schemas/gatewaytimeout' - security: - - APIAuthorizer: [] - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/input' - required: true -components: - schemas: - success: - type: object - properties: - results: - type: object - description: The result of the API call. - example: { "" } - properties: - output: - type: array - example: [{end: 23.72,seqNum: 1,start: 0.64}] - description: List of details of start and end time of utterances in the input audio - items: - oneOf: - - type: object - properties: - end: - type: number - format: float - example: 23.72 - description: End time of utterance, in seconds. Offset from the start of stream. - seqNum: - type: number - example: 1 - description: Running sequence. Starts from 1. - start: - type: number - format: float - example: 0.64 - description: Start time of utterance, in seconds. Offset from the start of stream. - message: - type: string - example: Successfully Processed - description: Detail description on the API status - status: - type: string - example: Success - description: The status of the API call success/failure - unauthorized: - type: object - properties: - message: - type: string - example: Missing Authentication Token - status: - type: string - example: Failure - forbidden: - type: object - properties: - message: - type: string - example: Access Denied Unauthorized User - status: - type: string - example: Failure - invalidinput: - type: object - properties: - message: - type: string - example: Invalid Input - status: - type: string - example: Failure - paymentrequired: - type: object - properties: - message: - type: string - example: Insufficient Credits Kindly Top Up - status: - type: string - example: Failure - notfound: - type: object - properties: - message: - type: string - example: Invalid Request URL - status: - type: string - example: Failure - servererror: - type: object - properties: - message: - type: string - example: Internal Server Error - status: - type: string - example: Failure - gatewaytimeout: - type: object - properties: - message: - type: string - example: Request Timeout - status: - type: string - example: Failure - inputfieldmissing: - type: object - properties: - message: - type: string - example: Input Field Missing - status: - type: string - example: Failure - inputlimitexceeded: - type: object - properties: - message: - type: string - example: Input Limit Exceeded - status: - type: string - example: Failure - input: - type: object - required: - - wav_base64 - properties: - wav_base64: - x-name: wav_base64 - type: string - default: true - example: UklGRkbiBABXQVZFZm10IBAAAAABA... - description: |+ - Required. Input audio file in base64 format. - threshold: - x-name: threshold - type: number - format: float - default: false - example: 0.2 - description: |+ - Optional. Threshold ranges between 0.0 and 1.0 and default is 0.4 - versions: - type: object - properties: - v1.0.0: - type: array - items: - oneOf: - - type: string - example: Published Date - Dec 09, 2020 - description: Standardizing Output JSON - v0.1.0: - type: array - items: - oneOf: - - type: string - example: Published Date - Jul 03,2020 - description: Initial version release - securitySchemes: - APIAuthorizer: - type: apiKey - name: x-api-key - in: header - x-amazon-apigateway-authtype: custom - description: Authentication is done using the x-api-key in the request header diff --git a/yaml/web_scraper.yaml b/yaml/web_scraper.yaml deleted file mode 100644 index 565429bdb..000000000 --- a/yaml/web_scraper.yaml +++ /dev/null @@ -1,393 +0,0 @@ -openapi: 3.0.1 -info: - title: Web Scraper - x-subscribelink: web_scraper - description: |+ - This API is used to extract content or specific HTML elements from web pages. Supports both HTML and Text output. The web scraper can be instructed to extract HTML elements that match the criteria given in the queryList HTTP request parameter, it can even do navigate down the html tree like get all p tag inside a div class "class":"class_name p". - x-additionalinfo: |+ - x-additionalinfo: |+ - Suggested Use Cases: - - Can be used for contact scraping, and as a component of applications used for web indexing, web mining and data mining, online price change monitoring and price comparison, product review scraping (to watch the competition), gathering real estate listings, weather data monitoring, website change detection, research, tracking online presence and reputation, web mashup and, web data integration. - - Examples: - - To get article content, as text - {"url":<URL>} - - Returns all element text matches the tag name: - {"url":<URL>, queryList:[{"title":,"findType":"find_all","tag":"h1"}]}

Few queryList Examples: - - Returns all Html matches the tag name: - queryList:[{"title":,"findType":"find_all","tag":"h1", "returnType":"html"}] - - Returns all Image Links: - queryList:[{"title":,"findType":"find_all","tag":"img", "attribute":"src"}] - - Returns all Links(URL's): - queryList:[{"title":,"findType":"find_all","tag":"a", "attribute":"href"}] - - Returns all links/text/html/images matches the class name: - queryList:[{"findType":"find_all", "class":,"tag":"a", "attribute":"href"}],{"findType":"find_all", "class":, "tag":"a"},{"findType":"find_all", "class":, "tag":"a", "returnType":"html"},{"findType":"find_all", "class":, "tag":"img", "attribute":"src"}] - - Using select in findType, either class/tag/id/nestedClassId is mandatory: - queryList:[{"findType":"select", "class_":, "tag":}] - queryList:[{"findType":"select", "class_":}] - queryList:[{"findType":"select", "tag":}] - queryList:[{"findType":"select", "id":, "tag":}] - queryList:[{"findType":"select", "id":}] - queryList:[{"findType":"select", "tag":}] - queryList:[{"findType":"select", "nestedClassId":}] - queryList:[{"findType":"select", "nestedClassId":, "returnType":"html"}] - queryList:[{"findType":"select", "nestedClassId":, "attribute":"href"}] - Example using nestedClassId:
<div>
   <h1>This is heading</h1>>
   <p class="strikeout">This is paragraph 1</h1>>
   <p class="strikeout">This is paragraph 2</h1>>
   <p class="strikeout">This is paragraph 3</h1>>
</div>
<div id="div2" class="divclass2">
   <h1>This is another heading 2</h1>>
   <p class="strikeout">This is paragraph 4</p>
   <p class="strikeout">This is paragraph 5</p>
   <p class="strikeout">This is paragraph 6</p>
   <ul>
      <li><a href="      <li class="class3"><a href="      <li><a href="   </ul>
</div>

To get tags that match one or more class names
   "queryList":[{"findType":"select", "nestedClassId":"p.strikeout"}] - To get h1 tags that match one or more class names -    "queryList":[{"findType":"select", "nestedClassId":"h1"}] - To get all p tags that matches element id -    "queryList":[{"findType":"select", "nestedClassId":"div#div2 p"}] - To get all litags that matches the element id
   "queryList":[{"findType":"select", "nestedClassId":"div#div2 ul li"}]
To get links from ul list -    "queryList":[{"findType":"select", "nestedClassId":"ul li a"}] - To get links from ul list that matches one or more class names
   "queryList":[{"findType":"select", "nestedClassId":"ul li.class3 a"}] - To get links a element that matches the element id and class name
   "queryList":[{"findType":"select", "nestedClassId":"div#div2 ul li.class3 a"}] - - Notes: - title - is an optional parameter, if title is empty the return json key is "values"
findType - find/find_all/select -    • find - returns first matching possibility
   • find_all - returns all matching possibilities -    • select - If you want to search for tags that match two or more CSS classes. either nestedClassId is mandatory - **returnType is not supported with attribute. - - The results are returned in JSON format and allow for developers to rapidly retrieve website elements like tables, images, etc. from URL - version: '1.1.1' -servers: - - url: 'https://apis.sentient.io' -tags: -- name: "v1.1.1" - description: "Published Date - Dec 04, 2020" -paths: - /microservices/utility/webscraping/v1/getresults: - post: - tags: - - v1.1.1 - responses: - '200': - description: success response - content: - application/json: - schema: - $ref: '#/components/schemas/success' - example: - message: Successfully Processed - results: - data: |- - BBC - HomeBBC HomepageSkip to contentAccessibility Helpsign-inBBC AccountHomeNewsSportReelWorklifeTravelFutureCultureMenuMorecaret-downsearchSearchHomeNewsSportReelWorklifeTravelFutureCultureMusicTVWeatherSoundsnoClose menuWelcome to the BBCBBC HomepagePM warns virus deaths could be 'twice as bad' as springAttributionUKPrince William 'contracted Covid-19 in April'AttributionUKWhich Strictly celeb is the first to leave?AttributionBBC OneMore top storiesBale heads winner to send Spurs secondAttributionFootballWho's ahead in the polls - Trump or Biden?AttributionUS Election 2020Five alternatives to saving money with the bankAttributionBBC ScotlandCoronavirus pandemicnextSpain's funeral homes strike as virus cases riseAttributionEuropeHow many coronavirus cases are there in your area?AttributionUKPolice battle to break up 700-strong illegal raveAttributionEnglandNews headlinesnextScotland's new regional Covid restrictions go liveAttributionScotlandBiden and Trump criss-cross the US as vote nearsAttributionUS Election 2020Veteran journalist Robert Fisk dies aged 74AttributionMiddle EastSport headlinesnextPogba says he made 'stupid mistake'AttributionMan Utd'I don't know the direction Man Utd are going' - MOTD2 analysis. Video'I don't know the direction Man Utd are going' - MOTD2 analysisAttributionMan UtdplayMan City win FA Cup after extra timeAttributionWomen's FootballUS Election 2020nextUS election: Trump is in the fight of his political lifeAttributionUS Election 2020The Asians who want Trump to win re-electionAttributionAsiaThe 750,000 people you didn't know could voteAttributionUS Election 2020Around the UKnextScotland's new regional Covid restrictions go liveAttributionScotlandFollow rules plea ahead of post-lockdown exit planAttributionWalesEight more coronavirus-related deaths in NIAttributionNorthern IrelandThe BBC around the UKScotlandALBAWalesCymruNI3 things we love todayYour pictures on the theme of 'urban living'AttributionIn PicturesCan you guess the celebrity childhood photo?AttributionBBC BitesizeThis Celtic rainforest has the calm vibes we all need. VideoThis Celtic rainforest has the calm vibes we all needAttributionBBC TwoplayPlant powerPlant power, Should you swap that beef burger for a vegan version?Should you swap that beef burger for a vegan version?Watch what might happen if the entire world switched to a plant-based dietAttributionBBC IdeasEntertainment news'This is one of my films of the year'AttributionBBC Radio 5 LiveBill surprises fans with nimble feet (and an elephant)AttributionBBC OneSean Connery's greatest moments on screen - in picturesAttributionEntertainment & ArtsSocietyCouple trolled for intimate wedding photoshootAttributionIndia'I raise £2,000 a month to keep my daughter alive'AttributionEngland'Collaborative effort' needed to help gay players come outAttributionEnglandOur Planet NownextThe BBC’s ongoing focus on the environment and the challenges facing our planetYou've got cheap data, how about cheap power too?Publishedduration2 days agoAttributionScience & EnvironmentThe Repair Shop's Jay Blades: 'Make do and mend' for the planet. Video, 00:03:15The Repair Shop's Jay Blades: 'Make do and mend' for the planetPublishedduration2 days agoplay3:15'You could see avocados growing in Hackney' Video, 00:01:04'You could see avocados growing in Hackney'Publishedduration3 days agoAttributionLondonplay1:04Real-life storiesSteph McGovern on 'toning it down' for TV, Trump and pregnancy. AudioSteph McGovern on 'toning it down' for TV, Trump and pregnancyAttributionBBC Radio 4listen'Nobody would help me until Keanu Reeves turned up!' Video'Nobody would help me until Keanu Reeves turned up!'AttributionBBC OneplayDoctor duped into buying 'Aladdin's lamp' for $41,600AttributionIndiaYou might have missedA magical underwater moment captured on film. VideoA magical underwater moment captured on filmAttributionBBC TwoplayHouse prices climb to record high, says NationwideAttributionBusinessCornwall Poldark house fallen into 'complete disrepair'AttributionEnglandFoodnextPerfect pot-roasts with minimum effortAttributionBBC FoodA super-speedy version of a takeaway classicAttributionBBC FoodHealthy winter warmers to keep you full for longerAttributionBBC FoodLifestyleThree tips to help you through redundancy. VideoThree tips to help you through redundancyAttributionBBC IdeasplayGet your ramble on with Countryfile's top hiking tipsAttributionBBC Children in NeedAwesome autumn activities for younger kidsAttributionTiny Happy PeopleThis week in sportWilder questions Fury gloves in rematchAttributionBoxingTributes after ex-Hearts captain Zaliukas dies aged 36AttributionFootballVerstappen sorry for offensive language during - Portuguese GPAttributionFormula 1Behind the headlinesCharlie Hebdo attack suspect tests positive for Covid-19AttributionEuropeBerlin's new €6bn airport opens... 10 years late. VideoBerlin's new €6bn airport opens... 10 years lateAttributionWorldplayNew York man plunges into rat-infested sinkholeAttributionUS & CanadaTime well spentSam Smith's track-by-track guide to their new album. AudioSam Smith's track-by-track guide to their new albumAttributionBBC Radio 1listenRap Game star shares his Black History Month picksAttributionBBC ThreeThese eerie stories might just keep you awake at nightAttributionBBC Radio 4Modern Slavery StatementRead moreThe BBC around the UKScotlandALBAWalesCymruNIOther servicesComplaintsUS Election 2020A really simple guide to the electionAttributionBBC NewsDisinformation: How to spot it. iPlayerDisinformation: How to spot itAttributionBBC iPlayeriplayerWho do you think will win?AttributionBBC NewsOdd happenings from past US electionsAttributionBBC BitesizeHomeNewsSportReelWorklifeTravelFutureCultureMusicTVWeatherSoundsTerms of UseAbout the BBCPrivacy PolicyCookiesAccessibility HelpParental GuidanceContact the BBCGet Personalised NewslettersWhy you can trust the BBCAdvertise with usAdChoices / Do Not Sell My Info© 2020 BBC. The BBC is not responsible for the content of external sites. Read about our approach to external linking. - dataList: - - imagelinks: - - https://ichef.bbci.co.uk/images/ic/240x135/p08x3gpx.jpg - - https://ichef.bbci.co.uk/curationkit-ichef/240x135/cpsprodpb/16FC3/production/_115174149_063942058.jpg - - https://ichef.bbci.co.uk/images/ic/240x135/p08x2qxp.jpg - - https://ichef.bbci.co.uk/images/ic/240x135/p08x39pc.jpg - - https://ichef.bbci.co.uk/images/ic/240x135/p08wsqty.jpg - - https://ichef.bbci.co.uk/images/ic/240x135/p08vchc7.jpg - status: Success - '400': - description: Restricted - content: - application/json: - schema: - $ref: '#/components/schemas/restricted' - '401': - description: Unauthorized - content: - application/json: - schema: - $ref: '#/components/schemas/unauthorized' - '402': - description: Payment Required - content: - application/json: - schema: - $ref: '#/components/schemas/paymentrequired' - '403': - description: Forbidden - content: - application/json: - schema: - $ref: '#/components/schemas/forbidden' - '404': - description: Not Found - content: - application/json: - schema: - $ref: '#/components/schemas/notfound' - '419': - description: Input Field Missing - content: - application/json: - schema: - $ref: '#/components/schemas/inputfieldmissing' - '413': - description: Input Limit Exceeded - content: - application/json: - schema: - $ref: '#/components/schemas/inputlimitexceeded' - '415': - description: Invalid Input - content: - application/json: - schema: - $ref: '#/components/schemas/invalidinput' - '500': - description: Internal Server Error - content: - application/json: - schema: - $ref: '#/components/schemas/servererror' - '504': - description: Gateway Timeout - content: - application/json: - schema: - $ref: '#/components/schemas/gatewaytimeout' - security: - - APIAuthorizer: [] - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/input' - required: true -components: - schemas: - success: - type: object - properties: - message: - type: string - example: successfully processed - description: Detail description on the API status - status: - type: string - example: success - description: The status of the API call success/failure - results: - type: object - example: {"data":"text content of the webpage","dataList": [{ "title": "imagelinks", "findType": "find_all", "tag": "img", "attribute": "src" }]} - description: Json Object of returned results - properties: - data: - type: string - example: "BBC - HomeBBC HomepageSkip to contentAccessibility Helpsign-inBBC AccountHomeNewsSportReelWorklifeTravelFutureCultureMenuMorecaret-downsearchSearchHomeNewsSportReelWorklifeTravelFutureCultureMusicTVWeatherSoundsnoClose menuWelcome to the BBCBBC HomepagePM warns virus deaths could be 'twice as bad' as springAttributionUKPrince William 'contracted Covid-19 in April'AttributionUKWhich Strictly celeb is the first to leave?AttributionBBC OneMore top storiesBale heads winner to send Spurs secondAttributionFootballWho's ahead in the polls - Trump or Biden?AttributionUS Election 2020Five alternatives to saving money with the bankAttributionBBC ScotlandCoronavirus pandemicnextSpain's funeral homes strike as virus cases riseAttributionEuropeHow many coronavirus cases are there in your area?AttributionUKPolice battle to break up 700-strong illegal raveAttributionEnglandNews headlinesnextScotland's new regional Covid restrictions go liveAttributionScotlandBiden and Trump criss-cross the US as vote nearsAttributionUS Election 2020Veteran journalist Robert Fisk dies aged 74AttributionMiddle EastSport headlinesnextPogba says he made 'stupid mistake'AttributionMan Utd'I don't know the direction Man Utd are going' - MOTD2 analysis. Video'I don't know the direction Man Utd are going' - MOTD2 analysisAttributionMan UtdplayMan City win FA Cup after extra timeAttributionWomen's FootballUS Election 2020nextUS election: Trump is in the fight of his political lifeAttributionUS Election 2020The Asians who want Trump to win re-electionAttributionAsiaThe 750,000 people you didn't know could voteAttributionUS Election 2020Around the UKnextScotland's new regional Covid restrictions go liveAttributionScotlandFollow rules plea ahead of post-lockdown exit planAttributionWalesEight more coronavirus-related deaths in NIAttributionNorthern IrelandThe BBC around the UKScotlandALBAWalesCymruNI3 things we love todayYour pictures on the theme of 'urban living'AttributionIn PicturesCan you guess the celebrity childhood photo?AttributionBBC BitesizeThis Celtic rainforest has the calm vibes we all need. VideoThis Celtic rainforest has the calm vibes we all needAttributionBBC TwoplayPlant powerPlant power, Should you swap that beef burger for a vegan version?Should you swap that beef burger for a vegan version?Watch what might happen if the entire world switched to a plant-based dietAttributionBBC IdeasEntertainment news'This is one of my films of the year'AttributionBBC Radio 5 LiveBill surprises fans with nimble feet (and an elephant)AttributionBBC OneSean Connery's greatest moments on screen - in picturesAttributionEntertainment & ArtsSocietyCouple trolled for intimate wedding photoshootAttributionIndia'I raise £2,000 a month to keep my daughter alive'AttributionEngland'Collaborative effort' needed to help gay players come outAttributionEnglandOur Planet NownextThe BBC’s ongoing focus on the environment and the challenges facing our planetYou've got cheap data, how about cheap power too?Publishedduration2 days agoAttributionScience & EnvironmentThe Repair Shop's Jay Blades: 'Make do and mend' for the planet. Video, 00:03:15The Repair Shop's Jay Blades: 'Make do and mend' for the planetPublishedduration2 days agoplay3:15'You could see avocados growing in Hackney' Video, 00:01:04'You could see avocados growing in Hackney'Publishedduration3 days agoAttributionLondonplay1:04Real-life storiesSteph McGovern on 'toning it down' for TV, Trump and pregnancy. AudioSteph McGovern on 'toning it down' for TV, Trump and pregnancyAttributionBBC Radio 4listen'Nobody would help me until Keanu Reeves turned up!' Video'Nobody would help me until Keanu Reeves turned up!'AttributionBBC OneplayDoctor duped into buying 'Aladdin's lamp' for $41,600AttributionIndiaYou might have missedA magical underwater moment captured on film. VideoA magical underwater moment captured on filmAttributionBBC TwoplayHouse prices climb to record high, says NationwideAttributionBusinessCornwall Poldark house fallen into 'complete disrepair'AttributionEnglandFoodnextPerfect pot-roasts with minimum effortAttributionBBC FoodA super-speedy version of a takeaway classicAttributionBBC FoodHealthy winter warmers to keep you full for longerAttributionBBC FoodLifestyleThree tips to help you through redundancy. VideoThree tips to help you through redundancyAttributionBBC IdeasplayGet your ramble on with Countryfile's top hiking tipsAttributionBBC Children in NeedAwesome autumn activities for younger kidsAttributionTiny Happy PeopleThis week in sportWilder questions Fury gloves in rematchAttributionBoxingTributes after ex-Hearts captain Zaliukas dies aged 36AttributionFootballVerstappen sorry for offensive language during\nPortuguese GPAttributionFormula 1Behind the headlinesCharlie Hebdo attack suspect tests positive for Covid-19AttributionEuropeBerlin's new €6bn airport opens... 10 years late. VideoBerlin's new €6bn airport opens... 10 years lateAttributionWorldplayNew York man plunges into rat-infested sinkholeAttributionUS & CanadaTime well spentSam Smith's track-by-track guide to their new album. AudioSam Smith's track-by-track guide to their new albumAttributionBBC Radio 1listenRap Game star shares his Black History Month picksAttributionBBC ThreeThese eerie stories might just keep you awake at nightAttributionBBC Radio 4Modern Slavery StatementRead moreThe BBC around the UKScotlandALBAWalesCymruNIOther servicesComplaintsUS Election 2020A really simple guide to the electionAttributionBBC NewsDisinformation: How to spot it. iPlayerDisinformation: How to spot itAttributionBBC iPlayeriplayerWho do you think will win?AttributionBBC NewsOdd happenings from past US electionsAttributionBBC BitesizeHomeNewsSportReelWorklifeTravelFutureCultureMusicTVWeatherSoundsTerms of UseAbout the BBCPrivacy PolicyCookiesAccessibility HelpParental GuidanceContact the BBCGet Personalised NewslettersWhy you can trust the BBCAdvertise with usAdChoices / Do Not Sell My Info© 2020 BBC. The BBC is not responsible for the content of external sites. Read about our approach to external linking." - description: Text content of the webpage. - dataList: - type: array - example: [{"imagelinks": ["https://ichef.bbci.co.uk/images/ic/240x135/p08x3gpx.jpg","https://ichef.bbci.co.uk/curationkit-ichef/240x135/cpsprodpb/16FC3/production/_115174149_063942058.jpg","https://ichef.bbci.co.uk/images/ic/240x135/p08x2qxp.jpg","https://ichef.bbci.co.uk/images/ic/240x135/p08x39pc.jpg","https://ichef.bbci.co.uk/images/ic/240x135/p08wsqty.jpg","https://ichef.bbci.co.uk/images/ic/240x135/p08vchc7.jpg"]}] - description: Extracted results of queryList in a list format. - unauthorized: - type: object - properties: - message: - type: string - example: Missing Authentication Token - status: - type: string - example: Failure - restricted: - type: object - properties: - message: - type: string - example: The content is restricted - status: - type: string - example: Failure - forbidden: - type: object - properties: - message: - type: string - example: Access Denied Unauthorized User - status: - type: string - example: Failure - paymentrequired: - type: object - properties: - message: - type: string - example: Insufficient Credits Kindly Top Up - status: - type: string - example: Failure - notfound: - type: object - properties: - message: - type: string - example: Invalid Request - status: - type: string - example: Failure - invalidinput: - type: object - properties: - message: - type: string - example: Invalid Input - status: - type: string - example: Failure - servererror: - type: object - properties: - message: - type: string - example: Internal Server Error - status: - type: string - example: Failure - gatewaytimeout: - type: object - properties: - message: - type: string - example: Request Timeout - status: - type: string - example: Failure - inputfieldmissing: - type: object - properties: - message: - type: string - example: Input Field Missing - status: - type: string - example: Failure - inputlimitexceeded: - type: object - properties: - message: - type: string - example: Input Limit Exceeded - status: - type: string - example: Failure - versions: - type: object - properties: - v1.1.1: - type: array - items: - oneOf: - - type: string - example: Published Date - Dec 04, 2020 - description: Patch Update - v1.1.0: - type: array - items: - oneOf: - - type: string - example: Published Date - Oct 30, 2020 - description: Partial URL support - v1.0.0: - type: array - items: - oneOf: - - type: string - example: Published Date - Jul 03, 2020 - description: Improvised search filters using queryList, now you can even navigate down the html tree like get all p tag inside a div class "class":"class_name p" - v0.1.0: - type: array - items: - oneOf: - - type: string - example: Published Date - Jul 18, 2018 - description: Initial version release - input: - type: object - properties: - url: - type: string - default: true - example: https://www.bbc.co.uk - description: Webpage URL. It also support partial URL like bbc.co.uk - queryList: - type: array - default: false - example: [{"title":,"findType":"find_all","tag":"h1", "returnType":"html"}] - description: List of extraction conditions. - items: - oneOf: - - type: object - properties: - findType: - x-name: findType - type: string - default: false - example: |+ - find_all - description: |+ - Extraction Type. Possible values are: - 1. find - returns the first matching possibility - 2. find_all - returns the all matching possibility - 3. select - If you want to search for tags that match two or more CSS classes. either nestedClassId is mandatory - tag: - x-name: tag - type: string - default: false - example: h1 - description: |+ - The HTML tag to extract - id: - x-name: id - type: string - default: false - example: sampleid - description: |+ - The HTML element id to extract - class: - x-name: class - type: string - default: false - example: sampleclass - description: |+ - The HTML element classname to extract - nestedClassId: - x-name: nestedclassid - type: string - default: false - example: p.strikeout - description: |+ - The nested HTML tags. Example: p.strikeout - looks for those matching "strikeout" classname inside the "p" element. - Add additional nesting elments using .(dot) to concatenate - attribute: - x-name: attribute - type: string - default: false - example: src - description: |+ - The HTML element attribute to extract, supported only with tag/id/class/nestedClassId - title: - x-name: title - type: string - default: false - example: mytitle - description: |+ - The key value of the extracted result. By default, the return json key is "values". - returnType: - x-name: returnType - type: string - default: false - example: html - description: |+ - Optional input parameter. If no input parameter is specified, the default return type would be text. - Use “html” to set return type to HTML format - - securitySchemes: - APIAuthorizer: - type: apiKey - name: x-api-key - in: header - x-amazon-apigateway-authtype: custom - description: Authentication is done using the x-api-key in the request header diff --git a/yaml/wikipedia_retrieval.yaml b/yaml/wikipedia_retrieval.yaml deleted file mode 100644 index 4e8891646..000000000 --- a/yaml/wikipedia_retrieval.yaml +++ /dev/null @@ -1,314 +0,0 @@ -openapi: 3.0.1 -info: - title: Wikipedia Retrieval - description: |+ - It is an API that provides the user with a Wikipedia article based on the input keyword. Refer to this link for the full list of Wikipedias - https://meta.wikimedia.org/wiki/List_of_Wikipedias - x-additionalinfo: |+ - Suggested Use Cases: - - Access topics within Wikipedia with great specificity. Can be used for research/study-related solutions by using information from this microservice to compare articles, revisions and more. - - - Extract the most relevant content from Wikipedia’s categories to provide a text analysis service to ascertain what any text is in reference to. - version: '0.1.0' - x-subscribelink: wikipedia_retrieval -servers: - - url: 'https://apis.sentient.io' -tags: -- name: "v0.1.0" - description: "Published Date - Apr 23, 2020" -paths: - /microservices/utility/wikipedia/v0.1/getresults: - post: - tags: - - v0.1.0 - responses: - '200': - description: success response - content: - application/json: - schema: - $ref: '#/components/schemas/success' - example: - results: - content: Singapore officially the Republic of Singapore, is a sovereign city-state - and island country located in maritime Southeast Asia. Singapore lies about one - degree of latitude (137 kilometres or 85 miles) north of the equator. - images: - - https://upload.wikimedia.org/wikipedia/commons/f/f5/0008871_-_Krung_Thep_Bridge_001.jpg - - https://upload.wikimedia.org/wikipedia/commons/1/12/2014_Singapore_Products_Export_Treemap.png - - https://upload.wikimedia.org/wikipedia/commons/1/1b/2017_G20_Hamburg_summit_leaders_group_photo.jpg - - https://upload.wikimedia.org/wikipedia/commons/1/10/A_Night_Perspective_on_the_Singapore_Merlion_%288347645113%29.jpg - links: - - 65 - - ".sg" - - 126 Squadron, Republic of Singapore Air Force - - 13th Parliament of Singapore - - 16th Summit of the Non-Aligned Movement - - 1915 Singapore Mutiny - pageid: 27318 - summary: Singapore officially the Republic of Singapore, is a sovereign city-state - and island country located in maritime Southeast Asia. Singapore lies about one - degree of latitude (137 kilometres or 85 miles) north of the equator. - url: https://en.wikipedia.org/wiki/Singapore - message: Successfully Processed - status: Success - '401': - description: Unauthorized - content: - application/json: - schema: - $ref: '#/components/schemas/unauthorized' - '402': - description: Payment Required - content: - application/json: - schema: - $ref: '#/components/schemas/paymentrequired' - '403': - description: Forbidden - content: - application/json: - schema: - $ref: '#/components/schemas/forbidden' - '404': - description: Not Found - content: - application/json: - schema: - $ref: '#/components/schemas/notfound' - '419': - description: Input Field Missing - content: - application/json: - schema: - $ref: '#/components/schemas/inputfieldmissing' - '413': - description: Input Limit Exceeded - content: - application/json: - schema: - $ref: '#/components/schemas/inputlimitexceeded' - '415': - description: Invalid Input - content: - application/json: - schema: - $ref: '#/components/schemas/invalidinput' - '500': - description: Internal Server Error - content: - application/json: - schema: - $ref: '#/components/schemas/servererror' - '504': - description: Gateway Timeout - content: - application/json: - schema: - $ref: '#/components/schemas/gatewaytimeout' - security: - - APIAuthorizer: [] - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/input' - required: true -components: - schemas: - success: - type: object - properties: - results: - type: object - example: { "" } - description: Json Object of returned results - properties: - content: - type: string - example: "Singapore officially the Republic of Singapore, is a sovereign city-state and island country located in maritime Southeast Asia. - Singapore lies about one degree of latitude (137 kilometres or 85 miles) north of the equator." - description: Plain text content of the page, excluding images, tables, and other data. - images: - type: array - example: ["https://upload.wikimedia.org/wikipedia/commons/f/f5/0008871_-_Krung_Thep_Bridge_001.jpg","https://upload.wikimedia.org/wikipedia/commons/1/12/2014_Singapore_Products_Export_Treemap.png"] - description: List of URLs of images on the page. - items: - oneOf: - - type: string - format: list - example: https://upload.wikimedia.org/wikipedia/commons/f/f5/0008871_-_Krung_Thep_Bridge_001.jpg - - type: string - format: list - example: https://upload.wikimedia.org/wikipedia/commons/1/12/2014_Singapore_Products_Export_Treemap.png - - type: string - format: list - example: https://upload.wikimedia.org/wikipedia/commons/1/1b/2017_G20_Hamburg_summit_leaders_group_photo.jpg - - type: string - format: list - example: https://upload.wikimedia.org/wikipedia/commons/1/10/A_Night_Perspective_on_the_Singapore_Merlion_%288347645113%29.jpg - links: - type: array - example: [".sg","126 Squadron, Republic of Singapore Air Force","13th Parliament of Singapore","16th Summit of the Non-Aligned Movement"] - description: List of titles of Wikipedia page links on a page. - items: - oneOf: - - type: string - format: list - example: +65 - - type: string - format: list - example: .sg - - type: string - format: list - example: 126 Squadron, Republic of Singapore Air Force - - type: string - format: list - example: 13th Parliament of Singapore - - type: string - format: list - example: 16th Summit of the Non-Aligned Movement - - type: string - format: list - example: 1915 Singapore Mutiny - pageid: - type: integer - example: 27318 - description: The id of the page requested - summary: - type: string - example: Singapore officially the Republic of Singapore, is a sovereign city-state and island country located in maritime Southeast Asia. - Singapore lies about one degree of latitude (137 kilometres or 85 miles) north of the equator. - description: A short summary of the Wikipedia article that was requested - url: - type: string - example: https://en.wikipedia.org/wiki/Singapore - description: The website url of the requested wikipedia articles - message: - type: string - example: Successfully Processed - description: Detail description on the API status - status: - type: string - example: Success - description: The status of the API call success/failure - unauthorized: - type: object - properties: - message: - type: string - example: Missing Authentication Token - status: - type: string - example: Failure - forbidden: - type: object - properties: - message: - type: string - example: Access Denied Unauthorized User - status: - type: string - example: Failure - paymentrequired: - type: object - properties: - message: - type: string - example: Insufficient Credits Kindly Top Up - status: - type: string - example: Failure - invalidinput: - type: object - properties: - message: - type: string - example: Invalid Input - status: - type: string - example: Failure - notfound: - type: object - properties: - message: - type: string - example: Invalid Request URL - status: - type: string - example: Failure - servererror: - type: object - properties: - message: - type: string - example: Internal Server Error - status: - type: string - example: Failure - gatewaytimeout: - type: object - properties: - message: - type: string - example: Request Timeout - status: - type: string - example: Failure - inputfieldmissing: - type: object - properties: - message: - type: string - example: Input Field Missing - status: - type: string - example: Failure - inputlimitexceeded: - type: object - properties: - message: - type: string - example: Input Limit Exceeded - status: - type: string - example: Failure - versions: - type: object - properties: - v0.1.0: - type: array - items: - oneOf: - - type: string - example: Published Date - Apr 23, 2020 - description: Initial version release - input: - type: object - properties: - title: - type: string - example: Singapore - default: true - description: The search term, highest match to the title of the Wikipedia page. - pageid: - type: integer - default: true - example: 27318 - description: The Wikipedia id of the page requested. - language: - type: string - default: false - example: en - description: Indicates the language in which the Wikipedia page is written. Default is English, for other languages give the input as ISO 639-1 language code. Please refer this link for language code https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes. - filter_key: - type: string - default: false - example: all - description: Indicates the filter criteria of the output result fields. The default return set includes pageid, url, and summary.“all” - returns all the fields. You can also filter by individual fields using the list value. Possible values are pageid, url, summary, content, links, and images - securitySchemes: - APIAuthorizer: - type: apiKey - name: x-api-key - in: header - x-amazon-apigateway-authtype: custom - description: Authentication is done using the x-api-key in the request header diff --git a/yaml/wikipedia_retrieval_v1.0.yaml b/yaml/wikipedia_retrieval_v1.0.yaml deleted file mode 100644 index b423cc9b8..000000000 --- a/yaml/wikipedia_retrieval_v1.0.yaml +++ /dev/null @@ -1,342 +0,0 @@ -openapi: 3.0.1 -info: - title: Wikipedia Retrieval - description: |+ - It is an API that provides the user with a Wikipedia article based on the input keyword. Refer to this link for the full list of Wikipedias - https://meta.wikimedia.org/wiki/List_of_Wikipedias - x-additionalinfo: |+ - Suggested Use Cases: - - Access topics within Wikipedia with great specificity. Can be used for research/study-related solutions by using information from this microservice to compare articles, revisions and more. - - - Extract the most relevant content from Wikipedia’s categories to provide a text analysis service to ascertain what any text is in reference to. - version: '1.0.0' - x-subscribelink: wikipedia_retrieval -servers: - - url: 'https://apis.sentient.io' -tags: -- name: "v1.0.0" - description: "Published Date - Jan 11, 2021" -paths: - /microservices/utility/wikipedia/v1/getresults: - post: - tags: - - v1.0.0 - responses: - '200': - description: success response - content: - application/json: - schema: - $ref: '#/components/schemas/success' - example: - results: - content: Singapore officially the Republic of Singapore, is a sovereign city-state - and island country located in maritime Southeast Asia. Singapore lies about one - degree of latitude (137 kilometres or 85 miles) north of the equator. - images: - - https://upload.wikimedia.org/wikipedia/commons/f/f5/0008871_-_Krung_Thep_Bridge_001.jpg - - https://upload.wikimedia.org/wikipedia/commons/1/12/2014_Singapore_Products_Export_Treemap.png - - https://upload.wikimedia.org/wikipedia/commons/1/1b/2017_G20_Hamburg_summit_leaders_group_photo.jpg - - https://upload.wikimedia.org/wikipedia/commons/1/10/A_Night_Perspective_on_the_Singapore_Merlion_%288347645113%29.jpg - links: - - 65 - - ".sg" - - 126 Squadron, Republic of Singapore Air Force - - 13th Parliament of Singapore - - 16th Summit of the Non-Aligned Movement - - 1915 Singapore Mutiny - pageid: 27318 - summary: Singapore officially the Republic of Singapore, is a sovereign city-state - and island country located in maritime Southeast Asia. Singapore lies about one - degree of latitude (137 kilometres or 85 miles) north of the equator. - thumbnail: - height: 333 - source: https://upload.wikimedia.org/wikipedia/commons/thumb/4/48/Flag_of_Singapore.svg/500px-Flag_of_Singapore.svg.png - width: 500 - url: https://en.wikipedia.org/wiki/Singapore - message: Successfully Processed - status: Success - '401': - description: Unauthorized - content: - application/json: - schema: - $ref: '#/components/schemas/unauthorized' - '402': - description: Payment Required - content: - application/json: - schema: - $ref: '#/components/schemas/paymentrequired' - '403': - description: Forbidden - content: - application/json: - schema: - $ref: '#/components/schemas/forbidden' - '404': - description: Not Found - content: - application/json: - schema: - $ref: '#/components/schemas/notfound' - '419': - description: Input Field Missing - content: - application/json: - schema: - $ref: '#/components/schemas/inputfieldmissing' - '413': - description: Input Limit Exceeded - content: - application/json: - schema: - $ref: '#/components/schemas/inputlimitexceeded' - '415': - description: Invalid Input - content: - application/json: - schema: - $ref: '#/components/schemas/invalidinput' - '500': - description: Internal Server Error - content: - application/json: - schema: - $ref: '#/components/schemas/servererror' - '504': - description: Gateway Timeout - content: - application/json: - schema: - $ref: '#/components/schemas/gatewaytimeout' - security: - - APIAuthorizer: [] - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/input' - required: true -components: - schemas: - success: - type: object - properties: - results: - type: object - example: { "" } - description: Json Object of returned results - properties: - content: - type: string - example: "Singapore officially the Republic of Singapore, is a sovereign city-state and island country located in maritime Southeast Asia. - Singapore lies about one degree of latitude (137 kilometres or 85 miles) north of the equator." - description: Plain text content of the page, excluding images, tables, and other data. - images: - type: array - example: ["https://upload.wikimedia.org/wikipedia/commons/f/f5/0008871_-_Krung_Thep_Bridge_001.jpg","https://upload.wikimedia.org/wikipedia/commons/1/12/2014_Singapore_Products_Export_Treemap.png"] - description: List of URLs of images on the page. - items: - oneOf: - - type: string - format: list - example: https://upload.wikimedia.org/wikipedia/commons/f/f5/0008871_-_Krung_Thep_Bridge_001.jpg - - type: string - format: list - example: https://upload.wikimedia.org/wikipedia/commons/1/12/2014_Singapore_Products_Export_Treemap.png - - type: string - format: list - example: https://upload.wikimedia.org/wikipedia/commons/1/1b/2017_G20_Hamburg_summit_leaders_group_photo.jpg - - type: string - format: list - example: https://upload.wikimedia.org/wikipedia/commons/1/10/A_Night_Perspective_on_the_Singapore_Merlion_%288347645113%29.jpg - links: - type: array - example: [".sg","126 Squadron, Republic of Singapore Air Force","13th Parliament of Singapore","16th Summit of the Non-Aligned Movement"] - description: List of titles of Wikipedia page links on a page. - items: - oneOf: - - type: string - format: list - example: +65 - - type: string - format: list - example: .sg - - type: string - format: list - example: 126 Squadron, Republic of Singapore Air Force - - type: string - format: list - example: 13th Parliament of Singapore - - type: string - format: list - example: 16th Summit of the Non-Aligned Movement - - type: string - format: list - example: 1915 Singapore Mutiny - pageid: - type: integer - example: 27318 - description: The id of the page requested - summary: - type: string - example: Singapore officially the Republic of Singapore, is a sovereign city-state and island country located in maritime Southeast Asia. - Singapore lies about one degree of latitude (137 kilometres or 85 miles) north of the equator. - description: A short summary of the Wikipedia article that was requested - thumbnail: - type: object - example: {"height":333,"source":"https://upload.wikimedia.org/wikipedia/commons/thumb/4/48/Flag_of_Singapore.svg/500px-Flag_of_Singapore.svg.png", "width":500} - description: URL and dimensions of thumbnail image associated with page, if any. - properties: - height: - type: string - example: 333 - description: Height of the thumbnail image - source: - type: string - example: https://upload.wikimedia.org/wikipedia/commons/thumb/4/48/Flag_of_Singapore.svg/500px-Flag_of_Singapore.svg.png - description: Source URL of the thumbnail image - width: - type: string - example: 500 - description: Width of the thumbnail image - url: - type: string - example: https://en.wikipedia.org/wiki/Singapore - description: The website url of the requested wikipedia articles - message: - type: string - example: Successfully Processed - description: Detail description on the API status - status: - type: string - example: Success - description: The status of the API call success/failure - unauthorized: - type: object - properties: - message: - type: string - example: Missing Authentication Token - status: - type: string - example: Failure - forbidden: - type: object - properties: - message: - type: string - example: Access Denied Unauthorized User - status: - type: string - example: Failure - paymentrequired: - type: object - properties: - message: - type: string - example: Insufficient Credits Kindly Top Up - status: - type: string - example: Failure - invalidinput: - type: object - properties: - message: - type: string - example: Invalid Input - status: - type: string - example: Failure - notfound: - type: object - properties: - message: - type: string - example: Invalid Request URL - status: - type: string - example: Failure - servererror: - type: object - properties: - message: - type: string - example: Internal Server Error - status: - type: string - example: Failure - gatewaytimeout: - type: object - properties: - message: - type: string - example: Request Timeout - status: - type: string - example: Failure - inputfieldmissing: - type: object - properties: - message: - type: string - example: Input Field Missing - status: - type: string - example: Failure - inputlimitexceeded: - type: object - properties: - message: - type: string - example: Input Limit Exceeded - status: - type: string - example: Failure - versions: - type: object - properties: - v1.0.0: - type: array - items: - oneOf: - - type: string - example: Published Date - Jan 11, 2021 - description: Patch Update, Optimization and thumbnail is added as an additional field - v0.1.0: - type: array - items: - oneOf: - - type: string - example: Published Date - Apr 23, 2020 - description: Initial version release - input: - type: object - properties: - keyword: - type: string - example: Singapore - default: true - description: The search term, highest match to the title of the Wikipedia page. Not Mandatory when pageid is given. - pageid: - type: integer - default: false - example: 27318 - description: The Wikipedia id of the page requested. Mandatory only when title is not given. - language: - type: string - default: false - example: en - description: Indicates the language in which the Wikipedia page is written. Default is English, for other languages give the input as ISO 639-1 language code. Please refer this link for language code https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes - additional_fields: - type: string - default: false - example: all - description: The default returns the pageid, url, summary and thumbnail, when given “all” - returns all the fields i.e pageid, url, summary, content, links, images and thumbnail. - securitySchemes: - APIAuthorizer: - type: apiKey - name: x-api-key - in: header - x-amazon-apigateway-authtype: custom - description: Authentication is done using the x-api-key in the request header diff --git a/yaml/word_sense_disambiguation_eng.yaml b/yaml/word_sense_disambiguation_eng.yaml deleted file mode 100644 index 426f47c0a..000000000 --- a/yaml/word_sense_disambiguation_eng.yaml +++ /dev/null @@ -1,304 +0,0 @@ -openapi: 3.0.1 -info: - title: Word Sense Disambiguation ENG - description: |+ - This NLP microservice takes in a text and a target word and identifies the target word's hypernym. Hypernym refers to the specific meaning of the word within the context of the sentence. For example, colour is a hypernym of red. - - If the word is determined to be a noun within the sentence context, the microservice returns the potential hypernym, definition, and score. Otherwise, no result will be returned for that context. - x-additionalinfo: |+ - Suggested Use Cases: - - Information Retrieval - this microservice can be used to build a system that assists users in finding the information they required but it does not explicitly return the answers of the questions. - - - Text Mining and Information Extraction - this microservice can be used to do accurate analysis of text. For example it can help to create an intelligent gathering system to do flagging of the correct words e.g. medical intelligent system might need flagging of “red balloon” rather than “led balloon”. - version: '0.1.0' - x-subscribelink: word_sense_disambiguation_eng -servers: - - url: 'https://apis.sentient.io' -tags: -- name: "v0.1.0" - description: "Published Date - Mar 06, 2020" -paths: - /microservices/nlp/wordsensedisambiguation/v0.1/getpredictions: - post: - tags: - - v0.1.0 - responses: - '200': - description: success response - content: - application/json: - schema: - $ref: '#/components/schemas/success' - example: - sentence_index: - '4': 'But our genius for creative storytelling , combined with our inability to - detect our own ignorance , can sometimes lead to situations that are embarrassing - , unfortunate , or downright dangerous – especially in a technologically advanced - , complex democratic societythat occasionally invests mistaken popular beliefs - with immense destructive power ( See : crisis , financial ; war , Iraq ) .' - tokens: - '4': - society: - - token_index: 40 - synset_name: society.n.01 - synset_definition: an extended social group having a distinctive cultural and - economic organization - synset_score: 0.9870249032974243 - hypernyms: - - hypernym_name: social_group.n.01 - hypernym_definition: people sharing some social relation - potential_candidate_score: 1 - '401': - description: Unauthorized - content: - application/json: - schema: - $ref: '#/components/schemas/unauthorized' - '402': - description: Payment Required - content: - application/json: - schema: - $ref: '#/components/schemas/paymentrequired' - '403': - description: Forbidden - content: - application/json: - schema: - $ref: '#/components/schemas/forbidden' - '404': - description: Not Found - content: - application/json: - schema: - $ref: '#/components/schemas/notfound' - '419': - description: Input Field Missing - content: - application/json: - schema: - $ref: '#/components/schemas/inputfieldmissing' - '413': - description: Input Limit Exceeded - content: - application/json: - schema: - $ref: '#/components/schemas/inputlimitexceeded' - '415': - description: Invalid Input - content: - application/json: - schema: - $ref: '#/components/schemas/invalidinput' - '500': - description: Internal Server Error - content: - application/json: - schema: - $ref: '#/components/schemas/servererror' - '504': - description: Gateway Timeout - content: - application/json: - schema: - $ref: '#/components/schemas/gatewaytimeout' - security: - - APIAuthorizer: [] - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/input' - required: true -components: - schemas: - success: - type: object - properties: - sentence_index: - type: object - example: {"4": "But our genius for creative storytelling , combined with our inability to detect our own ignorance , can sometimes lead to situations that are embarrassing , unfortunate , or downright dangerous \u2013 especially in a technologically advanced , complex democratic society that occasionally invests mistaken popular beliefs with immense destructive power ( See : crisis , financial ; war , Iraq ) .","7": "The society of extraordinary gentlemen has a natural way of overcoming difficulties in tough times to come out stronger , saving society from itself ."} - description: Is a mapping from an index of the sentence in the presented text (say, 0, 1, 2...) to the text of the sentence itself. - properties: - 4: - type: string - example: { 4:But our genius for creative storytelling , combined with our inability to detect our own ignorance , can sometimes lead to situations that are embarrassing , unfortunate , or downright dangerous \u2013 especially in a technologically advanced , complex democratic society that occasionally invests mistaken popular beliefs with immense destructive power} - description: mapping value - tokens: - type: object - example: {"4": {"society": [{"hypernyms": [{"hypernym_definition": "people sharing some social relation","hypernym_name": "social_group.n.01","potential_candidate_score": 1.0}],"synset_definition": "an extended social group having a distinctive cultural and economic organization","synset_name": "society.n.01","synset_score": 0.9870249032974243,"token_index": 40}]}} - description: Is a mapping from the sentence_index to the target word's potential synsets and hypernms. - properties: - 4: - type: object - example: {"society": [{"hypernyms": [{"hypernym_definition": "people sharing some social relation","hypernym_name": "social_group.n.01","potential_candidate_score": 1.0}],"synset_definition": "an extended social group having a distinctive cultural and economic organization","synset_name": "society.n.01","synset_score": 0.9870249032974243,"token_index": 40}]} - description: Mapping value - properties: - : - type: array - example: [{"hypernyms": [{"hypernym_definition": "people sharing some social relation","hypernym_name": "social_group.n.01","potential_candidate_score": 1.0}],"synset_definition": "an extended social group having a distinctive cultural and economic organization","synset_name": "society.n.01","synset_score": 0.9870249032974243,"token_index": 40}] - description: Details about the target word given as input - items: - properties: - hypernyms: - type: array - example: [{"hypernym_definition": "people sharing some social relation","hypernym_name": "social_group.n.01","potential_candidate_score": 1.0}] - description: A hypernym can be thought of as a parent class. For example, "colour" is a hypernym of "red". - items: - properties: - hypernym_definition: - type: string - example: people sharing some social relation - description: Definition of the hypernym - hypernym_name: - type: string - example: social_group.n.01 - description: Describes the category in which the target word belongs to. Eg:car is a transport. car is the target word and transport is the category(hypernym) - potential_candidate_score: - type: integer - example: 1 - description: Is the confidence score from the network - synset_definition: - type: string - example: An extended social group having a distinctive cultural and economic organization - description: A synset is a collection of synonyms, identified using the WordNet synset name. It connects a word to the synset it belongs via a definition. A word can belong to more than one synset. Basically definition of the target_word - synset_name: - type: string - example: society.n.01 - description: The target word name in wordnet library - synset_score: - type: number - format : float - example: 0.9870249032974243 - description: Is the confidence score from the network - token_index: - type: number - example: 40 - description: Is the target word position in the sentence - unauthorized: - type: object - properties: - message: - type: string - example: Missing Authentication Token - status: - type: string - example: Failure - forbidden: - type: object - properties: - message: - type: string - example: Access Denied Unauthorized User - status: - type: string - example: Failure - paymentrequired: - type: object - properties: - message: - type: string - example: Insufficient Credits Kindly Top Up - status: - type: string - example: Failure - notfound: - type: object - properties: - message: - type: string - example: Invalid Request URL - status: - type: string - example: Failure - invalidinput: - type: object - properties: - message: - type: string - example: Invalid Input - status: - type: string - example: Failure - servererror: - type: object - properties: - message: - type: string - example: Internal Server Error - status: - type: string - example: Failure - gatewaytimeout: - type: object - properties: - message: - type: string - example: Request Timeout - status: - type: string - example: Failure - inputfieldmissing: - type: object - properties: - message: - type: string - example: Input Field Missing - status: - type: string - example: Failure - inputlimitexceeded: - type: object - properties: - message: - type: string - example: Input Limit Exceeded - status: - type: string - example: Failure - input: - type: object - required: - - text - properties: - text: - x-name: text - type: string - default: true - example: An estimated 180,000 people were under mandatory evacuation orders, including parts of Santa Rosa and a large swath of Sonoma County all the way to the Pacific Ocean. - description: |+ - Input text can be a complete sentence or paragraph. - - Supported formats: ASCII only - target_word: - x-name: target_word - type: string - default: true - example: County - description: |+ - A noun token that can be found in text - repeat: - x-name: repeat - type: string - default: true - example: "True" - description: |+ - Indicates whether the target_word that was first identified in the input text is to be used alone or all the target_words identified in the text are to be used. - If False, then it uses the first target_word alone in text and ignores the rest. - versions: - type: object - properties: - v0.1.0: - type: array - items: - oneOf: - - type: string - example: Published Date - Mar 06, 2020 - description: Initial version release - securitySchemes: - APIAuthorizer: - type: apiKey - name: x-api-key - in: header - x-amazon-apigateway-authtype: custom - description: Authentication is done using the x-api-key in the request header diff --git a/yaml/word_sense_disambiguation_eng_v1.0.yaml b/yaml/word_sense_disambiguation_eng_v1.0.yaml deleted file mode 100644 index d712762b6..000000000 --- a/yaml/word_sense_disambiguation_eng_v1.0.yaml +++ /dev/null @@ -1,326 +0,0 @@ -openapi: 3.0.1 -info: - title: Word Sense Disambiguation ENG - description: |+ - This NLP microservice takes in a text and a target word and identifies the target word's hypernym. Hypernym refers to the specific meaning of the word within the context of the sentence. - - If the word is determined to be a noun within the sentence context, the microservice returns the potential hypernym, definition, and score. Otherwise, no result will be returned for that context. - - Do ensure that your text is **within 5000 characters**. - version: '1.0.0' - x-additionalinfo: |+ - Suggested Use Cases: - - Information Retrieval - this microservice can be used to build a system that assists users in finding the information they required but it does not explicitly return the answers of the questions. - - Text Mining and Information Extraction - this microservice can be used to do accurate analysis of text. For example it can help to create an intelligent gathering system to do flagging of the correct words e.g. medical intelligent system might need flagging of “red balloon” rather than “led balloon”. - x-subscribelink: word_sense_disambiguation_eng -servers: - - url: 'https://apis.sentient.io' -tags: -- name: "v1.0.0" - description: "Published Date - Oct 30, 2020" -paths: - /microservices/nlp/wordsensedisambiguation/v1/getpredictions: - post: - tags: - - v1.0.0 - responses: - '200': - description: success response - content: - application/json: - schema: - $ref: '#/components/schemas/success' - example: - results: - sentence_index: - '4': 'But our genius for creative storytelling , combined with our inability to - detect our own ignorance , can sometimes lead to situations that are embarrassing - , unfortunate , or downright dangerous – especially in a technologically advanced - , complex democratic societythat occasionally invests mistaken popular beliefs - with immense destructive power ( See : crisis , financial ; war , Iraq ) .' - tokens: - '4': - society: - - token_index: 40 - synset_name: society.n.01 - synset_definition: an extended social group having a distinctive cultural and - economic organization - synset_score: 0.9870249032974243 - hypernyms: - - hypernym_name: social_group.n.01 - hypernym_definition: people sharing some social relation - potential_candidate_score: 1 - message: Successfully Processed - status: Success - '401': - description: Unauthorized - content: - application/json: - schema: - $ref: '#/components/schemas/unauthorized' - '402': - description: Payment Required - content: - application/json: - schema: - $ref: '#/components/schemas/paymentrequired' - '403': - description: Forbidden - content: - application/json: - schema: - $ref: '#/components/schemas/forbidden' - '404': - description: Not Found - content: - application/json: - schema: - $ref: '#/components/schemas/notfound' - '419': - description: Input Field Missing - content: - application/json: - schema: - $ref: '#/components/schemas/inputfieldmissing' - '413': - description: Input Limit Exceeded - content: - application/json: - schema: - $ref: '#/components/schemas/inputlimitexceeded' - '415': - description: Invalid Input - content: - application/json: - schema: - $ref: '#/components/schemas/invalidinput' - '500': - description: Internal Server Error - content: - application/json: - schema: - $ref: '#/components/schemas/servererror' - '504': - description: Gateway Timeout - content: - application/json: - schema: - $ref: '#/components/schemas/gatewaytimeout' - security: - - APIAuthorizer: [] - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/input' - required: true -components: - schemas: - success: - type: object - properties: - results: - type: object - description: The result of the API call. - example: { "" } - properties: - sentence_index: - type: object - example: {"4": "But our genius for creative storytelling , combined with our inability to detect our own ignorance , can sometimes lead to situations that are embarrassing , unfortunate , or downright dangerous \u2013 especially in a technologically advanced , complex democratic society that occasionally invests mistaken popular beliefs with immense destructive power ( See : crisis , financial ; war , Iraq ) .","7": "The society of extraordinary gentlemen has a natural way of overcoming difficulties in tough times to come out stronger , saving society from itself ."} - description: Is a mapping from an index of the sentence in the presented text (say, 0, 1, 2...) to the text of the sentence itself. - properties: - 4: - type: string - example: { 4:But our genius for creative storytelling , combined with our inability to detect our own ignorance , can sometimes lead to situations that are embarrassing , unfortunate , or downright dangerous \u2013 especially in a technologically advanced , complex democratic society that occasionally invests mistaken popular beliefs with immense destructive power} - description: mapping value - tokens: - type: object - example: {"4": {"society": [{"hypernyms": [{"hypernym_definition": "people sharing some social relation","hypernym_name": "social_group.n.01","potential_candidate_score": 1.0}],"synset_definition": "an extended social group having a distinctive cultural and economic organization","synset_name": "society.n.01","synset_score": 0.9870249032974243,"token_index": 40}]}} - description: Is a mapping from the sentence_index to the target word's potential synsets and hypernms. - properties: - 4: - type: object - example: {"society": [{"hypernyms": [{"hypernym_definition": "people sharing some social relation","hypernym_name": "social_group.n.01","potential_candidate_score": 1.0}],"synset_definition": "an extended social group having a distinctive cultural and economic organization","synset_name": "society.n.01","synset_score": 0.9870249032974243,"token_index": 40}]} - description: Mapping value - properties: - : - type: array - example: [{"hypernyms": [{"hypernym_definition": "people sharing some social relation","hypernym_name": "social_group.n.01","potential_candidate_score": 1.0}],"synset_definition": "an extended social group having a distinctive cultural and economic organization","synset_name": "society.n.01","synset_score": 0.9870249032974243,"token_index": 40}] - description: Details about the target word given as input - items: - properties: - hypernyms: - type: array - example: [{"hypernym_definition": "people sharing some social relation","hypernym_name": "social_group.n.01","potential_candidate_score": 1.0}] - description: A hypernym can be thought of as a parent class. For example, "colour" is a hypernym of "red". - items: - properties: - hypernym_definition: - type: string - example: people sharing some social relation - description: Definition of the hypernym - hypernym_name: - type: string - example: social_group.n.01 - description: Describes the category in which the target word belongs to. Eg:car is a transport. car is the target word and transport is the category(hypernym) - potential_candidate_score: - type: integer - example: 1 - description: Is the confidence score from the network - synset_definition: - type: string - example: An extended social group having a distinctive cultural and economic organization - description: A synset is a collection of synonyms, identified using the WordNet synset name. It connects a word to the synset it belongs via a definition. A word can belong to more than one synset. Basically definition of the target_word - synset_name: - type: string - example: society.n.01 - description: The target word name in wordnet library - synset_score: - type: number - format : float - example: 0.9870249032974243 - description: Is the confidence score from the network - token_index: - type: number - example: 40 - description: Is the target word position in the sentence - message: - type: string - example: Successfully Processed - description: Detail description on the API status - status: - type: string - example: Success - description: The status of the API call success/failure - unauthorized: - type: object - properties: - message: - type: string - example: Missing Authentication Token - status: - type: string - example: Failure - forbidden: - type: object - properties: - message: - type: string - example: Access Denied Unauthorized User - status: - type: string - example: Failure - invalidinput: - type: object - properties: - message: - type: string - example: Invalid Input - status: - type: string - example: Failure - paymentrequired: - type: object - properties: - message: - type: string - example: Insufficient Credits Kindly Top Up - status: - type: string - example: Failure - notfound: - type: object - properties: - message: - type: string - example: Invalid Request URL - status: - type: string - example: Failure - servererror: - type: object - properties: - message: - type: string - example: Internal Server Error - status: - type: string - example: Failure - gatewaytimeout: - type: object - properties: - message: - type: string - example: Request Timeout - status: - type: string - example: Failure - inputfieldmissing: - type: object - properties: - message: - type: string - example: Input Field Missing - status: - type: string - example: Failure - inputlimitexceeded: - type: object - properties: - message: - type: string - example: Input Limit Exceeded - status: - type: string - example: Failure - input: - type: object - required: - - text - properties: - text: - x-name: text - type: string - default: true - example: An estimated 180,000 people were under mandatory evacuation orders, including parts of Santa Rosa and a large swath of Sonoma County all the way to the Pacific Ocean. - description: |+ - Input text. A complete sentence or paragraph - target_word: - x-name: target_word - type: string - default: true - example: County - description: |+ - A noun token that can be found in text - repeat: - x-name: repeat - type: string - default: true - example: "True" - description: |+ - Indicates whether the target_word that was first identified in the input text is to be used alone or all the target_words identified in the text are to be used. - If False, then it uses the first target_word alone in text and ignores the rest. - versions: - type: object - properties: - v1.0.0: - type: array - items: - oneOf: - - type: string - example: Published Date - Oct 30,2020 - description: Standardizing Output JSON - v0.1.0: - type: array - items: - oneOf: - - type: string - example: Published Date - Mar 06, 2020 - description: Initial version release - securitySchemes: - APIAuthorizer: - type: apiKey - name: x-api-key - in: header - x-amazon-apigateway-authtype: custom - description: Authentication is done using the x-api-key in the request header diff --git a/yaml/youtube_video_downloader.yaml b/yaml/youtube_video_downloader.yaml deleted file mode 100644 index 2975beb08..000000000 --- a/yaml/youtube_video_downloader.yaml +++ /dev/null @@ -1,223 +0,0 @@ -openapi: 3.0.1 -info: - title: Youtube Video Downloader - description: |+ - This Utility microservice retrieves the Youtube video of the input URL and outputs a download link. - x-additionalinfo: |+ - Suggested Use Cases: - - Can be integrated into apps used to download and watch videos when the user wants to save limited data. - version: '0.1.0' - x-subscribelink: youtube_video_downloader -servers: - - url: 'https://apis.sentient.io' -tags: -- name: "v0.1.0" - description: "Published Date - Nov 25, 2019" -paths: - /microservices/utility/downloadyoutubevideos/v0.1/getresults: - post: - tags: - - v0.1.0 - responses: - '200': - description: success response - content: - application/json: - schema: - $ref: '#/components/schemas/success' - example: - results: - url: https://storage.googleapis.com/youtubedownload/video.mp4?X-Goog-Algorithm=GOOG4-RSA-SHA256&X-Goog-Credential=cloudstorage%40sentient-231509.iam.gserviceaccount.com%2F20200513%2Fauto%2Fstorage%2Fgoog4_request&X-Goog-Date=20200513T115310Z&X-Goog-Expires=6000&X-Goog-SignedHeaders=host&X-Goog-Signature=730f588eb4794828389c6a098002d666b307ab695dbd07f84e5309f79503e857e2d8352e11125a0d569f7e3704da6a0320e426f7fe99ed68d965d3812700c4930060e95da1f7d0694c7751ca493c3f097bcd85a37f33ee8a0a7c7366a8aeba2f5bae7814cc1f0ec5f397ebe70f0bc9bcb82be8843db609ebef01953ae3fdd82d48b39184ac566d570cd3a2b3c1f1a09353f0b2d83643eb1b3140850585a299ada899f6473e76c585128d0b864724f67430f6b2b8798e4399c991d97e2716c5382b6597fca8ee43e72f409848491109ba093399355eeb76b92bf769d2e10e5d2952615e8fbc7798bb7bca8d71ef631339634911346d0175cc45fb691d6c8b9cae - message: Successfully downloaded and stored in Google Cloud Storage. - status: success - '401': - description: Unauthorized - content: - application/json: - schema: - $ref: '#/components/schemas/unauthorized' - '402': - description: Payment Required - content: - application/json: - schema: - $ref: '#/components/schemas/paymentrequired' - '403': - description: Forbidden - content: - application/json: - schema: - $ref: '#/components/schemas/forbidden' - '404': - description: Not Found - content: - application/json: - schema: - $ref: '#/components/schemas/notfound' - '419': - description: Input Field Missing - content: - application/json: - schema: - $ref: '#/components/schemas/inputfieldmissing' - '413': - description: Input Limit Exceeded - content: - application/json: - schema: - $ref: '#/components/schemas/inputlimitexceeded' - '415': - description: Invalid Input - content: - application/json: - schema: - $ref: '#/components/schemas/invalidinput' - '500': - description: Internal Server Error - content: - application/json: - schema: - $ref: '#/components/schemas/servererror' - '504': - description: Gateway Timeout - content: - application/json: - schema: - $ref: '#/components/schemas/gatewaytimeout' - security: - - APIAuthorizer: [] - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/input' - required: true -components: - schemas: - success: - type: object - properties: - results: - type: object - example: { "" } - description: Json Object of returned results - properties: - url: - type: string - description: Pre-signed URL to download the video - example: https://storage.googleapis.com/youtubedownload/video.mp4?X-Goog-Algorithm=GOOG4-RSA-SHA256&X-Goog-Credential=cloudstorage%40sentient-231509.iam.gserviceaccount.com%2F20200513%2Fauto%2Fstorage%2Fgoog4_request&X-Goog-Date=20200513T115310Z&X-Goog-Expires=6000&X-Goog-SignedHeaders=host&X-Goog-Signature=730f588eb4794828389c6a098002d666b307ab695dbd07f84e5309f79503e857e2d8352e11125a0d569f7e3704da6a0320e426f7fe99ed68d965d3812700c4930060e95da1f7d0694c7751ca493c3f097bcd85a37f33ee8a0a7c7366a8aeba2f5bae7814cc1f0ec5f397ebe70f0bc9bcb82be8843db609ebef01953ae3fdd82d48b39184ac566d570cd3a2b3c1f1a09353f0b2d83643eb1b3140850585a299ada899f6473e76c585128d0b864724f67430f6b2b8798e4399c991d97e2716c5382b6597fca8ee43e72f409848491109ba093399355eeb76b92bf769d2e10e5d2952615e8fbc7798bb7bca8d71ef631339634911346d0175cc45fb691d6c8b9cae - message: - type: string - example: Successfully downloaded and stored in Google Cloud Storage. - description: Detail description on the API status - status: - type: string - example: success - description: The status of the API call success/failure - unauthorized: - type: object - properties: - message: - type: string - example: Missing Authentication Token - status: - type: string - example: Failure - forbidden: - type: object - properties: - message: - type: string - example: Access Denied Unauthorized User - status: - type: string - example: Failure - paymentrequired: - type: object - properties: - message: - type: string - example: Insufficient Credits Kindly Top Up - status: - type: string - example: Failure - notfound: - type: object - properties: - message: - type: string - example: Invalid Request URL - status: - type: string - example: Failure - servererror: - type: object - properties: - message: - type: string - example: Internal Server Error - status: - type: string - example: Failure - gatewaytimeout: - type: object - properties: - message: - type: string - example: Request Timeout - status: - type: string - example: Failure - invalidinput: - type: object - properties: - message: - type: string - example: Invalid Input - status: - type: string - example: Failure - inputfieldmissing: - type: object - properties: - message: - type: string - example: Input Field Missing - status: - type: string - example: Failure - inputlimitexceeded: - type: object - properties: - message: - type: string - example: Input Limit Exceeded - status: - type: string - example: Failure - input: - type: object - properties: - url: - type: string - default: true - example: https://www.youtube.com/watch?v=1bumPyvzCyo - description: |+ - Youtube URL. - versions: - type: object - properties: - v0.1.0: - type: array - items: - oneOf: - - type: string - example: Published Date - Nov 25, 2019 - description: Initial version release - securitySchemes: - APIAuthorizer: - type: apiKey - name: x-api-key - in: header - x-amazon-apigateway-authtype: custom - description: Authentication is done using the x-api-key in the request header From 7fe8697700b063553e44cc98e8476f25a2abc50e Mon Sep 17 00:00:00 2001 From: Priyadharshini <57977344+priyadharshini-sent@users.noreply.github.com> Date: Mon, 15 Feb 2021 11:48:04 +0530 Subject: [PATCH 411/792] Update index.yaml --- index.yaml | 2 -- 1 file changed, 2 deletions(-) diff --git a/index.yaml b/index.yaml index 55d96b25e..26590b6dd 100644 --- a/index.yaml +++ b/index.yaml @@ -130,12 +130,10 @@ computer vision: landmark_detection_sg: title: Landmark Detection (SG) versions: - 1.0.0: 'landmark_detection_sg_v1.0.yaml' 0.1.0: 'landmark_detection_sg.yaml' landmark_detection_jp: title: Landmark Detection (JP) versions: - 1.0.0: 'landmark_detection_jp_v1.0.yaml' 0.1.0: 'landmark_detection_jp.yaml' demographics_classification: title: Demographics Classification From c357d0ae63e421783e9c43398134a69d7a786c81 Mon Sep 17 00:00:00 2001 From: Priyadharshini <57977344+priyadharshini-sent@users.noreply.github.com> Date: Wed, 17 Feb 2021 10:57:22 +0530 Subject: [PATCH 412/792] Update object_detection_v1.0.yaml --- computer_vision/object_detection_v1.0.yaml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/computer_vision/object_detection_v1.0.yaml b/computer_vision/object_detection_v1.0.yaml index e5db137ef..fb0676122 100644 --- a/computer_vision/object_detection_v1.0.yaml +++ b/computer_vision/object_detection_v1.0.yaml @@ -65,13 +65,13 @@ paths: application/json: schema: $ref: '#/components/schemas/inputfieldmissing' - '420': + '413': description: Input Limit Exceeded content: application/json: schema: $ref: '#/components/schemas/inputlimitexceeded' - '422': + '415': description: Invalid Input content: application/json: From 40e50ed420095716a118683eb169838ea9a41f08 Mon Sep 17 00:00:00 2001 From: Priyadharshini <57977344+priyadharshini-sent@users.noreply.github.com> Date: Wed, 17 Feb 2021 10:57:47 +0530 Subject: [PATCH 413/792] Update people_counting_v1.0.yaml --- computer_vision/people_counting_v1.0.yaml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/computer_vision/people_counting_v1.0.yaml b/computer_vision/people_counting_v1.0.yaml index bf40d0cc3..0d0395155 100644 --- a/computer_vision/people_counting_v1.0.yaml +++ b/computer_vision/people_counting_v1.0.yaml @@ -61,13 +61,13 @@ paths: application/json: schema: $ref: '#/components/schemas/inputfieldmissing' - '420': + '413': description: Input Limit Exceeded content: application/json: schema: $ref: '#/components/schemas/inputlimitexceeded' - '422': + '415': description: Invalid Input content: application/json: From 14d0a5b66fc7754b365600e5b373d87940a3acf9 Mon Sep 17 00:00:00 2001 From: Priyadharshini <57977344+priyadharshini-sent@users.noreply.github.com> Date: Wed, 17 Feb 2021 10:58:30 +0530 Subject: [PATCH 414/792] Update object_detection_v1.0.yaml --- computer_vision/object_detection_v1.0.yaml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/computer_vision/object_detection_v1.0.yaml b/computer_vision/object_detection_v1.0.yaml index e5db137ef..fb0676122 100644 --- a/computer_vision/object_detection_v1.0.yaml +++ b/computer_vision/object_detection_v1.0.yaml @@ -65,13 +65,13 @@ paths: application/json: schema: $ref: '#/components/schemas/inputfieldmissing' - '420': + '413': description: Input Limit Exceeded content: application/json: schema: $ref: '#/components/schemas/inputlimitexceeded' - '422': + '415': description: Invalid Input content: application/json: From 0835648b5d3ce8f2fa4d8d37fbffdb21f4893b6f Mon Sep 17 00:00:00 2001 From: Priyadharshini <57977344+priyadharshini-sent@users.noreply.github.com> Date: Wed, 17 Feb 2021 10:58:58 +0530 Subject: [PATCH 415/792] Update people_counting_v1.0.yaml --- computer_vision/people_counting_v1.0.yaml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/computer_vision/people_counting_v1.0.yaml b/computer_vision/people_counting_v1.0.yaml index bf40d0cc3..0d0395155 100644 --- a/computer_vision/people_counting_v1.0.yaml +++ b/computer_vision/people_counting_v1.0.yaml @@ -61,13 +61,13 @@ paths: application/json: schema: $ref: '#/components/schemas/inputfieldmissing' - '420': + '413': description: Input Limit Exceeded content: application/json: schema: $ref: '#/components/schemas/inputlimitexceeded' - '422': + '415': description: Invalid Input content: application/json: From d9e5b83088c0a974bd8e787a7ce352bcdcedd6c9 Mon Sep 17 00:00:00 2001 From: Priyadharshini <57977344+priyadharshini-sent@users.noreply.github.com> Date: Wed, 17 Feb 2021 11:23:12 +0530 Subject: [PATCH 416/792] Update pki_key_generator.yaml --- utility/pki_key_generator.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/utility/pki_key_generator.yaml b/utility/pki_key_generator.yaml index 4bb84d56a..76443b7cd 100644 --- a/utility/pki_key_generator.yaml +++ b/utility/pki_key_generator.yaml @@ -59,7 +59,7 @@ paths: application/json: schema: $ref: '#/components/schemas/inputfieldmissing' - '413: + '413': description: Input Limit Exceeded content: application/json: From 2494c8869fa437f9d755698e592a4d8a0ab6f82d Mon Sep 17 00:00:00 2001 From: Priyadharshini <57977344+priyadharshini-sent@users.noreply.github.com> Date: Wed, 17 Feb 2021 11:24:47 +0530 Subject: [PATCH 417/792] Update pki_key_generator.yaml --- utility/pki_key_generator.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/utility/pki_key_generator.yaml b/utility/pki_key_generator.yaml index 4bb84d56a..76443b7cd 100644 --- a/utility/pki_key_generator.yaml +++ b/utility/pki_key_generator.yaml @@ -59,7 +59,7 @@ paths: application/json: schema: $ref: '#/components/schemas/inputfieldmissing' - '413: + '413': description: Input Limit Exceeded content: application/json: From a65ab25c9b8e6d805104125330b3205d6037a8ec Mon Sep 17 00:00:00 2001 From: Priyadharshini <57977344+priyadharshini-sent@users.noreply.github.com> Date: Wed, 17 Feb 2021 13:24:50 +0530 Subject: [PATCH 418/792] Update page_profiler_eng.yaml --- nlp/page_profiler_eng.yaml | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/nlp/page_profiler_eng.yaml b/nlp/page_profiler_eng.yaml index 780eb4217..f4fd61d54 100644 --- a/nlp/page_profiler_eng.yaml +++ b/nlp/page_profiler_eng.yaml @@ -60,18 +60,18 @@ schema: $ref: '#/components/schemas/notfound' '419': - description: Not Found + description: Input Field Missing content: application/json: schema: $ref: '#/components/schemas/inputfieldmissing' - '420': - description: Not Found + '413': + description: Input Limit Exceeded content: application/json: schema: $ref: '#/components/schemas/inputlimitexceeded' - '422': + '415': description: Invalid Input content: application/json: From d6bf2bba0ca6ba227adea13fe049f5a7603a4b5b Mon Sep 17 00:00:00 2001 From: Priyadharshini <57977344+priyadharshini-sent@users.noreply.github.com> Date: Wed, 17 Feb 2021 13:25:31 +0530 Subject: [PATCH 419/792] Update page_profiler_jp.yaml --- nlp/page_profiler_jp.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/nlp/page_profiler_jp.yaml b/nlp/page_profiler_jp.yaml index 853994000..6b2f1a7e1 100644 --- a/nlp/page_profiler_jp.yaml +++ b/nlp/page_profiler_jp.yaml @@ -89,7 +89,7 @@ schema: $ref: '#/components/schemas/inputfieldmissing' '413': - description: Not Found + description: Input Limit Exceeded content: application/json: schema: From 4e3ac224a587707e079fce999fb65960dd609509 Mon Sep 17 00:00:00 2001 From: Priyadharshini <57977344+priyadharshini-sent@users.noreply.github.com> Date: Wed, 17 Feb 2021 13:26:40 +0530 Subject: [PATCH 420/792] Update page_profiler_thai.yaml --- nlp/page_profiler_thai.yaml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/nlp/page_profiler_thai.yaml b/nlp/page_profiler_thai.yaml index 396977e39..d1b1e94e3 100644 --- a/nlp/page_profiler_thai.yaml +++ b/nlp/page_profiler_thai.yaml @@ -89,13 +89,13 @@ schema: $ref: '#/components/schemas/notfound' '419': - description: Not Found + description: Input Field Missing content: application/json: schema: $ref: '#/components/schemas/inputfieldmissing' '413': - description: Not Found + description: Input Limit Exceeded content: application/json: schema: From f2fe3a39e03eb16e058f0c0271f6b2539bfd6571 Mon Sep 17 00:00:00 2001 From: Mohamed Luqman <57977684+mohamedSent@users.noreply.github.com> Date: Thu, 18 Feb 2021 22:55:15 +0530 Subject: [PATCH 421/792] created ihi data pointcloud --- data/ihi_data_pointcloud | 447 +++++++++++++++++++++++++++++++++++++++ 1 file changed, 447 insertions(+) create mode 100644 data/ihi_data_pointcloud diff --git a/data/ihi_data_pointcloud b/data/ihi_data_pointcloud new file mode 100644 index 000000000..bc7ce1086 --- /dev/null +++ b/data/ihi_data_pointcloud @@ -0,0 +1,447 @@ +openapi: 3.0.1 +info: + title: IHI Pointcloud Data + x-subscribelink: ihi_data + description: |+ + This Data microservice returns information on IHI Pointcloud Data which includes the location address, postal code, gender and age groups, down to block-level granularity.The HDB POTH programme makes selected public and non-public datasets available to developers and companies to improve their service offerings to benefit the lives of Singapore citizens. Sentient.io is proud to partner with HDB to manage and facilitate the sharing of data for the POTH Programme. + + **Note:** As this microservice uses the GET method, developers using this microservice must remember to have their app encode all the input values to be URL friendly (i.e. all spaces and special characters must be replaced). Here’s a reference on [URL encoding](https://www.w3schools.com/tags/ref_urlencode.ASP). + + x-additionalinfo : |+ + Suggested Use Cases: + - This microservice can be used as a solution to help businesses better understand and connect with their customers, engage new prospects and increase revenue. For example, it can be used to create intelligent prospect lists that ensure one is always maximizing their marketing investment. + + **Refining queries in the filterdata field using filter types and match types** + The filterdata fields use elasticsearch’s syntax (specifically filter types and match types) to help further refine search results and provide greater flexibility in structuring more sophisticated queries. + + **Filter Types:** + A filter type is a logic operator to which the search results must fulfill certain logical conditions to be returned. The supported match types are: + + * **must** - All of the stated conditions must match. Equivalent to an AND operator. + + > {"must":[{"match_phrase":{"street":"serangoon north avenue 4"}}]} + + * **must_not** - All of the stated conditions must not match. Equivalent to a NOT operator. + > {"must_not":[{"match":{"postalcode":"570251"}}]} + + * **should** - At least one of the stated conditions should match. Equivalent to an OR operator. + > {"should":[{"match_phrase":{"street":"serangoon north avenue 4"}}]} + + * **filter** - All of the stated conditions that must match. However, results are not scored unlike the other filter types which returns results based on how well the conditions are met. + > {"filter":[{"match":{"street":"serangoon"}}]} + + For a more detailed guide on filter types, [refer to this](https://www.elastic.co/guide/en/elasticsearch/reference/6.8/query-dsl-bool-query.html). + + Filter types cannot be used alone and must be used in conjunction with a match type to complete the query. + **Match Types:** + A match type is a match operator nested within a filter type that fine-tunes the matching condition of the text search. The supported match types are: + + * **match** - Search within a full text field for a single word + > {"match":{"street":"serangoon"}} + * **match_phrase** - Search within a full text field + > {"match_phrase":{"street":"serangoon central"}} + * **match_phrase_prefix** - Search within a full text field with prefix + > {"match_phrase_prefix":{"street":"serangoon central"}} + * **term** - Returns results that contain an exact term in a provided field + > {"term":{"postalcode":"560720"}} + * **terms** - Returns results that contain one or more exact terms in a provided field + > {"terms":{"postalcode":["560720","560721"]}} + + * **range** - Returns results that contain terms within a stipulated range + + > {"range":{"residents":{"gte":10}}} + > {"range":{"residents":{"lte":50}}} + > {"range":{"residents":{"gte":10,"lte":50}}} + + * **exists** - Returns results that contain any indexed value for a field + + > {"exists":{ "field":"postalcode"}} + For a more detailed guide to match types, [refer to this](https://www.elastic.co/guide/en/elasticsearch/reference/7.9/term-level-queries.html). + + **Forming sophisticated queries using combinations of filter types (in JSON)** + Multiple filter types can be combined together in one query (written in JSON format) to form a very sophisticated query. Here’s one example below: + + > { + > "must":[{"match_phrase":{"street":"serangoon+central"}}], + > "filter":[{"range":{"residents":{"gte":10}}}], + > "should":[{"match":{"gender":"male"}}], + > "must_not":[{"match":{"age_group_id":"2"}}] + > } + **Sample Queries Based on Use Cases** + + 1. **Search for the number of elderly residents staying at Blk 423, Tampines Street 41 filter by age and gender.** + Using a filterdata only: + + > {"filter":[{"match":{"street":"tampines street 41"}},{"match":{"block":"423"}},{"terms":{"age_group_id":[6,7,8]}}]} + + 2. **Search for the number of female residents between age 50 to 59 staying in the postal code from 050034 to 050532.** + Using a filterdata only: + + > {"filter":[{"terms":{"postalcode":["050034","050532"]}},{"match":{"gender":"female"}},{"terms":{"age_group_id":[6]}}]} + version: '0.1.0' +servers: + - url: 'https://api.sentient.io' +tags: +- name: "v0.1.0" + description: "Published Date - May 15, 2020" +paths: + /DaaS/prod/hdb/demographics: + get: + tags: + - v0.1.0 + parameters: + - in: query + name: querystring + schema: + type: string + description: |+ + Simple keyword search for matches in all searchable fields. Keywords separated by spaces will return results containing any of those keywords. For exact phrase match, put entire phrase in double quotes (" "). + + If this field is set to null, by default the microservice will return all buildings (within the stated limit), which can be further refined through the filterdata field for more sophisticated queries. + + example: "tampines" + default: false + - in: query + name: offset + schema: + type: integer + description: The offset of the record list ie the starting index + example: "0" + default: false + - in: query + name: limit + schema: + type: integer + description: The max records to return for the request. Default - 10, Max - 10000 + example: "10" + default: false + - in: query + name: filterdata + schema: + type: string + description: |+ + Refine the search further on any of the possible through the 4 filter types : + * must + * must_not + * should + * filter + default: false + example: |+ + {"filter":[{"match":{"age_group_id":7}},{"match":{"gender":"male"}},{"match":{"postalcode":520423}}]} + responses: + '200': + description: success response + content: + application/json: + schema: + $ref: '#/components/schemas/success' + example: + results: + total: 986 + max_score: 17.995623 + hits: + - _index: sentient_demographics_hdb_index + _type: dir_doc + _id: K7scqWgBv3dNEHq2WvMo + _score: 17.995623 + _source: + postalcode: '560720' + gender: 'male' + age_group: '50 to 59' + age_group_id: 6 + residents: 54 + block: '34' + street: 'upper cross street' + xcoord: 29520.58 + ycoord: 39311.68 + address: '34 upper cross street' + createddate: '2020-04-23' + lastupdated: '2020-04-23' + location: + lat: 1.37179535 + lon: 103.8469821 + source: hdb + message: Successfully Processed + status: Success + '401': + description: Unauthorized + content: + application/json: + schema: + $ref: '#/components/schemas/unauthorized' + '402': + description: Payment Required + content: + application/json: + schema: + $ref: '#/components/schemas/paymentrequired' + '403': + description: Forbidden + content: + application/json: + schema: + $ref: '#/components/schemas/forbidden' + '404': + description: Not Found + content: + application/json: + schema: + $ref: '#/components/schemas/notfound' + '419': + description: Input Field Missing + content: + application/json: + schema: + $ref: '#/components/schemas/inputfieldmissing' + '413': + description: Input Limit Exceeded + content: + application/json: + schema: + $ref: '#/components/schemas/inputlimitexceeded' + '415': + description: Invalid Input + content: + application/json: + schema: + $ref: '#/components/schemas/invalidinput' + '500': + description: Internal Server Error + content: + application/json: + schema: + $ref: '#/components/schemas/servererror' + '504': + description: Gateway Timeout + content: + application/json: + schema: + $ref: '#/components/schemas/gatewaytimeout' + security: + - APIAuthorizer: [] +components: + schemas: + success: + type: object + properties: + results: + type: object + example: {} + description: Json Object of returned results + properties: + total: + type: number + example: 986 + description: Total number of records + max_score: + type: number + example: 17.995623 + description: The highest score value + hits: + type: array + example: [{} + description: Json Object of returned hits + properties: + postalcode: + type: string + description: Postal code of a block + example: "560720" + gender: + type: string + description: Gender details, values are male/female + example: "male" + age_group: + type: string + description: Range of age groups + example: "50 to 59" + age_group_id: + type: number + description: |+ + Age group ID represents a certain age range: + 1 (<10 years) + 2 (10-19 years) + 3 (20-29 years) + 4 (30-39 years) + 5 (40-49 years) + 6 (50-59 years) + 7 (60-69 years) + 8 (>70 years) + example: 6 + residents: + type: number + description: Number of residents + example: 54 + block: + type: string + description: Address block + example: "34" + street: + type: string + description: Street Address or building name + example: "upper cross street" + xcoord: + type: string + description: SVY21 X coordinates + example: 29520.58 + ycoord: + type: string + description: SVY21 Y coordinates + example: 39311.68 + address: + type: string + description: Building full address + example: "34 upper cross street" + createddate: + type: string + description: Record first release date on sentient + example: "2020-04-23" + lastupdated: + type: string + description: Record last updated date on sentient + example: "2020-04-23" + location: + type: object + description: WGS84 coordinates lat/long + example: {"lat":1.37179535,"lon":103.8469821} + properties: + lat: + type: string + description: WGS84 latitude + example: 1.37179535 + lon: + type: string + description: WGS84 longitude + example: 103.8469821 + source: + type: string + description: Dataset source + example: "hdb" + message: + type: string + example: Successfully Processed + description: The detail description on the status + status: + type: string + example: Success + description: The status of the API call Success/Failure + unauthorized: + type: object + properties: + message: + type: string + example: Missing Authentication Token + status: + type: string + example: Failure + forbidden: + type: object + properties: + message: + type: string + example: Access Denied Unauthorized User + status: + type: string + example: Failure + paymentrequired: + type: object + properties: + message: + type: string + example: Insufficient Credits Kindly Top Up + status: + type: string + example: Failure + notfound: + type: object + properties: + message: + type: string + example: Invalid Request URL + status: + type: string + example: Failure + servererror: + type: object + properties: + message: + type: string + example: Internal Server Error + status: + type: string + example: Failure + gatewaytimeout: + type: object + properties: + message: + type: string + example: Request Timeout + status: + type: string + example: Failure + inputfieldmissing: + type: object + properties: + message: + type: string + example: Input Field Missing + status: + type: string + example: Failure + inputlimitexceeded: + type: object + properties: + message: + type: string + example: Input Limit Exceeded + status: + type: string + example: Failure + invalidinput: + type: object + properties: + message: + type: string + example: Invalid Input + status: + type: string + example: Failure + versions: + type: object + properties: + v0.1.0: + type: array + items: + oneOf: + - type: string + example: Published Date - May 15,2020 + description: Initial version release + securitySchemes: + APIAuthorizer: + type: apiKey + name: x-api-key + in: header + x-amazon-apigateway-authtype: custom + description: Authentication is done using the x-api-key in the request header. From 453a3b4fa05d5c9d394803cc1adc9508cf9fbc3f Mon Sep 17 00:00:00 2001 From: rameshsentient <51635015+rameshsentient@users.noreply.github.com> Date: Fri, 19 Feb 2021 09:56:05 +0530 Subject: [PATCH 422/792] Update automatic_speech_recognition_eng_sg.yaml --- voice/automatic_speech_recognition_eng_sg.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/voice/automatic_speech_recognition_eng_sg.yaml b/voice/automatic_speech_recognition_eng_sg.yaml index 0fcc4431a..841a18456 100644 --- a/voice/automatic_speech_recognition_eng_sg.yaml +++ b/voice/automatic_speech_recognition_eng_sg.yaml @@ -6,7 +6,7 @@ info: This microservice performs well on Singaporean-accented English speech. For best performance, select the model which best matches the use-case: news_parliament, nsc_parliament and nscfull_8k. - The size of your audio file should be **between 3 KB to 10 MB**. + The length of your audio should be **upto 60 seconds**. version: '0.1.0' x-additionalinfo: |+ Suggested Use Cases: From 1c8357ba08de2faecac8d021e6422f8f9b10aaf8 Mon Sep 17 00:00:00 2001 From: rameshsentient <51635015+rameshsentient@users.noreply.github.com> Date: Fri, 19 Feb 2021 09:59:08 +0530 Subject: [PATCH 423/792] Update automatic_speech_recognition_eng_sg_v1.0.yaml --- voice/automatic_speech_recognition_eng_sg_v1.0.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/voice/automatic_speech_recognition_eng_sg_v1.0.yaml b/voice/automatic_speech_recognition_eng_sg_v1.0.yaml index 0ede6f6f7..8565f751b 100644 --- a/voice/automatic_speech_recognition_eng_sg_v1.0.yaml +++ b/voice/automatic_speech_recognition_eng_sg_v1.0.yaml @@ -6,7 +6,7 @@ info: This microservice performs well on Singaporean-accented English speech. For best performance, select the model which best matches the use-case, whether for prepared speech (16kHz) or telephony (8kHz). - The size of your audio file should be **between 3 KB to 10 MB**. + The length of your audio should be **upto 60 seconds**. version: '1.1.0' x-additionalinfo: |+ Suggested Use Cases: From a4cce0b0f4dff0df4e8bd7af07f51558df662e1e Mon Sep 17 00:00:00 2001 From: rameshsentient <51635015+rameshsentient@users.noreply.github.com> Date: Fri, 19 Feb 2021 10:20:04 +0530 Subject: [PATCH 424/792] Update asr_with_voice_activity_detection_eng_sg.yaml --- voice/asr_with_voice_activity_detection_eng_sg.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/voice/asr_with_voice_activity_detection_eng_sg.yaml b/voice/asr_with_voice_activity_detection_eng_sg.yaml index d69738753..2f1da5d6a 100644 --- a/voice/asr_with_voice_activity_detection_eng_sg.yaml +++ b/voice/asr_with_voice_activity_detection_eng_sg.yaml @@ -6,7 +6,7 @@ info: This Voice microservice performs well on Singapore-accented English speech. For best performance, select the model which best matches the use-case: news_parliament, nsc_parliament, nscfull_8k. - The size of your audio file should be **between 3 KB to 10 MB**. + The length of your audio should be **upto 60 seconds**. version: '0.1.0' x-additionalinfo: |+ Suggested Use Cases: From 120712b76f3172b3ff9f35e2ffb095daea2360a8 Mon Sep 17 00:00:00 2001 From: rameshsentient <51635015+rameshsentient@users.noreply.github.com> Date: Fri, 19 Feb 2021 10:22:42 +0530 Subject: [PATCH 425/792] Update asr_with_voice_activity_detection_eng_sg_v1.0.yaml --- voice/asr_with_voice_activity_detection_eng_sg_v1.0.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/voice/asr_with_voice_activity_detection_eng_sg_v1.0.yaml b/voice/asr_with_voice_activity_detection_eng_sg_v1.0.yaml index cce373106..7e10921d5 100644 --- a/voice/asr_with_voice_activity_detection_eng_sg_v1.0.yaml +++ b/voice/asr_with_voice_activity_detection_eng_sg_v1.0.yaml @@ -5,7 +5,7 @@ info: This Voice microservice combines Voice Activity Detection feature and Automatic Speech Recognition capability. It detects speech in an audio file (.wav format) and transcribes English speech content from the audio stream into text. The transcript text is timestamped for each utterance. An utterance is a continuous piece of speech beginning and ending with a clear pause. This microservice performs well on Singaporean-accented English speech. For best performance, select the model which best matches the use-case, whether for prepared speech (16kHz) or telephony (8kHz). - The size of your audio file should be **between 3 KB to 10 MB**. + The length of your audio should be **upto 60 seconds**. version: '1.1.0' x-additionalinfo: |+ Suggested Use Cases: From b56e868e5319e024ae13e750b733644ba76b0418 Mon Sep 17 00:00:00 2001 From: rameshsentient <51635015+rameshsentient@users.noreply.github.com> Date: Fri, 19 Feb 2021 10:30:16 +0530 Subject: [PATCH 426/792] Update voice_activity_detection_eng_v1.0.yaml --- voice/voice_activity_detection_eng_v1.0.yaml | 1 + 1 file changed, 1 insertion(+) diff --git a/voice/voice_activity_detection_eng_v1.0.yaml b/voice/voice_activity_detection_eng_v1.0.yaml index 0ec7ac1cf..24286f984 100644 --- a/voice/voice_activity_detection_eng_v1.0.yaml +++ b/voice/voice_activity_detection_eng_v1.0.yaml @@ -5,6 +5,7 @@ info: This Voice microservice detects utterances in the input audio and outputs the start and end time of these utterances. An utterance is the smallest unit of speech. It is a continuous piece of speech beginning and ending with a clear pause. + The length of your audio should be **upto 60 seconds**. version: '1.0.0' x-additionalinfo: |+ Suggested Use Cases: From d560552028827a6585a238a77219be9681620b52 Mon Sep 17 00:00:00 2001 From: rameshsentient <51635015+rameshsentient@users.noreply.github.com> Date: Fri, 19 Feb 2021 10:30:19 +0530 Subject: [PATCH 427/792] Update voice_activity_detection_eng.yaml --- voice/voice_activity_detection_eng.yaml | 1 + 1 file changed, 1 insertion(+) diff --git a/voice/voice_activity_detection_eng.yaml b/voice/voice_activity_detection_eng.yaml index 021359beb..814f318c0 100644 --- a/voice/voice_activity_detection_eng.yaml +++ b/voice/voice_activity_detection_eng.yaml @@ -5,6 +5,7 @@ info: This Voice microservice detects utterances in the input audio and outputs the start and end time of these utterances. An utterance is the smallest unit of speech. It is a continuous piece of speech beginning and ending with a clear pause. + The length of your audio should be **upto 60 seconds**. x-additionalinfo: |+ Suggested Use Cases: - Narrate a blurb or chunk of text in English From bd6279a8a54cb745d5bfe6e8370d4cb84ba33ca2 Mon Sep 17 00:00:00 2001 From: Mohamed Luqman <57977684+mohamedSent@users.noreply.github.com> Date: Fri, 19 Feb 2021 12:06:53 +0530 Subject: [PATCH 428/792] updated with ihidata contents --- data/ihi_data_pointcloud | 216 ++++++++++++++++++++++----------------- 1 file changed, 123 insertions(+), 93 deletions(-) diff --git a/data/ihi_data_pointcloud b/data/ihi_data_pointcloud index bc7ce1086..53c8c3082 100644 --- a/data/ihi_data_pointcloud +++ b/data/ihi_data_pointcloud @@ -3,7 +3,7 @@ info: title: IHI Pointcloud Data x-subscribelink: ihi_data description: |+ - This Data microservice returns information on IHI Pointcloud Data which includes the location address, postal code, gender and age groups, down to block-level granularity.The HDB POTH programme makes selected public and non-public datasets available to developers and companies to improve their service offerings to benefit the lives of Singapore citizens. Sentient.io is proud to partner with HDB to manage and facilitate the sharing of data for the POTH Programme. + This microservice returns information on Ishikawajima-Harima Heavy Industries(IHI) Pointcloud Data which includes the 3DLR Location of Boon Lay Way-Yuan Ching Road, Singapore. The Data comprises all the vehicle detection and does contain any pedestrian data. The IHI LiDAR programme makes selected public and non-public datasets available to developers and companies to improve their service offerings to benefit the lives of Singapore citizens. Sentient.io is proud to partner with IHI to manage and facilitate the sharing of data for the LiDAR Programme. **Note:** As this microservice uses the GET method, developers using this microservice must remember to have their app encode all the input values to be URL friendly (i.e. all spaces and special characters must be replaced). Here’s a reference on [URL encoding](https://www.w3schools.com/tags/ref_urlencode.ASP). @@ -83,9 +83,9 @@ servers: - url: 'https://api.sentient.io' tags: - name: "v0.1.0" - description: "Published Date - May 15, 2020" + description: "Published Date - Feb 26, 2021" paths: - /DaaS/prod/hdb/demographics: + /DaaS/dev/ihidata: get: tags: - v0.1.0 @@ -99,7 +99,7 @@ paths: If this field is set to null, by default the microservice will return all buildings (within the stated limit), which can be further refined through the filterdata field for more sophisticated queries. - example: "tampines" + example: "2020/7/7T20:29:14.280Z" default: false - in: query name: offset @@ -127,7 +127,7 @@ paths: * filter default: false example: |+ - {"filter":[{"match":{"age_group_id":7}},{"match":{"gender":"male"}},{"match":{"postalcode":520423}}]} + {"filter":[{"match":{_id": "57464093"}},{"match":{"dataclass": "SD"}},{"match":{"detecttime": "2020-7-7T18:28:45.365Z"}}]} responses: '200': description: success response @@ -137,30 +137,38 @@ paths: $ref: '#/components/schemas/success' example: results: - total: 986 - max_score: 17.995623 + total: 607176 + max_score: 1.0 hits: - - _index: sentient_demographics_hdb_index + - _index: index_ihi_pointcloud _type: dir_doc - _id: K7scqWgBv3dNEHq2WvMo - _score: 17.995623 + _id: 57364055 + _score: 1.0 _source: - postalcode: '560720' - gender: 'male' - age_group: '50 to 59' - age_group_id: 6 - residents: 54 - block: '34' - street: 'upper cross street' - xcoord: 29520.58 - ycoord: 39311.68 - address: '34 upper cross street' - createddate: '2020-04-23' - lastupdated: '2020-04-23' - location: - lat: 1.37179535 - lon: 103.8469821 - source: hdb + 1x: 79 + 1y: 3927 + 2x: 79 + 2y: 4515 + createddate: '2021-02-18T16:19:09.689Z' + lastupdated: '2021-02-18T16:19:09.689Z' + dataclass: "SD" + datalen: 612 + datanumlow: 15 + datanumup: 0 + detecttime: '2020-7-7T18:28:45.365Z' + height: 261 + identify: 11 + jamlane: 0 + length: 588 + originid: "0x145D" + sendtime: '2020-7-7T18:38:35.653Z' + seqno: 573 + situation: "0x02" + targetid: 64055 + targetidx: "0x1451" + width: 250 + xspeed: -8 + yspeed: -60 message: Successfully Processed status: Success '401': @@ -231,11 +239,11 @@ components: properties: total: type: number - example: 986 + example: 607176 description: Total number of records max_score: type: number - example: 17.995623 + example: 1.0 description: The highest score value hits: type: array @@ -247,7 +255,7 @@ components: _index: type: string description: Index group of the document - example: "sentient_demographics_hdb_index" + example: "index_ihi_pointcloud" _type: type: string description: Content type of the document @@ -255,90 +263,112 @@ components: _id: type: string description: Document ID - example: "K7scqWgBv3dNEHq2WvMo" + example: "57364055" _score: type: number description: The document score for the search request - example: 17.995623 + example: 1.0 _source: type: object example: {} description: Json Object of returned hits properties: - postalcode: - type: string - description: Postal code of a block - example: "560720" - gender: - type: string - description: Gender details, values are male/female - example: "male" - age_group: - type: string - description: Range of age groups - example: "50 to 59" - age_group_id: + 1x: type: number - description: |+ - Age group ID represents a certain age range: - 1 (<10 years) - 2 (10-19 years) - 3 (20-29 years) - 4 (30-39 years) - 5 (40-49 years) - 6 (50-59 years) - 7 (60-69 years) - 8 (>70 years) - example: 6 - residents: + description: X direction central top position of target + example: 79 + 1y: type: number - description: Number of residents - example: 54 - block: - type: string - description: Address block - example: "34" - street: + description: Y direction central top position of target + example: 3927 + 2x: + type: number + description: X direction central tail position of target + example: 79 + 2y: + type: number + description: Y direction central tail position of target + example: 4515 + dataclass: type: string - description: Street Address or building name - example: "upper cross street" - xcoord: + description: Type of Data + example: "SD" + datalen: + type: number + description: Lenght of the information + example: 612 + datanumlow: + type: number + description: Lower data number + example: 15 + datanumup: + type: number + description: Upper data number + example: 0 + detecttime: type: string - description: SVY21 X coordinates - example: 29520.58 - ycoord: + description: Target detected time + example: "2020-7-7T18:28:45.365Z" + height: + type: number + description: Height of target + example: 261 + identify: + type: number + description: Target vehicle type + example: 11 + jamlane: + type: number + description: Jam lane number + example: 0 + length: + type: number + description: Length of target + example: 588 + originid: type: string - description: SVY21 Y coordinates - example: 39311.68 - address: + description: Origin Id + example: "0x145D" + sendtime: type: string - description: Building full address - example: "34 upper cross street" + description: Target send time + example: "2020-7-7T18:38:35.653Z" createddate: type: string description: Record first release date on sentient - example: "2020-04-23" + example: "2021-02-18T16:19:09.689Z" lastupdated: type: string description: Record last updated date on sentient - example: "2020-04-23" - location: - type: object - description: WGS84 coordinates lat/long - example: {"lat":1.37179535,"lon":103.8469821} - properties: - lat: - type: string - description: WGS84 latitude - example: 1.37179535 - lon: - type: string - description: WGS84 longitude - example: 103.8469821 - source: + example: "2021-02-18T16:19:09.689Z" + seqno: + type: number + description: Sequence number of target + example: 573 + situation: type: string - description: Dataset source - example: "hdb" + description: Situation of target + example: "0x02" + targetid: + type: number + description: Target Id + example: 64055 + targetidx: + type: string + description: Target Idx + example: "0x1451" + width: + type: number + description: Width of target + example: 250 + xspeed: + type: number + description: xspeed of target + example: -8 + yspeed: + type: number + description: yspeed of target + example: -60 message: type: string example: Successfully Processed @@ -436,7 +466,7 @@ components: items: oneOf: - type: string - example: Published Date - May 15,2020 + example: Published Date - Feb 26,2021 description: Initial version release securitySchemes: APIAuthorizer: From e114dad1bf6c18c46d2dba707721753e87560bbd Mon Sep 17 00:00:00 2001 From: Mohamed Luqman <57977684+mohamedSent@users.noreply.github.com> Date: Fri, 19 Feb 2021 12:44:51 +0530 Subject: [PATCH 429/792] updated docs information --- data/ihi_data_pointcloud | 26 +++++++++++++------------- 1 file changed, 13 insertions(+), 13 deletions(-) diff --git a/data/ihi_data_pointcloud b/data/ihi_data_pointcloud index 53c8c3082..4e2d490f5 100644 --- a/data/ihi_data_pointcloud +++ b/data/ihi_data_pointcloud @@ -19,16 +19,16 @@ info: * **must** - All of the stated conditions must match. Equivalent to an AND operator. - > {"must":[{"match_phrase":{"street":"serangoon north avenue 4"}}]} + > {"must":[{"match_phrase":{"identify":10}}]} * **must_not** - All of the stated conditions must not match. Equivalent to a NOT operator. - > {"must_not":[{"match":{"postalcode":"570251"}}]} + > {"must_not":[{"match":{"jamlane":0}}]} * **should** - At least one of the stated conditions should match. Equivalent to an OR operator. - > {"should":[{"match_phrase":{"street":"serangoon north avenue 4"}}]} + > {"should":[{"match_phrase":{"seqno":39736}}]} * **filter** - All of the stated conditions that must match. However, results are not scored unlike the other filter types which returns results based on how well the conditions are met. - > {"filter":[{"match":{"street":"serangoon"}}]} + > {"filter":[{"match":{"targetid":9405}}]} For a more detailed guide on filter types, [refer to this](https://www.elastic.co/guide/en/elasticsearch/reference/6.8/query-dsl-bool-query.html). @@ -37,15 +37,15 @@ info: A match type is a match operator nested within a filter type that fine-tunes the matching condition of the text search. The supported match types are: * **match** - Search within a full text field for a single word - > {"match":{"street":"serangoon"}} + > {"match":{"dataclass":"SD"}} * **match_phrase** - Search within a full text field - > {"match_phrase":{"street":"serangoon central"}} + > {"match_phrase":{"seqno":39736}} * **match_phrase_prefix** - Search within a full text field with prefix - > {"match_phrase_prefix":{"street":"serangoon central"}} + > {"match_phrase_prefix":{"originid":"0x145D"}} * **term** - Returns results that contain an exact term in a provided field - > {"term":{"postalcode":"560720"}} + > {"term":{"situation":"0x02"}} * **terms** - Returns results that contain one or more exact terms in a provided field - > {"terms":{"postalcode":["560720","560721"]}} + > {"terms":{"identify":[10,11,12]}} * **range** - Returns results that contain terms within a stipulated range @@ -55,7 +55,7 @@ info: * **exists** - Returns results that contain any indexed value for a field - > {"exists":{ "field":"postalcode"}} + > {"exists":{ "field":"identify"}} For a more detailed guide to match types, [refer to this](https://www.elastic.co/guide/en/elasticsearch/reference/7.9/term-level-queries.html). **Forming sophisticated queries using combinations of filter types (in JSON)** @@ -74,10 +74,10 @@ info: > {"filter":[{"match":{"street":"tampines street 41"}},{"match":{"block":"423"}},{"terms":{"age_group_id":[6,7,8]}}]} - 2. **Search for the number of female residents between age 50 to 59 staying in the postal code from 050034 to 050532.** + 2. **Search for the different types of cars like Motorcycle, Normal car, Large car of dataclass "SD" in detected time of "2020-7-7T19:19:39.985Z".** Using a filterdata only: - > {"filter":[{"terms":{"postalcode":["050034","050532"]}},{"match":{"gender":"female"}},{"terms":{"age_group_id":[6]}}]} + > {"filter":[{"terms":{"identify":[10,11,12]}},{"match":{"dataclass":"SD"}},{"terms":{"detecttime":"2020-7-7T19:19:39.985Z"}}]} version: '0.1.0' servers: - url: 'https://api.sentient.io' @@ -127,7 +127,7 @@ paths: * filter default: false example: |+ - {"filter":[{"match":{_id": "57464093"}},{"match":{"dataclass": "SD"}},{"match":{"detecttime": "2020-7-7T18:28:45.365Z"}}]} + {"filter":[{"match":{"_id": "57464093"}},{"match":{"dataclass": "SD"}},{"match":{"detecttime": "2020-7-7T18:28:45.365Z"}}]} responses: '200': description: success response From fae27b0060f0729be77d471ec24b05ad281698fc Mon Sep 17 00:00:00 2001 From: priyaPeristera Date: Fri, 19 Feb 2021 19:16:02 +1100 Subject: [PATCH 430/792] Add IHI data microservice --- index.yaml | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/index.yaml b/index.yaml index 26590b6dd..e11ec6b52 100644 --- a/index.yaml +++ b/index.yaml @@ -274,6 +274,10 @@ data: title: D&B Brief Financial Information (SG) versions: 0.1.0: 'd&b_brief_financial_information_sg.yaml' + ihi_data_pointcloud: + title: IHI Point Cloud + versions: + 0.1.0: 'ihi_data_pointcloud.yaml' data alliance: download_dataset_api: title: Download Dataset API From eef8896913c2b090ba8186da3af3015ce804e910 Mon Sep 17 00:00:00 2001 From: rameshsentient <51635015+rameshsentient@users.noreply.github.com> Date: Fri, 19 Feb 2021 14:10:52 +0530 Subject: [PATCH 431/792] Update automatic_speech_recognition_chi_sg.yaml --- voice/automatic_speech_recognition_chi_sg.yaml | 1 + 1 file changed, 1 insertion(+) diff --git a/voice/automatic_speech_recognition_chi_sg.yaml b/voice/automatic_speech_recognition_chi_sg.yaml index a5c9ba89e..e5e8aaff7 100644 --- a/voice/automatic_speech_recognition_chi_sg.yaml +++ b/voice/automatic_speech_recognition_chi_sg.yaml @@ -5,6 +5,7 @@ info: This Voice microservice takes in the input audio file (in WAV format at 16kHz) and transcribes Mandarin speech content within the input file into text. This microservice works best when the audio file consists of mostly speech with no long pauses in between. + The length of your audio should be **upto 20 seconds**. x-additionalinfo: |+ Suggested Use Cases: - Extraction of text from voice ( from sound files), especially with Singaporean accented Mandarin. From 779bd0d4a8707cba58de98a1509234e4112855d7 Mon Sep 17 00:00:00 2001 From: Priyadharshini <57977344+priyadharshini-sent@users.noreply.github.com> Date: Fri, 19 Feb 2021 14:12:07 +0530 Subject: [PATCH 432/792] Update ihi_data_pointcloud --- data/ihi_data_pointcloud | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/data/ihi_data_pointcloud b/data/ihi_data_pointcloud index 4e2d490f5..78385e59e 100644 --- a/data/ihi_data_pointcloud +++ b/data/ihi_data_pointcloud @@ -5,7 +5,7 @@ info: description: |+ This microservice returns information on Ishikawajima-Harima Heavy Industries(IHI) Pointcloud Data which includes the 3DLR Location of Boon Lay Way-Yuan Ching Road, Singapore. The Data comprises all the vehicle detection and does contain any pedestrian data. The IHI LiDAR programme makes selected public and non-public datasets available to developers and companies to improve their service offerings to benefit the lives of Singapore citizens. Sentient.io is proud to partner with IHI to manage and facilitate the sharing of data for the LiDAR Programme. - **Note:** As this microservice uses the GET method, developers using this microservice must remember to have their app encode all the input values to be URL friendly (i.e. all spaces and special characters must be replaced). Here’s a reference on [URL encoding](https://www.w3schools.com/tags/ref_urlencode.ASP). + **Note:** As this microservice uses the GET method, developers using this microservice must remember to have their app encode all the input values to be URL friendly. x-additionalinfo : |+ Suggested Use Cases: From df976c9e4f79abd3346b12e8d1f83902716bc352 Mon Sep 17 00:00:00 2001 From: Priyadharshini <57977344+priyadharshini-sent@users.noreply.github.com> Date: Fri, 19 Feb 2021 14:13:19 +0530 Subject: [PATCH 433/792] Update ihi_data_pointcloud --- data/ihi_data_pointcloud | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/data/ihi_data_pointcloud b/data/ihi_data_pointcloud index 78385e59e..4e2d490f5 100644 --- a/data/ihi_data_pointcloud +++ b/data/ihi_data_pointcloud @@ -5,7 +5,7 @@ info: description: |+ This microservice returns information on Ishikawajima-Harima Heavy Industries(IHI) Pointcloud Data which includes the 3DLR Location of Boon Lay Way-Yuan Ching Road, Singapore. The Data comprises all the vehicle detection and does contain any pedestrian data. The IHI LiDAR programme makes selected public and non-public datasets available to developers and companies to improve their service offerings to benefit the lives of Singapore citizens. Sentient.io is proud to partner with IHI to manage and facilitate the sharing of data for the LiDAR Programme. - **Note:** As this microservice uses the GET method, developers using this microservice must remember to have their app encode all the input values to be URL friendly. + **Note:** As this microservice uses the GET method, developers using this microservice must remember to have their app encode all the input values to be URL friendly (i.e. all spaces and special characters must be replaced). Here’s a reference on [URL encoding](https://www.w3schools.com/tags/ref_urlencode.ASP). x-additionalinfo : |+ Suggested Use Cases: From 225b2797df20743fa6eca9673aefc24cb3ab0f3e Mon Sep 17 00:00:00 2001 From: Priyadharshini <57977344+priyadharshini-sent@users.noreply.github.com> Date: Fri, 19 Feb 2021 14:14:41 +0530 Subject: [PATCH 434/792] Rename ihi_data_pointcloud to ihi_data_pointcloud.yaml --- data/{ihi_data_pointcloud => ihi_data_pointcloud.yaml} | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename data/{ihi_data_pointcloud => ihi_data_pointcloud.yaml} (100%) diff --git a/data/ihi_data_pointcloud b/data/ihi_data_pointcloud.yaml similarity index 100% rename from data/ihi_data_pointcloud rename to data/ihi_data_pointcloud.yaml From ac82e6c053d879a58a6f28a53fcba40c776a2e6f Mon Sep 17 00:00:00 2001 From: Mohamed Luqman <57977684+mohamedSent@users.noreply.github.com> Date: Fri, 19 Feb 2021 14:38:14 +0530 Subject: [PATCH 435/792] Update ihi_data_pointcloud.yaml --- data/ihi_data_pointcloud.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/data/ihi_data_pointcloud.yaml b/data/ihi_data_pointcloud.yaml index 4e2d490f5..3d03856eb 100644 --- a/data/ihi_data_pointcloud.yaml +++ b/data/ihi_data_pointcloud.yaml @@ -99,7 +99,7 @@ paths: If this field is set to null, by default the microservice will return all buildings (within the stated limit), which can be further refined through the filterdata field for more sophisticated queries. - example: "2020/7/7T20:29:14.280Z" + example: "SD" default: false - in: query name: offset From bce6f62c37ed0b8393a51a6baa5d4a6da6bea887 Mon Sep 17 00:00:00 2001 From: Mohamed Luqman <57977684+mohamedSent@users.noreply.github.com> Date: Fri, 19 Feb 2021 15:04:38 +0530 Subject: [PATCH 436/792] Update ihi_data_pointcloud.yaml --- data/ihi_data_pointcloud.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/data/ihi_data_pointcloud.yaml b/data/ihi_data_pointcloud.yaml index 3d03856eb..746badda9 100644 --- a/data/ihi_data_pointcloud.yaml +++ b/data/ihi_data_pointcloud.yaml @@ -3,7 +3,7 @@ info: title: IHI Pointcloud Data x-subscribelink: ihi_data description: |+ - This microservice returns information on Ishikawajima-Harima Heavy Industries(IHI) Pointcloud Data which includes the 3DLR Location of Boon Lay Way-Yuan Ching Road, Singapore. The Data comprises all the vehicle detection and does contain any pedestrian data. The IHI LiDAR programme makes selected public and non-public datasets available to developers and companies to improve their service offerings to benefit the lives of Singapore citizens. Sentient.io is proud to partner with IHI to manage and facilitate the sharing of data for the LiDAR Programme. + This microservice returns information on Ishikawajima-Harima Heavy Industries(IHI) Pointcloud Data which includes the 3DLR Location of Boon Lay Way-Yuan Ching Road, Singapore. The Data comprises all the vehicle detection and does not contain any pedestrian data. The IHI LiDAR programme makes selected public and non-public datasets available to developers and companies to improve their service offerings to benefit the lives of Singapore citizens. Sentient.io is proud to partner with IHI to manage and facilitate the sharing of data for the LiDAR Programme. **Note:** As this microservice uses the GET method, developers using this microservice must remember to have their app encode all the input values to be URL friendly (i.e. all spaces and special characters must be replaced). Here’s a reference on [URL encoding](https://www.w3schools.com/tags/ref_urlencode.ASP). From d855a62162235c11298e05658cb4d2f61f4d9fa4 Mon Sep 17 00:00:00 2001 From: Mohamed Luqman <57977684+mohamedSent@users.noreply.github.com> Date: Mon, 22 Feb 2021 09:57:31 +0530 Subject: [PATCH 437/792] Update ihi_data_pointcloud.yaml --- data/ihi_data_pointcloud.yaml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/data/ihi_data_pointcloud.yaml b/data/ihi_data_pointcloud.yaml index 746badda9..9277cc3f2 100644 --- a/data/ihi_data_pointcloud.yaml +++ b/data/ihi_data_pointcloud.yaml @@ -37,7 +37,7 @@ info: A match type is a match operator nested within a filter type that fine-tunes the matching condition of the text search. The supported match types are: * **match** - Search within a full text field for a single word - > {"match":{"dataclass":"SD"}} + > {"filter":[{"match":{"dataclass": "SD"}}]} * **match_phrase** - Search within a full text field > {"match_phrase":{"seqno":39736}} * **match_phrase_prefix** - Search within a full text field with prefix @@ -74,7 +74,7 @@ info: > {"filter":[{"match":{"street":"tampines street 41"}},{"match":{"block":"423"}},{"terms":{"age_group_id":[6,7,8]}}]} - 2. **Search for the different types of cars like Motorcycle, Normal car, Large car of dataclass "SD" in detected time of "2020-7-7T19:19:39.985Z".** + 2. **Search for the different types of vehicles like Motorcycle, Normal car, Large car of dataclass "SD" in detected time of "2020-7-7T19:19:39.985Z".** Using a filterdata only: > {"filter":[{"terms":{"identify":[10,11,12]}},{"match":{"dataclass":"SD"}},{"terms":{"detecttime":"2020-7-7T19:19:39.985Z"}}]} From 2c2982525e5790ceb698e0d217869547b5c2ed13 Mon Sep 17 00:00:00 2001 From: Mohamed Luqman <57977684+mohamedSent@users.noreply.github.com> Date: Mon, 22 Feb 2021 10:13:13 +0530 Subject: [PATCH 438/792] Update ihi_data_pointcloud.yaml --- data/ihi_data_pointcloud.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/data/ihi_data_pointcloud.yaml b/data/ihi_data_pointcloud.yaml index 9277cc3f2..25e42e8e5 100644 --- a/data/ihi_data_pointcloud.yaml +++ b/data/ihi_data_pointcloud.yaml @@ -39,7 +39,7 @@ info: * **match** - Search within a full text field for a single word > {"filter":[{"match":{"dataclass": "SD"}}]} * **match_phrase** - Search within a full text field - > {"match_phrase":{"seqno":39736}} + > {"filter":[{"match_phrase":{"targetidx": "0x1451"}}]} * **match_phrase_prefix** - Search within a full text field with prefix > {"match_phrase_prefix":{"originid":"0x145D"}} * **term** - Returns results that contain an exact term in a provided field From 7cdeae98047d4ae5417b609bdfd3caca8f176d75 Mon Sep 17 00:00:00 2001 From: Mohamed Luqman <57977684+mohamedSent@users.noreply.github.com> Date: Mon, 22 Feb 2021 10:29:22 +0530 Subject: [PATCH 439/792] Update ihi_data_pointcloud.yaml --- data/ihi_data_pointcloud.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/data/ihi_data_pointcloud.yaml b/data/ihi_data_pointcloud.yaml index 25e42e8e5..28deb60b2 100644 --- a/data/ihi_data_pointcloud.yaml +++ b/data/ihi_data_pointcloud.yaml @@ -41,7 +41,7 @@ info: * **match_phrase** - Search within a full text field > {"filter":[{"match_phrase":{"targetidx": "0x1451"}}]} * **match_phrase_prefix** - Search within a full text field with prefix - > {"match_phrase_prefix":{"originid":"0x145D"}} + > {"filter":[{"match_phrase_prefix":{"originid":"0x145D"}}]} * **term** - Returns results that contain an exact term in a provided field > {"term":{"situation":"0x02"}} * **terms** - Returns results that contain one or more exact terms in a provided field From 2413e5139f65ae19e34be2c384cf2105a2ca60fa Mon Sep 17 00:00:00 2001 From: Mohamed Luqman <57977684+mohamedSent@users.noreply.github.com> Date: Mon, 22 Feb 2021 10:33:17 +0530 Subject: [PATCH 440/792] Update ihi_data_pointcloud.yaml --- data/ihi_data_pointcloud.yaml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/data/ihi_data_pointcloud.yaml b/data/ihi_data_pointcloud.yaml index 28deb60b2..024231395 100644 --- a/data/ihi_data_pointcloud.yaml +++ b/data/ihi_data_pointcloud.yaml @@ -43,9 +43,9 @@ info: * **match_phrase_prefix** - Search within a full text field with prefix > {"filter":[{"match_phrase_prefix":{"originid":"0x145D"}}]} * **term** - Returns results that contain an exact term in a provided field - > {"term":{"situation":"0x02"}} + > {"filter":[{"term":{"situation":"0x02"}}]} * **terms** - Returns results that contain one or more exact terms in a provided field - > {"terms":{"identify":[10,11,12]}} + > {"filter":[{"terms":{"identify":[10,11,12]}}]} * **range** - Returns results that contain terms within a stipulated range From 868d0a5e75abac216ac64bce288ce280d042e349 Mon Sep 17 00:00:00 2001 From: Mohamed Luqman <57977684+mohamedSent@users.noreply.github.com> Date: Mon, 22 Feb 2021 11:08:21 +0530 Subject: [PATCH 441/792] Update ihi_data_pointcloud.yaml --- data/ihi_data_pointcloud.yaml | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/data/ihi_data_pointcloud.yaml b/data/ihi_data_pointcloud.yaml index 024231395..bee142817 100644 --- a/data/ihi_data_pointcloud.yaml +++ b/data/ihi_data_pointcloud.yaml @@ -49,13 +49,13 @@ info: * **range** - Returns results that contain terms within a stipulated range - > {"range":{"residents":{"gte":10}}} - > {"range":{"residents":{"lte":50}}} - > {"range":{"residents":{"gte":10,"lte":50}}} + > {"filter":[{"range":{"detecttime":{"gte":"2020-7-7T18:28:45.365Z"}}}]} + > {"filter":[{"range":{"detecttime":{"lte":"2020-7-7T19:19:39.985Z"}}}]} + > {"filter":[{"range":{"detecttime":{"gte":"2020-7-7T18:28:45.365Z","lte":"2020-7-7T19:19:39.985Z"}}}]} * **exists** - Returns results that contain any indexed value for a field - > {"exists":{ "field":"identify"}} + > {"filter":[{"terms":{"exists":{ "field":"identify"}}]} For a more detailed guide to match types, [refer to this](https://www.elastic.co/guide/en/elasticsearch/reference/7.9/term-level-queries.html). **Forming sophisticated queries using combinations of filter types (in JSON)** From 1324a12c1772c2adf0c0a2a2d8122d1d4d325d2e Mon Sep 17 00:00:00 2001 From: Mohamed Luqman <57977684+mohamedSent@users.noreply.github.com> Date: Mon, 22 Feb 2021 11:17:29 +0530 Subject: [PATCH 442/792] Update ihi_data_pointcloud.yaml --- data/ihi_data_pointcloud.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/data/ihi_data_pointcloud.yaml b/data/ihi_data_pointcloud.yaml index bee142817..54f269c2e 100644 --- a/data/ihi_data_pointcloud.yaml +++ b/data/ihi_data_pointcloud.yaml @@ -55,7 +55,7 @@ info: * **exists** - Returns results that contain any indexed value for a field - > {"filter":[{"terms":{"exists":{ "field":"identify"}}]} + > {"filter":[{"exists":{ "field":"identify"}}]} For a more detailed guide to match types, [refer to this](https://www.elastic.co/guide/en/elasticsearch/reference/7.9/term-level-queries.html). **Forming sophisticated queries using combinations of filter types (in JSON)** From ba7a44e18a1596d3ca3494a3a8859008ad42f1c8 Mon Sep 17 00:00:00 2001 From: Mohamed Luqman <57977684+mohamedSent@users.noreply.github.com> Date: Mon, 22 Feb 2021 12:03:54 +0530 Subject: [PATCH 443/792] Update ihi_data_pointcloud.yaml --- data/ihi_data_pointcloud.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/data/ihi_data_pointcloud.yaml b/data/ihi_data_pointcloud.yaml index 54f269c2e..ab7f2806b 100644 --- a/data/ihi_data_pointcloud.yaml +++ b/data/ihi_data_pointcloud.yaml @@ -22,7 +22,7 @@ info: > {"must":[{"match_phrase":{"identify":10}}]} * **must_not** - All of the stated conditions must not match. Equivalent to a NOT operator. - > {"must_not":[{"match":{"jamlane":0}}]} + > {"must_not":[{"match":{"identify":10}}]} * **should** - At least one of the stated conditions should match. Equivalent to an OR operator. > {"should":[{"match_phrase":{"seqno":39736}}]} From 6340cc803bfc223a691f24daf6e6f72be74c9ddd Mon Sep 17 00:00:00 2001 From: Mohamed Luqman <57977684+mohamedSent@users.noreply.github.com> Date: Mon, 22 Feb 2021 12:13:41 +0530 Subject: [PATCH 444/792] Update ihi_data_pointcloud.yaml --- data/ihi_data_pointcloud.yaml | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/data/ihi_data_pointcloud.yaml b/data/ihi_data_pointcloud.yaml index ab7f2806b..fcabff750 100644 --- a/data/ihi_data_pointcloud.yaml +++ b/data/ihi_data_pointcloud.yaml @@ -62,10 +62,10 @@ info: Multiple filter types can be combined together in one query (written in JSON format) to form a very sophisticated query. Here’s one example below: > { - > "must":[{"match_phrase":{"street":"serangoon+central"}}], - > "filter":[{"range":{"residents":{"gte":10}}}], - > "should":[{"match":{"gender":"male"}}], - > "must_not":[{"match":{"age_group_id":"2"}}] + > "must":[{"match_phrase":{"targetidx": "0x1451"}}], + > "filter":[{"exists":{ "field": "detecttime"}}], + > "should":[{"match_phrase":{"seqno":39736}}], + > "must_not":[{"match":{"identify":10}}] > } **Sample Queries Based on Use Cases** From d2e923f4a1037b94f1019d1a52d046d5a86168f9 Mon Sep 17 00:00:00 2001 From: Mohamed Luqman <57977684+mohamedSent@users.noreply.github.com> Date: Mon, 22 Feb 2021 12:21:24 +0530 Subject: [PATCH 445/792] Update ihi_data_pointcloud.yaml --- data/ihi_data_pointcloud.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/data/ihi_data_pointcloud.yaml b/data/ihi_data_pointcloud.yaml index fcabff750..11425c5da 100644 --- a/data/ihi_data_pointcloud.yaml +++ b/data/ihi_data_pointcloud.yaml @@ -77,7 +77,7 @@ info: 2. **Search for the different types of vehicles like Motorcycle, Normal car, Large car of dataclass "SD" in detected time of "2020-7-7T19:19:39.985Z".** Using a filterdata only: - > {"filter":[{"terms":{"identify":[10,11,12]}},{"match":{"dataclass":"SD"}},{"terms":{"detecttime":"2020-7-7T19:19:39.985Z"}}]} + > {"filter":[{"match":{"dataclass": "SD"}},{"match":{"situation":"0x02"}},{"terms":{"identify":[10,11,12]}}]} version: '0.1.0' servers: - url: 'https://api.sentient.io' From b2594982b06b7654cc38b56c1bc4eaa01db3d17a Mon Sep 17 00:00:00 2001 From: Mohamed Luqman <57977684+mohamedSent@users.noreply.github.com> Date: Mon, 22 Feb 2021 12:30:18 +0530 Subject: [PATCH 446/792] Update ihi_data_pointcloud.yaml --- data/ihi_data_pointcloud.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/data/ihi_data_pointcloud.yaml b/data/ihi_data_pointcloud.yaml index 11425c5da..03dfcd028 100644 --- a/data/ihi_data_pointcloud.yaml +++ b/data/ihi_data_pointcloud.yaml @@ -74,7 +74,7 @@ info: > {"filter":[{"match":{"street":"tampines street 41"}},{"match":{"block":"423"}},{"terms":{"age_group_id":[6,7,8]}}]} - 2. **Search for the different types of vehicles like Motorcycle, Normal car, Large car of dataclass "SD" in detected time of "2020-7-7T19:19:39.985Z".** + 2. **Search for the different types of vehicles like Motorcycle, Normal car, Large car of dataclass "SD" in the situation “0x02”.** Using a filterdata only: > {"filter":[{"match":{"dataclass": "SD"}},{"match":{"situation":"0x02"}},{"terms":{"identify":[10,11,12]}}]} From 934a4ca7c8d40f7d8abbc32f1f84b350fa0cb6c8 Mon Sep 17 00:00:00 2001 From: Mohamed Luqman <57977684+mohamedSent@users.noreply.github.com> Date: Mon, 22 Feb 2021 12:46:24 +0530 Subject: [PATCH 447/792] Update ihi_data_pointcloud.yaml --- data/ihi_data_pointcloud.yaml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/data/ihi_data_pointcloud.yaml b/data/ihi_data_pointcloud.yaml index 03dfcd028..eeb22bae8 100644 --- a/data/ihi_data_pointcloud.yaml +++ b/data/ihi_data_pointcloud.yaml @@ -69,10 +69,10 @@ info: > } **Sample Queries Based on Use Cases** - 1. **Search for the number of elderly residents staying at Blk 423, Tampines Street 41 filter by age and gender.** + 1. **Search for the number of vehicles crossed in jamlane 'zero' with the height of 261 of different vehicle types.** Using a filterdata only: - > {"filter":[{"match":{"street":"tampines street 41"}},{"match":{"block":"423"}},{"terms":{"age_group_id":[6,7,8]}}]} + > {"filter":[{"match":{"height": 261}},{"match":{"jamlane":0}},{"terms":{"identify":[10,11,12]}}]} 2. **Search for the different types of vehicles like Motorcycle, Normal car, Large car of dataclass "SD" in the situation “0x02”.** Using a filterdata only: From 4416a82291cf03e5666ef02bc516dc3067cbae06 Mon Sep 17 00:00:00 2001 From: rameshsentient <51635015+rameshsentient@users.noreply.github.com> Date: Mon, 22 Feb 2021 13:50:57 +0530 Subject: [PATCH 448/792] Update asr_with_voice_activity_detection_eng_sg.yaml --- voice/asr_with_voice_activity_detection_eng_sg.yaml | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/voice/asr_with_voice_activity_detection_eng_sg.yaml b/voice/asr_with_voice_activity_detection_eng_sg.yaml index 2f1da5d6a..815cbfdbe 100644 --- a/voice/asr_with_voice_activity_detection_eng_sg.yaml +++ b/voice/asr_with_voice_activity_detection_eng_sg.yaml @@ -24,7 +24,7 @@ paths: - v0.1.0 responses: '200': - description: success response + description: OK content: application/json: schema: @@ -65,13 +65,13 @@ paths: schema: $ref: '#/components/schemas/inputfieldmissing' '413': - description: Input Limit Exceeded + description: Payload Too Large content: application/json: schema: $ref: '#/components/schemas/inputlimitexceeded' '415': - description: Invalid Input + description: Unsupported Media Type content: application/json: schema: From 6f51031cb0d3673d17ebb986c32cd557fd0cfb42 Mon Sep 17 00:00:00 2001 From: rameshsentient <51635015+rameshsentient@users.noreply.github.com> Date: Mon, 22 Feb 2021 13:51:43 +0530 Subject: [PATCH 449/792] Update asr_with_voice_activity_detection_eng_sg_v1.0.yaml --- voice/asr_with_voice_activity_detection_eng_sg_v1.0.yaml | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/voice/asr_with_voice_activity_detection_eng_sg_v1.0.yaml b/voice/asr_with_voice_activity_detection_eng_sg_v1.0.yaml index 7e10921d5..037b73ab1 100644 --- a/voice/asr_with_voice_activity_detection_eng_sg_v1.0.yaml +++ b/voice/asr_with_voice_activity_detection_eng_sg_v1.0.yaml @@ -23,7 +23,7 @@ paths: - v1.1.0 responses: '200': - description: success response + description: Ok content: application/json: schema: @@ -68,13 +68,13 @@ paths: schema: $ref: '#/components/schemas/inputfieldmissing' '413': - description: Input Limit Exceeded + description: Payload Too Large content: application/json: schema: $ref: '#/components/schemas/inputlimitexceeded' '415': - description: Invalid Input + description: Unsupported Media Type content: application/json: schema: From ec8b5334a55f482900869f87265cb8b1e5bbba2d Mon Sep 17 00:00:00 2001 From: rameshsentient <51635015+rameshsentient@users.noreply.github.com> Date: Mon, 22 Feb 2021 13:58:44 +0530 Subject: [PATCH 450/792] Update automatic_speech_recognition_chi_sg.yaml --- voice/automatic_speech_recognition_chi_sg.yaml | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/voice/automatic_speech_recognition_chi_sg.yaml b/voice/automatic_speech_recognition_chi_sg.yaml index e5e8aaff7..1d69f1d26 100644 --- a/voice/automatic_speech_recognition_chi_sg.yaml +++ b/voice/automatic_speech_recognition_chi_sg.yaml @@ -31,7 +31,7 @@ paths: - v0.1.1 responses: '200': - description: success response + description: Ok content: application/json: schema: @@ -70,13 +70,13 @@ paths: schema: $ref: '#/components/schemas/inputfieldmissing' '413': - description: Input Limit Exceeded + description: Payload Too Large content: application/json: schema: $ref: '#/components/schemas/inputlimitexceeded' '415': - description: Invalid Input + description: Unsupported Media Type content: application/json: schema: From a80bad94d4ddd7bfb2eb95edbf382503cfadda61 Mon Sep 17 00:00:00 2001 From: rameshsentient <51635015+rameshsentient@users.noreply.github.com> Date: Mon, 22 Feb 2021 14:02:49 +0530 Subject: [PATCH 451/792] Update automatic_speech_recognition_eng_sg.yaml --- voice/automatic_speech_recognition_eng_sg.yaml | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/voice/automatic_speech_recognition_eng_sg.yaml b/voice/automatic_speech_recognition_eng_sg.yaml index 841a18456..49661f4ae 100644 --- a/voice/automatic_speech_recognition_eng_sg.yaml +++ b/voice/automatic_speech_recognition_eng_sg.yaml @@ -24,7 +24,7 @@ paths: - v0.1.0 responses: '200': - description: success response + description: Ok content: application/json: schema: @@ -66,13 +66,13 @@ paths: schema: $ref: '#/components/schemas/inputfieldmissing' '413': - description: Input Limit Exceeded + description: Payload Too Large content: application/json: schema: $ref: '#/components/schemas/inputlimitexceeded' '415': - description: Invalid Input + description: Unsupported Media Type content: application/json: schema: From d63a11a9567c803124ff679faa835b3580d0a91e Mon Sep 17 00:00:00 2001 From: rameshsentient <51635015+rameshsentient@users.noreply.github.com> Date: Mon, 22 Feb 2021 14:07:57 +0530 Subject: [PATCH 452/792] Update automatic_speech_recognition_eng_sg_v1.0.yaml --- voice/automatic_speech_recognition_eng_sg_v1.0.yaml | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/voice/automatic_speech_recognition_eng_sg_v1.0.yaml b/voice/automatic_speech_recognition_eng_sg_v1.0.yaml index 8565f751b..13b23116f 100644 --- a/voice/automatic_speech_recognition_eng_sg_v1.0.yaml +++ b/voice/automatic_speech_recognition_eng_sg_v1.0.yaml @@ -24,7 +24,7 @@ paths: - v1.1.0 responses: '200': - description: success response + description: Ok content: application/json: schema: @@ -69,13 +69,13 @@ paths: schema: $ref: '#/components/schemas/inputfieldmissing' '413': - description: Input Limit Exceeded + description: Payload Too Large content: application/json: schema: $ref: '#/components/schemas/inputlimitexceeded' '415': - description: Invalid Input + description: Unsupported Media Type content: application/json: schema: From 4110da3f6ce5aff60c56bdbcc079f72128bd58cd Mon Sep 17 00:00:00 2001 From: rameshsentient <51635015+rameshsentient@users.noreply.github.com> Date: Mon, 22 Feb 2021 14:21:53 +0530 Subject: [PATCH 453/792] Update text-to-speech_chi.yaml --- voice/text-to-speech_chi.yaml | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/voice/text-to-speech_chi.yaml b/voice/text-to-speech_chi.yaml index 9b7fccfe3..3ef721736 100644 --- a/voice/text-to-speech_chi.yaml +++ b/voice/text-to-speech_chi.yaml @@ -28,7 +28,7 @@ paths: - v0.1.0 responses: '200': - description: success response + description: Ok content: application/json: schema: @@ -68,13 +68,13 @@ paths: schema: $ref: '#/components/schemas/inputfieldmissing' '413': - description: Input Limit Exceeded + description: Payload Too Large content: application/json: schema: $ref: '#/components/schemas/inputlimitexceeded' '415': - description: Invalid Input + description: Unsupported Media Type content: application/json: schema: From f4472bf7e8cafeb3ac7cda4bea966d3d4d036479 Mon Sep 17 00:00:00 2001 From: rameshsentient <51635015+rameshsentient@users.noreply.github.com> Date: Mon, 22 Feb 2021 14:23:41 +0530 Subject: [PATCH 454/792] Update text-to-speech_eng.yaml --- voice/text-to-speech_eng.yaml | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/voice/text-to-speech_eng.yaml b/voice/text-to-speech_eng.yaml index b40128aff..2e11a025b 100644 --- a/voice/text-to-speech_eng.yaml +++ b/voice/text-to-speech_eng.yaml @@ -30,7 +30,7 @@ paths: - v0.1.0 responses: '200': - description: success response + description: Ok content: application/json: schema: @@ -70,13 +70,13 @@ paths: schema: $ref: '#/components/schemas/inputfieldmissing' '413': - description: Input Limit Exceeded + description: Payload Too Large content: application/json: schema: $ref: '#/components/schemas/inputlimitexceeded' '415': - description: Invalid Input + description: Unsupported Media Type content: application/json: schema: From 5dfdf3398101d337241e9562aac4ca98fa86c8ef Mon Sep 17 00:00:00 2001 From: rameshsentient <51635015+rameshsentient@users.noreply.github.com> Date: Mon, 22 Feb 2021 14:33:03 +0530 Subject: [PATCH 455/792] Update voice_activity_detection_eng_v1.0.yaml --- voice/voice_activity_detection_eng_v1.0.yaml | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/voice/voice_activity_detection_eng_v1.0.yaml b/voice/voice_activity_detection_eng_v1.0.yaml index 24286f984..d761e2224 100644 --- a/voice/voice_activity_detection_eng_v1.0.yaml +++ b/voice/voice_activity_detection_eng_v1.0.yaml @@ -26,7 +26,7 @@ paths: - v1.0.0 responses: '200': - description: success response + description: Ok content: application/json: schema: @@ -68,13 +68,13 @@ paths: schema: $ref: '#/components/schemas/inputfieldmissing' '413': - description: Input Limit Exceeded + description: Payload Too Large content: application/json: schema: $ref: '#/components/schemas/inputlimitexceeded' '415': - description: Invalid Input + description: Unsupported Media Type content: application/json: schema: From bdd76bf884783e641fc77765cb5acbaa5ce9f2fa Mon Sep 17 00:00:00 2001 From: rameshsentient <51635015+rameshsentient@users.noreply.github.com> Date: Mon, 22 Feb 2021 14:34:16 +0530 Subject: [PATCH 456/792] Update voice_activity_detection_eng.yaml --- voice/voice_activity_detection_eng.yaml | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/voice/voice_activity_detection_eng.yaml b/voice/voice_activity_detection_eng.yaml index 814f318c0..f1906f013 100644 --- a/voice/voice_activity_detection_eng.yaml +++ b/voice/voice_activity_detection_eng.yaml @@ -29,7 +29,7 @@ paths: - v0.1.0 responses: '200': - description: success response + description: Ok content: application/json: schema: @@ -67,14 +67,14 @@ paths: application/json: schema: $ref: '#/components/schemas/inputfieldmissing' - '420': - description: Input Limit Exceeded + '413': + description: Payload Too Large content: application/json: schema: $ref: '#/components/schemas/inputlimitexceeded' - '422': - description: Invalid Input + '415': + description: Unsupported Media Type content: application/json: schema: From e61ec96ee6a9d80a249f96f715ef3acff48c409b Mon Sep 17 00:00:00 2001 From: rameshsentient <51635015+rameshsentient@users.noreply.github.com> Date: Mon, 22 Feb 2021 14:55:04 +0530 Subject: [PATCH 457/792] Update inverse_text_normalisation_eng.yaml --- nlp/inverse_text_normalisation_eng.yaml | 26 +++++++++++-------------- 1 file changed, 11 insertions(+), 15 deletions(-) diff --git a/nlp/inverse_text_normalisation_eng.yaml b/nlp/inverse_text_normalisation_eng.yaml index 10520a858..170e0b83b 100644 --- a/nlp/inverse_text_normalisation_eng.yaml +++ b/nlp/inverse_text_normalisation_eng.yaml @@ -72,13 +72,13 @@ paths: schema: $ref: '#/components/schemas/inputfieldmissing' '413': - description: Input Limit Exceeded + description: Payload Too Large content: application/json: schema: $ref: '#/components/schemas/inputlimitexceeded' '415': - description: Invalid Input + description: Unsupported Media Type content: application/json: schema: @@ -204,21 +204,17 @@ components: example: Published Date - Mar 24, 2020 description: Initial version release input: - type: array + type: object required: - text - items: - type: object - properties: - text: - x-name: text - type: string - default: true - example: Apple said the project-financing fund was the first of its kind Real estate developers often secure bonds for affordable housing development but must service the debt during construction until the houses are built and start to generate revenue Apple and state officials hope to provide bridge financing during construction at rates below those from commercial lenders - description: |+ - Input text. - - Supported formats: ASCII only + properties: + text: + x-name: text + type: string + default: true + example: Apple said the project-financing fund was the first of its kind Real estate developers often secure bonds for affordable housing development but must service the debt during construction until the houses are built and start to generate revenue Apple and state officials hope to provide bridge financing during construction at rates below those from commercial lenders + description: |+ + Input text securitySchemes: APIAuthorizer: type: apiKey From 41a3a52861704cbdbce7fd25028206e6c22856c8 Mon Sep 17 00:00:00 2001 From: rameshsentient <51635015+rameshsentient@users.noreply.github.com> Date: Mon, 22 Feb 2021 14:55:09 +0530 Subject: [PATCH 458/792] Update inverse_text_normalisation_eng_v1.0.yaml --- nlp/inverse_text_normalisation_eng_v1.0.yaml | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/nlp/inverse_text_normalisation_eng_v1.0.yaml b/nlp/inverse_text_normalisation_eng_v1.0.yaml index 63e1e1e8b..6bace4d63 100644 --- a/nlp/inverse_text_normalisation_eng_v1.0.yaml +++ b/nlp/inverse_text_normalisation_eng_v1.0.yaml @@ -24,7 +24,7 @@ paths: - v1.0.0 responses: '200': - description: success response + description: Ok content: application/json: schema: @@ -75,13 +75,13 @@ paths: schema: $ref: '#/components/schemas/inputfieldmissing' '413': - description: Input Limit Exceeded + description: Payload Too Large content: application/json: schema: $ref: '#/components/schemas/inputlimitexceeded' '415': - description: Invalid Input + description: Unsupported Media Type content: application/json: schema: From 4b0948c30c7f5320245790908858b99ac38e38da Mon Sep 17 00:00:00 2001 From: rameshsentient <51635015+rameshsentient@users.noreply.github.com> Date: Mon, 22 Feb 2021 14:59:58 +0530 Subject: [PATCH 459/792] Update inverse_text_normalisation_eng.yaml --- nlp/inverse_text_normalisation_eng.yaml | 22 +++++++++++++--------- 1 file changed, 13 insertions(+), 9 deletions(-) diff --git a/nlp/inverse_text_normalisation_eng.yaml b/nlp/inverse_text_normalisation_eng.yaml index 170e0b83b..365aacf13 100644 --- a/nlp/inverse_text_normalisation_eng.yaml +++ b/nlp/inverse_text_normalisation_eng.yaml @@ -204,17 +204,21 @@ components: example: Published Date - Mar 24, 2020 description: Initial version release input: - type: object + type: array required: - text - properties: - text: - x-name: text - type: string - default: true - example: Apple said the project-financing fund was the first of its kind Real estate developers often secure bonds for affordable housing development but must service the debt during construction until the houses are built and start to generate revenue Apple and state officials hope to provide bridge financing during construction at rates below those from commercial lenders - description: |+ - Input text + items: + type: object + properties: + text: + x-name: text + type: string + default: true + example: Apple said the project-financing fund was the first of its kind Real estate developers often secure bonds for affordable housing development but must service the debt during construction until the houses are built and start to generate revenue Apple and state officials hope to provide bridge financing during construction at rates below those from commercial lenders + description: |+ + Input text. + + Supported formats: ASCII only securitySchemes: APIAuthorizer: type: apiKey From cb556787f03cd6c8f420ab39700640826e4f35d9 Mon Sep 17 00:00:00 2001 From: rameshsentient <51635015+rameshsentient@users.noreply.github.com> Date: Mon, 22 Feb 2021 15:36:11 +0530 Subject: [PATCH 460/792] Update inverse_text_normalisation_eng.yaml --- nlp/inverse_text_normalisation_eng.yaml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/nlp/inverse_text_normalisation_eng.yaml b/nlp/inverse_text_normalisation_eng.yaml index 365aacf13..10520a858 100644 --- a/nlp/inverse_text_normalisation_eng.yaml +++ b/nlp/inverse_text_normalisation_eng.yaml @@ -72,13 +72,13 @@ paths: schema: $ref: '#/components/schemas/inputfieldmissing' '413': - description: Payload Too Large + description: Input Limit Exceeded content: application/json: schema: $ref: '#/components/schemas/inputlimitexceeded' '415': - description: Unsupported Media Type + description: Invalid Input content: application/json: schema: From d61dd56d3877eecf97ff776bd3d3fc4c0fe04139 Mon Sep 17 00:00:00 2001 From: rameshsentient <51635015+rameshsentient@users.noreply.github.com> Date: Mon, 22 Feb 2021 15:43:19 +0530 Subject: [PATCH 461/792] Update named-entity_recognition_eng.yaml --- nlp/named-entity_recognition_eng.yaml | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/nlp/named-entity_recognition_eng.yaml b/nlp/named-entity_recognition_eng.yaml index 1a81a8283..8a48483b2 100644 --- a/nlp/named-entity_recognition_eng.yaml +++ b/nlp/named-entity_recognition_eng.yaml @@ -30,7 +30,7 @@ paths: - v0.1.0 responses: '200': - description: success response + description: Ok content: application/json: schema: @@ -86,13 +86,13 @@ paths: schema: $ref: '#/components/schemas/inputfieldmissing' '413': - description: Input Limit Exceeded + description: Payload Too Large content: application/json: schema: $ref: '#/components/schemas/inputlimitexceeded' '415': - description: Invalid Input + description: Unsupported Media Type content: application/json: schema: From 07c91476070baa35c4d16ca7a58c223645d793a3 Mon Sep 17 00:00:00 2001 From: rameshsentient <51635015+rameshsentient@users.noreply.github.com> Date: Mon, 22 Feb 2021 15:44:07 +0530 Subject: [PATCH 462/792] Update named-entity_recognition_eng_v1.0.yaml --- nlp/named-entity_recognition_eng_v1.0.yaml | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/nlp/named-entity_recognition_eng_v1.0.yaml b/nlp/named-entity_recognition_eng_v1.0.yaml index b5a977bcf..f44700f1f 100644 --- a/nlp/named-entity_recognition_eng_v1.0.yaml +++ b/nlp/named-entity_recognition_eng_v1.0.yaml @@ -28,7 +28,7 @@ paths: - v1.0.0 responses: '200': - description: success response + description: Ok content: application/json: schema: @@ -65,13 +65,13 @@ paths: schema: $ref: '#/components/schemas/inputfieldmissing' '413': - description: Input Limit Exceeded + description: Payload Too Large content: application/json: schema: $ref: '#/components/schemas/inputlimitexceeded' '415': - description: Invalid Input + description: Unsupported Media Type content: application/json: schema: From 7b27fbc42fadc65c4a2c41e3741f3ab035a6c2ec Mon Sep 17 00:00:00 2001 From: rameshsentient <51635015+rameshsentient@users.noreply.github.com> Date: Mon, 22 Feb 2021 15:47:59 +0530 Subject: [PATCH 463/792] Update inverse_text_normalisation_eng.yaml --- nlp/inverse_text_normalisation_eng.yaml | 15 ++++++++------- 1 file changed, 8 insertions(+), 7 deletions(-) diff --git a/nlp/inverse_text_normalisation_eng.yaml b/nlp/inverse_text_normalisation_eng.yaml index 10520a858..46d57cad2 100644 --- a/nlp/inverse_text_normalisation_eng.yaml +++ b/nlp/inverse_text_normalisation_eng.yaml @@ -208,13 +208,14 @@ components: required: - text items: - type: object - properties: - text: - x-name: text - type: string - default: true - example: Apple said the project-financing fund was the first of its kind Real estate developers often secure bonds for affordable housing development but must service the debt during construction until the houses are built and start to generate revenue Apple and state officials hope to provide bridge financing during construction at rates below those from commercial lenders + oneOf: + - type: object + properties: + text: + x-name: text + type: string + default: true + example: Apple said the project-financing fund was the first of its kind Real estate developers often secure bonds for affordable housing development but must service the debt during construction until the houses are built and start to generate revenue Apple and state officials hope to provide bridge financing during construction at rates below those from commercial lenders description: |+ Input text. From cb8b5746dea69ed9a2c3d9a0fc08473018d2c7bc Mon Sep 17 00:00:00 2001 From: rameshsentient <51635015+rameshsentient@users.noreply.github.com> Date: Mon, 22 Feb 2021 16:32:31 +0530 Subject: [PATCH 464/792] Update named-entity_recognition_jp_v1.0.yaml --- nlp/named-entity_recognition_jp_v1.0.yaml | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/nlp/named-entity_recognition_jp_v1.0.yaml b/nlp/named-entity_recognition_jp_v1.0.yaml index 289adcfa0..675b04240 100644 --- a/nlp/named-entity_recognition_jp_v1.0.yaml +++ b/nlp/named-entity_recognition_jp_v1.0.yaml @@ -28,7 +28,7 @@ paths: - v1.0.0 responses: '200': - description: success response + description: Ok content: application/json: schema: @@ -91,13 +91,13 @@ paths: schema: $ref: '#/components/schemas/inputfieldmissing' '413': - description: Input Limit Exceeded + description: Payload Too Large content: application/json: schema: $ref: '#/components/schemas/inputlimitexceeded' '415': - description: Invalid Input + description: Unsupported Media Type content: application/json: schema: From 52fd3890d8af12a8794c8aafaf905894057d33e8 Mon Sep 17 00:00:00 2001 From: rameshsentient <51635015+rameshsentient@users.noreply.github.com> Date: Mon, 22 Feb 2021 16:33:30 +0530 Subject: [PATCH 465/792] Update named-entity_recognition_jp.yaml --- nlp/named-entity_recognition_jp.yaml | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/nlp/named-entity_recognition_jp.yaml b/nlp/named-entity_recognition_jp.yaml index c97d551bc..58364ed2f 100644 --- a/nlp/named-entity_recognition_jp.yaml +++ b/nlp/named-entity_recognition_jp.yaml @@ -28,7 +28,7 @@ paths: - v0.1.0 responses: '200': - description: success response + description: Ok content: application/json: schema: @@ -80,13 +80,13 @@ paths: schema: $ref: '#/components/schemas/inputfieldmissing' '413': - description: Input Limit Exceeded + description: Payload Too Large content: application/json: schema: $ref: '#/components/schemas/inputlimitexceeded' '415': - description: Invalid Input + description: Unsupported Media Type content: application/json: schema: From f539697b258ffd90aca103e197ea14be216221cb Mon Sep 17 00:00:00 2001 From: rameshsentient <51635015+rameshsentient@users.noreply.github.com> Date: Mon, 22 Feb 2021 16:36:05 +0530 Subject: [PATCH 466/792] Update named-entity_recognition_thai.yaml --- nlp/named-entity_recognition_thai.yaml | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/nlp/named-entity_recognition_thai.yaml b/nlp/named-entity_recognition_thai.yaml index 46968c45a..23790913b 100644 --- a/nlp/named-entity_recognition_thai.yaml +++ b/nlp/named-entity_recognition_thai.yaml @@ -28,7 +28,7 @@ paths: - v0.1.0 responses: '200': - description: success response + description: Ok content: application/json: schema: @@ -70,13 +70,13 @@ paths: schema: $ref: '#/components/schemas/inputfieldmissing' '413': - description: Input Limit Exceeded + description: Payload Too Large content: application/json: schema: $ref: '#/components/schemas/inputlimitexceeded' '415': - description: Invalid Input + description: Unsupported Media Type content: application/json: schema: From a2f79c48cadb5b66a8abaf3b844433afce68437a Mon Sep 17 00:00:00 2001 From: rameshsentient <51635015+rameshsentient@users.noreply.github.com> Date: Mon, 22 Feb 2021 16:36:47 +0530 Subject: [PATCH 467/792] Update named-entity_recognition_thai_v1.0.yaml --- nlp/named-entity_recognition_thai_v1.0.yaml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/nlp/named-entity_recognition_thai_v1.0.yaml b/nlp/named-entity_recognition_thai_v1.0.yaml index 0578e3883..427d29a5c 100644 --- a/nlp/named-entity_recognition_thai_v1.0.yaml +++ b/nlp/named-entity_recognition_thai_v1.0.yaml @@ -87,13 +87,13 @@ paths: schema: $ref: '#/components/schemas/inputfieldmissing' '413': - description: Input Limit Exceeded + description: Payload Too Large content: application/json: schema: $ref: '#/components/schemas/inputlimitexceeded' '415': - description: Invalid Input + description: Unsupported Media Type content: application/json: schema: From 3abc39a18987384c79a087750cf2876677284e24 Mon Sep 17 00:00:00 2001 From: rameshsentient <51635015+rameshsentient@users.noreply.github.com> Date: Mon, 22 Feb 2021 16:40:01 +0530 Subject: [PATCH 468/792] Update named-entity_recognition_thai_v1.0.yaml --- nlp/named-entity_recognition_thai_v1.0.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/nlp/named-entity_recognition_thai_v1.0.yaml b/nlp/named-entity_recognition_thai_v1.0.yaml index 427d29a5c..428a47cc4 100644 --- a/nlp/named-entity_recognition_thai_v1.0.yaml +++ b/nlp/named-entity_recognition_thai_v1.0.yaml @@ -30,7 +30,7 @@ paths: - v1.0.0 responses: '200': - description: success response + description: Ok content: application/json: schema: From 6873ddf4ac4bf3087f3ec865a82f902d2f87b617 Mon Sep 17 00:00:00 2001 From: rameshsentient <51635015+rameshsentient@users.noreply.github.com> Date: Mon, 22 Feb 2021 16:46:27 +0530 Subject: [PATCH 469/792] Update page_profiler_eng_v2.1.yaml --- nlp/page_profiler_eng_v2.1.yaml | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/nlp/page_profiler_eng_v2.1.yaml b/nlp/page_profiler_eng_v2.1.yaml index 5d3d6f532..0b3606c9a 100644 --- a/nlp/page_profiler_eng_v2.1.yaml +++ b/nlp/page_profiler_eng_v2.1.yaml @@ -25,7 +25,7 @@ - v2.1.1 responses: '200': - description: success response + description: Ok content: application/json: schema: @@ -62,13 +62,13 @@ schema: $ref: '#/components/schemas/inputfieldmissing' '413': - description: Not Found + description: Payload Too Large content: application/json: schema: $ref: '#/components/schemas/inputlimitexceeded' '415': - description: Invalid Input + description: Unsupported Media Type content: application/json: schema: @@ -204,7 +204,7 @@ properties: message: type: string - example: Invalid Input + example: Invalid input - Error in URL. status: type: string example: Failure From df0fec6a85b8657ce6ca78af76def60623ae3644 Mon Sep 17 00:00:00 2001 From: rameshsentient <51635015+rameshsentient@users.noreply.github.com> Date: Mon, 22 Feb 2021 16:49:28 +0530 Subject: [PATCH 470/792] Update page_profiler_jp.yaml --- nlp/page_profiler_jp.yaml | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/nlp/page_profiler_jp.yaml b/nlp/page_profiler_jp.yaml index 6b2f1a7e1..3a3559e91 100644 --- a/nlp/page_profiler_jp.yaml +++ b/nlp/page_profiler_jp.yaml @@ -26,7 +26,7 @@ - v1.1.0 responses: '200': - description: success response + description: Ok content: application/json: schema: @@ -89,13 +89,13 @@ schema: $ref: '#/components/schemas/inputfieldmissing' '413': - description: Input Limit Exceeded + description: Payload Too Large content: application/json: schema: $ref: '#/components/schemas/inputlimitexceeded' '415': - description: Invalid Input + description: Unsupported Media Type content: application/json: schema: @@ -239,7 +239,7 @@ properties: message: type: string - example: Invalid Input + example: Invalid input - Error in URL. status: type: string example: Failure From 90a64b8d9e6d5cb489bc9cb81b40e809ab891c52 Mon Sep 17 00:00:00 2001 From: rameshsentient <51635015+rameshsentient@users.noreply.github.com> Date: Mon, 22 Feb 2021 16:54:16 +0530 Subject: [PATCH 471/792] Update page_profiler_thai.yaml --- nlp/page_profiler_thai.yaml | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/nlp/page_profiler_thai.yaml b/nlp/page_profiler_thai.yaml index d1b1e94e3..8f1caf65a 100644 --- a/nlp/page_profiler_thai.yaml +++ b/nlp/page_profiler_thai.yaml @@ -26,7 +26,7 @@ - v1.1.0 responses: '200': - description: success response + description: Ok content: application/json: schema: @@ -95,13 +95,13 @@ schema: $ref: '#/components/schemas/inputfieldmissing' '413': - description: Input Limit Exceeded + description: Payload Too Large content: application/json: schema: $ref: '#/components/schemas/inputlimitexceeded' '415': - description: Invalid Input + description: Unsupported Media Type content: application/json: schema: @@ -259,7 +259,7 @@ properties: message: type: string - example: Invalid Input + example: Invalid input - Error in URL. status: type: string example: Failure From 4e0e3106a8387fd55b887bee8d1ab67c328a3790 Mon Sep 17 00:00:00 2001 From: rameshsentient <51635015+rameshsentient@users.noreply.github.com> Date: Mon, 22 Feb 2021 17:04:00 +0530 Subject: [PATCH 472/792] Update script_alignment.yaml --- nlp/script_alignment.yaml | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/nlp/script_alignment.yaml b/nlp/script_alignment.yaml index a01255526..a30bc698a 100644 --- a/nlp/script_alignment.yaml +++ b/nlp/script_alignment.yaml @@ -24,7 +24,7 @@ paths: - v0.1.0 responses: '200': - description: success response + description: Ok content: application/json: schema: @@ -61,13 +61,13 @@ paths: schema: $ref: '#/components/schemas/inputfieldmissing' '413': - description: Input Limit Exceeded + description: Payload Too Large content: application/json: schema: $ref: '#/components/schemas/inputlimitexceeded' '415': - description: Invalid Input + description: Unsupported Media Type content: application/json: schema: From 1d6766f1fd901b4dd90185e4c80343966c7d02a6 Mon Sep 17 00:00:00 2001 From: rameshsentient <51635015+rameshsentient@users.noreply.github.com> Date: Mon, 22 Feb 2021 17:04:41 +0530 Subject: [PATCH 473/792] Update script_alignment_v1.0.yaml --- nlp/script_alignment_v1.0.yaml | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/nlp/script_alignment_v1.0.yaml b/nlp/script_alignment_v1.0.yaml index c5df6824b..87ab7ef6f 100644 --- a/nlp/script_alignment_v1.0.yaml +++ b/nlp/script_alignment_v1.0.yaml @@ -24,7 +24,7 @@ paths: - v1.0.0 responses: '200': - description: success response + description: Ok content: application/json: schema: @@ -66,13 +66,13 @@ paths: schema: $ref: '#/components/schemas/inputfieldmissing' '413': - description: Input Limit Exceeded + description: Payload Too Large content: application/json: schema: $ref: '#/components/schemas/inputlimitexceeded' '415': - description: Invalid Input + description: Unsupported Media Type content: application/json: schema: From 5953ccdde42778c4253dbc5d6b285eca848b8360 Mon Sep 17 00:00:00 2001 From: rameshsentient <51635015+rameshsentient@users.noreply.github.com> Date: Mon, 22 Feb 2021 17:06:54 +0530 Subject: [PATCH 474/792] Update spacy_named-entity_recognition_eng.yaml --- nlp/spacy_named-entity_recognition_eng.yaml | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/nlp/spacy_named-entity_recognition_eng.yaml b/nlp/spacy_named-entity_recognition_eng.yaml index e911077c7..3e43d8025 100644 --- a/nlp/spacy_named-entity_recognition_eng.yaml +++ b/nlp/spacy_named-entity_recognition_eng.yaml @@ -26,7 +26,7 @@ paths: - v0.1.0 responses: '200': - description: success response + description: Ok content: application/json: schema: @@ -63,13 +63,13 @@ paths: schema: $ref: '#/components/schemas/inputfieldmissing' '413': - description: Input Limit Exceeded + description: Payload Too Large content: application/json: schema: $ref: '#/components/schemas/inputlimitexceeded' '415': - description: Invalid Input + description: Unsupported Media Type content: application/json: schema: From 33a354abc18a0a9bc153d3eb6a2475c4709d142a Mon Sep 17 00:00:00 2001 From: rameshsentient <51635015+rameshsentient@users.noreply.github.com> Date: Mon, 22 Feb 2021 17:14:04 +0530 Subject: [PATCH 475/792] Update taxonomy_matcher_eng.yaml --- nlp/taxonomy_matcher_eng.yaml | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/nlp/taxonomy_matcher_eng.yaml b/nlp/taxonomy_matcher_eng.yaml index 8d91029eb..032c004e0 100644 --- a/nlp/taxonomy_matcher_eng.yaml +++ b/nlp/taxonomy_matcher_eng.yaml @@ -28,7 +28,7 @@ paths: - v0.1.0 responses: '200': - description: success response + description: Ok content: application/json: schema: @@ -73,13 +73,13 @@ paths: schema: $ref: '#/components/schemas/inputfieldmissing' '413': - description: Input Limit Exceeded + description: Payload Too Large content: application/json: schema: $ref: '#/components/schemas/inputlimitexceeded' '415': - description: Invalid Input + description: Unsupported Media Type content: application/json: schema: From 7dd6252b0c35d2495efc2ffb9366f373e4b4537b Mon Sep 17 00:00:00 2001 From: rameshsentient <51635015+rameshsentient@users.noreply.github.com> Date: Mon, 22 Feb 2021 17:14:32 +0530 Subject: [PATCH 476/792] Update taxonomy_matcher_eng_v1.0.yaml --- nlp/taxonomy_matcher_eng_v1.0.yaml | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/nlp/taxonomy_matcher_eng_v1.0.yaml b/nlp/taxonomy_matcher_eng_v1.0.yaml index 5ed626a30..e69444ecd 100644 --- a/nlp/taxonomy_matcher_eng_v1.0.yaml +++ b/nlp/taxonomy_matcher_eng_v1.0.yaml @@ -27,7 +27,7 @@ paths: - v1.0.0 responses: '200': - description: success response + description: Ok content: application/json: schema: @@ -75,13 +75,13 @@ paths: schema: $ref: '#/components/schemas/inputfieldmissing' '413': - description: Input Limit Exceeded + description: Payload Too Large content: application/json: schema: $ref: '#/components/schemas/inputlimitexceeded' '415': - description: Invalid Input + description: Unsupported Media Type content: application/json: schema: From f9171713fe7dbc6377739ff69d1373d3a7c2cfe0 Mon Sep 17 00:00:00 2001 From: rameshsentient <51635015+rameshsentient@users.noreply.github.com> Date: Mon, 22 Feb 2021 17:18:12 +0530 Subject: [PATCH 477/792] Update people_counting_v1.0.yaml --- computer_vision/people_counting_v1.0.yaml | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/computer_vision/people_counting_v1.0.yaml b/computer_vision/people_counting_v1.0.yaml index 0d0395155..ca1f580b5 100644 --- a/computer_vision/people_counting_v1.0.yaml +++ b/computer_vision/people_counting_v1.0.yaml @@ -13,10 +13,10 @@ info: version: '1.0.0' x-subscribelink: people_counting servers: - - url: 'https://dev-apis.sentient.io' + - url: 'https://apis.sentient.io' tags: - name: "v1.0.0" - description: "Published Date - Dec 31, 2020" + description: "Published Date - Jan 25, 2021" paths: /microservices/cv/peoplecounting/v1/getpredictions: post: @@ -25,7 +25,7 @@ paths: responses: '200': - description: success response + description: Ok content: application/json: schema: @@ -62,13 +62,13 @@ paths: schema: $ref: '#/components/schemas/inputfieldmissing' '413': - description: Input Limit Exceeded + description: Payload Too Large content: application/json: schema: $ref: '#/components/schemas/inputlimitexceeded' '415': - description: Invalid Input + description: Unsupported Media Type content: application/json: schema: @@ -226,7 +226,7 @@ components: items: oneOf: - type: string - example: Published Date - Dec 31, 2020 + example: Published Date - Jan 25, 2021 description: Standardizing Output JSON v0.1.0: type: array From 40d91d371a3e7830c6f302c7df7b98c04dec2a9c Mon Sep 17 00:00:00 2001 From: rameshsentient <51635015+rameshsentient@users.noreply.github.com> Date: Mon, 22 Feb 2021 17:19:14 +0530 Subject: [PATCH 478/792] Update people_counting.yaml --- computer_vision/people_counting.yaml | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/computer_vision/people_counting.yaml b/computer_vision/people_counting.yaml index 56f42c7b0..f42723179 100644 --- a/computer_vision/people_counting.yaml +++ b/computer_vision/people_counting.yaml @@ -25,7 +25,7 @@ paths: responses: '200': - description: success response + description: Ok content: application/json: schema: @@ -63,13 +63,13 @@ paths: schema: $ref: '#/components/schemas/inputfieldmissing' '413': - description: Input Limit Exceeded + description: Payload Too Large content: application/json: schema: $ref: '#/components/schemas/inputlimitexceeded' '415': - description: Invalid Input + description: Unsupported Media Type content: application/json: schema: From a1406df3c94e5174b005488776d2b202a48c3a1d Mon Sep 17 00:00:00 2001 From: rameshsentient <51635015+rameshsentient@users.noreply.github.com> Date: Mon, 22 Feb 2021 17:24:10 +0530 Subject: [PATCH 479/792] Update object_detection_v1.0.yaml --- computer_vision/object_detection_v1.0.yaml | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/computer_vision/object_detection_v1.0.yaml b/computer_vision/object_detection_v1.0.yaml index fb0676122..0f227b8cf 100644 --- a/computer_vision/object_detection_v1.0.yaml +++ b/computer_vision/object_detection_v1.0.yaml @@ -20,7 +20,7 @@ servers: - url: 'https://apis.sentient.io' tags: - name: "v1.0.0" - description: "Published Date - Dec 31, 2020" + description: "Published Date - Jan 25, 2021" paths: /microservices/cv/objectdetection/v1/getpredictions: post: @@ -28,7 +28,7 @@ paths: - v1.0.0 responses: '200': - description: success response + description: Ok content: application/json: schema: @@ -66,13 +66,13 @@ paths: schema: $ref: '#/components/schemas/inputfieldmissing' '413': - description: Input Limit Exceeded + description: Payload Too Large content: application/json: schema: $ref: '#/components/schemas/inputlimitexceeded' '415': - description: Invalid Input + description: Unsupported Media Type content: application/json: schema: From 1722d20dd63e08ca2913b41fb0e6708d3e7a56cd Mon Sep 17 00:00:00 2001 From: rameshsentient <51635015+rameshsentient@users.noreply.github.com> Date: Mon, 22 Feb 2021 17:24:49 +0530 Subject: [PATCH 480/792] Update object_detection.yaml --- computer_vision/object_detection.yaml | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/computer_vision/object_detection.yaml b/computer_vision/object_detection.yaml index d2025b37d..2e747db82 100644 --- a/computer_vision/object_detection.yaml +++ b/computer_vision/object_detection.yaml @@ -30,7 +30,7 @@ paths: - v0.1.0 responses: '200': - description: success response + description: Ok content: application/json: schema: @@ -68,13 +68,13 @@ paths: schema: $ref: '#/components/schemas/inputfieldmissing' '413': - description: Input Limit Exceeded + description: Payload Too Large content: application/json: schema: $ref: '#/components/schemas/inputlimitexceeded' '415': - description: Invalid Input + description: Unsupported Media Type content: application/json: schema: From 7058c1c51e9825caab478c646c4eff29bbf20f91 Mon Sep 17 00:00:00 2001 From: rameshsentient <51635015+rameshsentient@users.noreply.github.com> Date: Mon, 22 Feb 2021 17:28:27 +0530 Subject: [PATCH 481/792] Update object_detection_v1.0.yaml --- computer_vision/object_detection_v1.0.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/computer_vision/object_detection_v1.0.yaml b/computer_vision/object_detection_v1.0.yaml index 0f227b8cf..d5885057d 100644 --- a/computer_vision/object_detection_v1.0.yaml +++ b/computer_vision/object_detection_v1.0.yaml @@ -246,7 +246,7 @@ components: items: oneOf: - type: string - example: Published Date - Dec 31, 2020 + example: Published Date - Jan 25, 2021 description: Standardizing Output JSON v0.1.0: type: array From f14118072113ff93935e607f9d2b45602d0efa21 Mon Sep 17 00:00:00 2001 From: rameshsentient <51635015+rameshsentient@users.noreply.github.com> Date: Mon, 22 Feb 2021 17:32:10 +0530 Subject: [PATCH 482/792] Update object_detection.yaml --- computer_vision/object_detection.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/computer_vision/object_detection.yaml b/computer_vision/object_detection.yaml index 2e747db82..a3ca311db 100644 --- a/computer_vision/object_detection.yaml +++ b/computer_vision/object_detection.yaml @@ -225,7 +225,7 @@ components: items: oneOf: - type: string - example: Published Date - May 15,2020 + example: Published Date - May 15, 2020 description: Initial version release input: type: object From 98768acc796fbeeaebb122ea2c001768e41d8cee Mon Sep 17 00:00:00 2001 From: rameshsentient <51635015+rameshsentient@users.noreply.github.com> Date: Mon, 22 Feb 2021 17:32:20 +0530 Subject: [PATCH 483/792] Update object_detection_v1.0.yaml --- computer_vision/object_detection_v1.0.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/computer_vision/object_detection_v1.0.yaml b/computer_vision/object_detection_v1.0.yaml index d5885057d..6d495acb9 100644 --- a/computer_vision/object_detection_v1.0.yaml +++ b/computer_vision/object_detection_v1.0.yaml @@ -253,7 +253,7 @@ components: items: oneOf: - type: string - example: Published Date - May 15,2020 + example: Published Date - May 15, 2020 description: Initial version release input: type: object From 2f1da6f11dd32827d1bb42bd09f71414fb871355 Mon Sep 17 00:00:00 2001 From: rameshsentient <51635015+rameshsentient@users.noreply.github.com> Date: Mon, 22 Feb 2021 17:51:38 +0530 Subject: [PATCH 484/792] Update word_sense_disambiguation_eng.yaml --- nlp/word_sense_disambiguation_eng.yaml | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/nlp/word_sense_disambiguation_eng.yaml b/nlp/word_sense_disambiguation_eng.yaml index 426f47c0a..32bc285d6 100644 --- a/nlp/word_sense_disambiguation_eng.yaml +++ b/nlp/word_sense_disambiguation_eng.yaml @@ -24,7 +24,7 @@ paths: - v0.1.0 responses: '200': - description: success response + description: Ok content: application/json: schema: @@ -79,13 +79,13 @@ paths: schema: $ref: '#/components/schemas/inputfieldmissing' '413': - description: Input Limit Exceeded + description: Payload Too Large content: application/json: schema: $ref: '#/components/schemas/inputlimitexceeded' '415': - description: Invalid Input + description: Unsupported Media Type content: application/json: schema: From 61b379a11b098fa20d1ff1be7b1b4edc5cffb2ad Mon Sep 17 00:00:00 2001 From: rameshsentient <51635015+rameshsentient@users.noreply.github.com> Date: Mon, 22 Feb 2021 17:54:43 +0530 Subject: [PATCH 485/792] Update word_sense_disambiguation_eng_v1.0.yaml --- nlp/word_sense_disambiguation_eng_v1.0.yaml | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/nlp/word_sense_disambiguation_eng_v1.0.yaml b/nlp/word_sense_disambiguation_eng_v1.0.yaml index d712762b6..31c6fafa8 100644 --- a/nlp/word_sense_disambiguation_eng_v1.0.yaml +++ b/nlp/word_sense_disambiguation_eng_v1.0.yaml @@ -25,7 +25,7 @@ paths: - v1.0.0 responses: '200': - description: success response + description: Ok content: application/json: schema: @@ -83,13 +83,13 @@ paths: schema: $ref: '#/components/schemas/inputfieldmissing' '413': - description: Input Limit Exceeded + description: Payload Too Large content: application/json: schema: $ref: '#/components/schemas/inputlimitexceeded' '415': - description: Invalid Input + description: Unsupported Media Type content: application/json: schema: From 61155fa4dd3de6dd4100971af19d2e5d78ed5906 Mon Sep 17 00:00:00 2001 From: priyaPeristera Date: Tue, 23 Feb 2021 14:07:44 +1100 Subject: [PATCH 486/792] Add LD SG and JP new version --- index.yaml | 2 ++ 1 file changed, 2 insertions(+) diff --git a/index.yaml b/index.yaml index e11ec6b52..2c3128b46 100644 --- a/index.yaml +++ b/index.yaml @@ -130,10 +130,12 @@ computer vision: landmark_detection_sg: title: Landmark Detection (SG) versions: + 1.0.0: 'landmark_detection_sg_v1.0.yaml' 0.1.0: 'landmark_detection_sg.yaml' landmark_detection_jp: title: Landmark Detection (JP) versions: + 1.0.0: 'landmark_detection_jp_v1.0.yaml' 0.1.0: 'landmark_detection_jp.yaml' demographics_classification: title: Demographics Classification From be3c9cd81a34df31609a1511bf4753441c9078e5 Mon Sep 17 00:00:00 2001 From: rameshsentient <51635015+rameshsentient@users.noreply.github.com> Date: Tue, 23 Feb 2021 09:14:58 +0530 Subject: [PATCH 487/792] Update demographics_classification.yaml --- computer_vision/demographics_classification.yaml | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/computer_vision/demographics_classification.yaml b/computer_vision/demographics_classification.yaml index 6fa1083f6..ff12515c0 100644 --- a/computer_vision/demographics_classification.yaml +++ b/computer_vision/demographics_classification.yaml @@ -21,7 +21,7 @@ paths: - v0.1.0 responses: '200': - description: success response + description: Ok content: application/json: schema: @@ -71,13 +71,13 @@ paths: schema: $ref: '#/components/schemas/inputfieldmissing' '413': - description: Input Limit Exceeded + description: Payload Too Large content: application/json: schema: $ref: '#/components/schemas/inputlimitexceeded' '415': - description: Invalid Input + description: Unsupported Media Type content: application/json: schema: From fc6cc829c6803be4c09c5a5694ef06325e6f009c Mon Sep 17 00:00:00 2001 From: rameshsentient <51635015+rameshsentient@users.noreply.github.com> Date: Tue, 23 Feb 2021 11:23:16 +0530 Subject: [PATCH 488/792] Update landmark_detection_jp_v1.0.yaml --- computer_vision/landmark_detection_jp_v1.0.yaml | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/computer_vision/landmark_detection_jp_v1.0.yaml b/computer_vision/landmark_detection_jp_v1.0.yaml index e0e2a920e..2075b149b 100644 --- a/computer_vision/landmark_detection_jp_v1.0.yaml +++ b/computer_vision/landmark_detection_jp_v1.0.yaml @@ -24,7 +24,7 @@ paths: - v1.0.0 responses: '200': - description: success response + description: Ok content: application/json: schema: @@ -65,14 +65,14 @@ paths: application/json: schema: $ref: '#/components/schemas/inputfieldmissing' - '420': - description: Input Limit Exceeded + '413': + description: Payload Too Large content: application/json: schema: $ref: '#/components/schemas/inputlimitexceeded' - '422': - description: Invalid Input + '415': + description: Unsupported Media Type content: application/json: schema: From 79ce1f7405f2441f2222e1f8ebe92fa7aaa70eb6 Mon Sep 17 00:00:00 2001 From: rameshsentient <51635015+rameshsentient@users.noreply.github.com> Date: Tue, 23 Feb 2021 11:23:48 +0530 Subject: [PATCH 489/792] Update landmark_detection_jp.yaml --- computer_vision/landmark_detection_jp.yaml | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/computer_vision/landmark_detection_jp.yaml b/computer_vision/landmark_detection_jp.yaml index aa0e23555..4a84e3101 100644 --- a/computer_vision/landmark_detection_jp.yaml +++ b/computer_vision/landmark_detection_jp.yaml @@ -24,7 +24,7 @@ paths: - v0.1.0 responses: '200': - description: success response + description: Ok content: application/json: schema: @@ -63,13 +63,13 @@ paths: schema: $ref: '#/components/schemas/inputfieldmissing' '413': - description: Input Limit Exceeded + description: Payload Too Large content: application/json: schema: $ref: '#/components/schemas/inputlimitexceeded' '415': - description: Invalid Input + description: Unsupported Media Type content: application/json: schema: From 971abba2a2922f6db02de67ebc8b638df4af28fa Mon Sep 17 00:00:00 2001 From: rameshsentient <51635015+rameshsentient@users.noreply.github.com> Date: Tue, 23 Feb 2021 11:32:29 +0530 Subject: [PATCH 490/792] Update landmark_detection_sg.yaml --- computer_vision/landmark_detection_sg.yaml | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/computer_vision/landmark_detection_sg.yaml b/computer_vision/landmark_detection_sg.yaml index 445b27108..3546a4313 100644 --- a/computer_vision/landmark_detection_sg.yaml +++ b/computer_vision/landmark_detection_sg.yaml @@ -25,7 +25,7 @@ paths: responses: '200': - description: success response + description: Ok content: application/json: schema: @@ -65,13 +65,13 @@ paths: schema: $ref: '#/components/schemas/inputfieldmissing' '413': - description: Input Limit Exceeded + description: Payload Too Large content: application/json: schema: $ref: '#/components/schemas/inputlimitexceeded' '415': - description: Invalid Input + description: Unsupported Media Type content: application/json: schema: From d1cc49d70245bd9bb7089d0a275969fa98e608cd Mon Sep 17 00:00:00 2001 From: rameshsentient <51635015+rameshsentient@users.noreply.github.com> Date: Tue, 23 Feb 2021 11:32:32 +0530 Subject: [PATCH 491/792] Update landmark_detection_sg_v1.0.yaml --- computer_vision/landmark_detection_sg_v1.0.yaml | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/computer_vision/landmark_detection_sg_v1.0.yaml b/computer_vision/landmark_detection_sg_v1.0.yaml index 13f03ef47..ee912e6b0 100644 --- a/computer_vision/landmark_detection_sg_v1.0.yaml +++ b/computer_vision/landmark_detection_sg_v1.0.yaml @@ -25,7 +25,7 @@ paths: responses: '200': - description: success response + description: Ok content: application/json: schema: @@ -67,14 +67,14 @@ paths: application/json: schema: $ref: '#/components/schemas/inputfieldmissing' - '420': - description: Input Limit Exceeded + '413': + description: Payload Too Large content: application/json: schema: $ref: '#/components/schemas/inputlimitexceeded' - '422': - description: Invalid Input + '415': + description: Unsupported Media Type content: application/json: schema: From 7682df576a95a795ab0556f0898693bf7f01d2fb Mon Sep 17 00:00:00 2001 From: rameshsentient <51635015+rameshsentient@users.noreply.github.com> Date: Tue, 23 Feb 2021 15:07:19 +0530 Subject: [PATCH 492/792] Update demographics_classification.yaml --- computer_vision/demographics_classification.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/computer_vision/demographics_classification.yaml b/computer_vision/demographics_classification.yaml index ff12515c0..9459c46ab 100644 --- a/computer_vision/demographics_classification.yaml +++ b/computer_vision/demographics_classification.yaml @@ -3,7 +3,7 @@ info: title: Demographics Classification description: |+ This Computer Vision microservice detects for faces from an input image and predicts the demographics of each face (age, gender and race). The image is given as an input encoded using base64. The microservice will a face detector and subsequently models to predict age, gender and race. The results will then be returned back to the user as a JSON output together with bounding box coordinates for each face.Races include: Asian, Indian, White, Black, Middle Eastern and Latino Hispanic - The size of your image file should **not exceed 5 MB**, and the image dimension should be **at least 416x416 pixels**. + The size of your image file should **not exceed 10 MB**, and the image dimension should be **at least 416x416 pixels**. x-additionalinfo: |+ Suggested Use Cases: - This microservice can be used as a solution to help businesses better understand and connect with their customers, engage new prospects and increase revenue. For example, it can be used to improve visitor experience and optimize operations in retail, leisure, and other sectors by identifying the type of demogrpahic that frequents a certain place the most. It can also be used to create intelligent prospect lists that ensure one is always maximizing their marketing investment. From bf37340fbe77e44e509a4d900e18e43e3153e939 Mon Sep 17 00:00:00 2001 From: rameshsentient <51635015+rameshsentient@users.noreply.github.com> Date: Tue, 23 Feb 2021 15:22:00 +0530 Subject: [PATCH 493/792] Update face_recognition_v1.0.yaml --- computer_vision/face_recognition_v1.0.yaml | 1 + 1 file changed, 1 insertion(+) diff --git a/computer_vision/face_recognition_v1.0.yaml b/computer_vision/face_recognition_v1.0.yaml index f26455b36..0438601cb 100644 --- a/computer_vision/face_recognition_v1.0.yaml +++ b/computer_vision/face_recognition_v1.0.yaml @@ -7,6 +7,7 @@ info: This microservice returns the identity of the person, the bounding box in image coordinates, and the confidence of the prediction. Users can further filter the results by countries, profession or even down to the individual names. Help us grow this microservice! [Let us know](https://www.sentient.io/contact) which other public figures you would like us this microservice to also recognise (e.g. a new country or a new category). We will expand the capability of this microservices based on user feedback and demand. + The size of your image file should **not exceed 10 MB** version: '1.0.1' x-additionalinfo: |+ **Full List of Filters** From 4cb8155b1b9b7eb045ca74e5ff3909071b3122e2 Mon Sep 17 00:00:00 2001 From: rameshsentient <51635015+rameshsentient@users.noreply.github.com> Date: Tue, 23 Feb 2021 15:22:13 +0530 Subject: [PATCH 494/792] Update face_recognition_politicians_sg.yaml --- computer_vision/face_recognition_politicians_sg.yaml | 1 + 1 file changed, 1 insertion(+) diff --git a/computer_vision/face_recognition_politicians_sg.yaml b/computer_vision/face_recognition_politicians_sg.yaml index 926daba86..9ed562873 100644 --- a/computer_vision/face_recognition_politicians_sg.yaml +++ b/computer_vision/face_recognition_politicians_sg.yaml @@ -7,6 +7,7 @@ info: This microservice returns the identity of the person, the bounding box in image coordinates, and the confidence of the prediction. Users can further filter Help us grow this microservice! [Let us know](https://www.sentient.io/contact) which other public figures you would like us this microservice to also recognise (e.g. a new country or a new category). We will expand the capability of this microservices based on user feedback and demand. + The size of your image file should **not exceed 10 MB** x-additionalinfo: |+ Suggested Use Cases: - For solutions related to identifying the speaker for auto-tagging, or matching the transcription to a person that is a Singaporean politician, or a Singaporean/Japanese public figure. From 85df7451dc7232920a29526cb41b0291113579cc Mon Sep 17 00:00:00 2001 From: rameshsentient <51635015+rameshsentient@users.noreply.github.com> Date: Tue, 23 Feb 2021 16:28:55 +0530 Subject: [PATCH 495/792] Update audio_format_convertor.yaml --- utility/audio_format_convertor.yaml | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/utility/audio_format_convertor.yaml b/utility/audio_format_convertor.yaml index 5fb6e071e..69404ed50 100644 --- a/utility/audio_format_convertor.yaml +++ b/utility/audio_format_convertor.yaml @@ -22,7 +22,7 @@ paths: - v0.1.0 responses: '200': - description: success response + description: Ok content: application/json: schema: @@ -63,13 +63,13 @@ paths: schema: $ref: '#/components/schemas/inputfieldmissing' '413': - description: Input Limit Exceeded + description: Payload Too Large content: application/json: schema: $ref: '#/components/schemas/inputlimitexceeded' '415': - description: Invalid Input + description: Unsupported Media Type content: application/json: schema: From f8427d7eff469d6a6ac2dcb79f8ef368a8fc7e61 Mon Sep 17 00:00:00 2001 From: rameshsentient <51635015+rameshsentient@users.noreply.github.com> Date: Tue, 23 Feb 2021 16:45:44 +0530 Subject: [PATCH 496/792] Update base64-decoder.yaml --- utility/base64-decoder.yaml | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/utility/base64-decoder.yaml b/utility/base64-decoder.yaml index 88700c389..cb5763cad 100644 --- a/utility/base64-decoder.yaml +++ b/utility/base64-decoder.yaml @@ -20,7 +20,7 @@ paths: - "0.0.1" responses: '200': - description: success response + description: Ok content: application/json: schema: @@ -60,13 +60,13 @@ paths: schema: $ref: '#/components/schemas/inputfieldmissing' '413': - description: Input Limit Exceeded + description: Payload Too Large content: application/json: schema: $ref: '#/components/schemas/inputlimitexceeded' '415': - description: Invalid Input + description: Unsupported Media Type content: application/json: schema: From b4bce3fc8956127ea2b59c954b12b27c0c66057b Mon Sep 17 00:00:00 2001 From: rameshsentient <51635015+rameshsentient@users.noreply.github.com> Date: Tue, 23 Feb 2021 16:48:17 +0530 Subject: [PATCH 497/792] Update base64-encoder.yaml --- utility/base64-encoder.yaml | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/utility/base64-encoder.yaml b/utility/base64-encoder.yaml index 7bf6b5c92..aad79ac35 100644 --- a/utility/base64-encoder.yaml +++ b/utility/base64-encoder.yaml @@ -20,7 +20,7 @@ paths: - v0.0.1 responses: '200': - description: success response + description: Ok content: application/json: schema: @@ -61,13 +61,13 @@ paths: schema: $ref: '#/components/schemas/inputfieldmissing' '413': - description: Input Limit Exceeded + description: Payload Too Large content: application/json: schema: $ref: '#/components/schemas/inputlimitexceeded' '415': - description: Invalid Input + description: Unsupported Media Type content: application/json: schema: From 1c7f1c68aa5ec595bd017dce68f47e784d37c9ef Mon Sep 17 00:00:00 2001 From: rameshsentient <51635015+rameshsentient@users.noreply.github.com> Date: Tue, 23 Feb 2021 16:50:57 +0530 Subject: [PATCH 498/792] Update csv-json_convertor.yaml --- utility/csv-json_convertor.yaml | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/utility/csv-json_convertor.yaml b/utility/csv-json_convertor.yaml index fd4177318..c8eef44bd 100644 --- a/utility/csv-json_convertor.yaml +++ b/utility/csv-json_convertor.yaml @@ -22,7 +22,7 @@ paths: - v1.0.0 responses: '200': - description: success response + description: Ok content: application/json: schema: @@ -64,13 +64,13 @@ paths: schema: $ref: '#/components/schemas/inputfieldmissing' '413': - description: Input Limit Exceeded + description: Payload Too Large content: application/json: schema: $ref: '#/components/schemas/inputlimitexceeded' '415': - description: Invalid Input + description: Unsupported Media Type content: application/json: schema: From c12c969365ee1322595ed256b2be3416703df3f1 Mon Sep 17 00:00:00 2001 From: rameshsentient <51635015+rameshsentient@users.noreply.github.com> Date: Tue, 23 Feb 2021 16:51:30 +0530 Subject: [PATCH 499/792] Update decryption_using_pki_key.yaml --- utility/decryption_using_pki_key.yaml | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/utility/decryption_using_pki_key.yaml b/utility/decryption_using_pki_key.yaml index 737ef9ce6..1b7586de4 100644 --- a/utility/decryption_using_pki_key.yaml +++ b/utility/decryption_using_pki_key.yaml @@ -24,7 +24,7 @@ paths: - v0.1.0 responses: '200': - description: success response + description: Ok content: application/json: schema: @@ -64,13 +64,13 @@ paths: schema: $ref: '#/components/schemas/inputfieldmissing' '413': - description: Input Limit Exceeded + description: Payload Too Large content: application/json: schema: $ref: '#/components/schemas/inputlimitexceeded' '415': - description: Invalid Input + description: Unsupported Media Type content: application/json: schema: From eea76ad0c9d9cc08f7f691d3a83bf0f919b9d578 Mon Sep 17 00:00:00 2001 From: rameshsentient <51635015+rameshsentient@users.noreply.github.com> Date: Tue, 23 Feb 2021 16:52:22 +0530 Subject: [PATCH 500/792] Update document_convertor_eng.yaml --- utility/document_convertor_eng.yaml | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/utility/document_convertor_eng.yaml b/utility/document_convertor_eng.yaml index 05cf17edd..f190fed5c 100644 --- a/utility/document_convertor_eng.yaml +++ b/utility/document_convertor_eng.yaml @@ -24,7 +24,7 @@ paths: - v1.0.0 responses: '200': - description: success response + description: Ok content: application/json: schema: @@ -68,13 +68,13 @@ paths: schema: $ref: '#/components/schemas/inputfieldmissing' '413': - description: Input Limit Exceeded + description: Payload Too Large content: application/json: schema: $ref: '#/components/schemas/inputlimitexceeded' '415': - description: Invalid Input + description: Unsupported Media Type content: application/json: schema: From afc6c240434d7778e346276d51897a6e0677538a Mon Sep 17 00:00:00 2001 From: rameshsentient <51635015+rameshsentient@users.noreply.github.com> Date: Tue, 23 Feb 2021 17:06:50 +0530 Subject: [PATCH 501/792] Delete inverse_text_normalisation_eng.yaml --- utility/inverse_text_normalisation_eng.yaml | 228 -------------------- 1 file changed, 228 deletions(-) delete mode 100644 utility/inverse_text_normalisation_eng.yaml diff --git a/utility/inverse_text_normalisation_eng.yaml b/utility/inverse_text_normalisation_eng.yaml deleted file mode 100644 index 10520a858..000000000 --- a/utility/inverse_text_normalisation_eng.yaml +++ /dev/null @@ -1,228 +0,0 @@ -openapi: 3.0.1 -info: - title: Inverse Text Normalisation ENG - description: |+ - This NLP microservice recovers missing punctuations such as full stop, comma, exclamation mark, and question mark from the input text. - - This NLP microservice also converts pre-defined abbreviations from lower case to upper case. - - This NLP microservice also converts first letters of sentences to upper case. - x-additionalinfo: |+ - Suggested Use Cases: - - Can be integrated into services or apps that offer digital writing assistance to make writing clear and effective. - version: '0.1.0' - x-subscribelink: inverse_text_normalisation_eng -servers: - - url: 'https://apis.sentient.io' -tags: -- name: "v0.1.0" - description: "Published Date - Mar 24, 2020" -paths: - /microservices/nlp/inversenorm/v0.1/getpredictions: - post: - tags: - - v0.1.0 - responses: - '200': - description: success response - content: - application/json: - schema: - $ref: '#/components/schemas/success' - example: - '0': |+ - Apple said, the project-financing fund was the 1 of its kind, real estate developers, - often secure bonds for affordable housing development, but must service the debt - during construction, until the houses are built and start to generate revenue, apple - and state officials hope to provide bridge financing during construction at rates - below those from commercial lenders. - '1': |+ - The $2000000000 in funding will be deployable across NTU while the remaining - 5500000000 will go toward efforts specific to apple's home region in northern california, - where fast-growing tech companies have drawn protests from residents who blame them - for rising, housing costs. - '401': - description: Unauthorized - content: - application/json: - schema: - $ref: '#/components/schemas/unauthorized' - '402': - description: Payment Required - content: - application/json: - schema: - $ref: '#/components/schemas/paymentrequired' - '403': - description: Forbidden - content: - application/json: - schema: - $ref: '#/components/schemas/forbidden' - '404': - description: Not Found - content: - application/json: - schema: - $ref: '#/components/schemas/notfound' - '419': - description: Input Field Missing - content: - application/json: - schema: - $ref: '#/components/schemas/inputfieldmissing' - '413': - description: Input Limit Exceeded - content: - application/json: - schema: - $ref: '#/components/schemas/inputlimitexceeded' - '415': - description: Invalid Input - content: - application/json: - schema: - $ref: '#/components/schemas/invalidinput' - '500': - description: Internal Server Error - content: - application/json: - schema: - $ref: '#/components/schemas/servererror' - '504': - description: Gateway Timeout - content: - application/json: - schema: - $ref: '#/components/schemas/gatewaytimeout' - security: - - APIAuthorizer: [] - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/input' - required: true -components: - schemas: - success: - type: object - properties: - : - type: string - example: { 0: Apple said, the project-financing fund was the 1 of its kind, real estate developers, often secure bonds for affordable housing development, but must service the debt during construction, until the houses are built and start to generate revenue, apple and state officials hope to provide bridge financing during construction at rates below those from commercial lenders.} - description: Order sequence number - unauthorized: - type: object - properties: - message: - type: string - example: Missing Authentication Token - status: - type: string - example: Failure - forbidden: - type: object - properties: - message: - type: string - example: Access Denied Unauthorized User - status: - type: string - example: Failure - paymentrequired: - type: object - properties: - message: - type: string - example: Insufficient Credits Kindly Top Up - status: - type: string - example: Failure - notfound: - type: object - properties: - message: - type: string - example: Invalid Request URL - status: - type: string - example: Failure - servererror: - type: object - properties: - message: - type: string - example: Internal Server Error - status: - type: string - example: Failure - gatewaytimeout: - type: object - properties: - message: - type: string - example: Request Timeout - status: - type: string - example: Failure - inputfieldmissing: - type: object - properties: - message: - type: string - example: Input Field Missing - status: - type: string - example: Failure - inputlimitexceeded: - type: object - properties: - message: - type: string - example: Input Limit Exceeded - status: - type: string - example: Failure - invalidinput: - type: object - properties: - message: - type: string - example: Invalid Input - status: - type: string - example: Failure - versions: - type: object - properties: - v0.1.0: - type: array - items: - oneOf: - - type: string - example: Published Date - Mar 24, 2020 - description: Initial version release - input: - type: array - required: - - text - items: - type: object - properties: - text: - x-name: text - type: string - default: true - example: Apple said the project-financing fund was the first of its kind Real estate developers often secure bonds for affordable housing development but must service the debt during construction until the houses are built and start to generate revenue Apple and state officials hope to provide bridge financing during construction at rates below those from commercial lenders - description: |+ - Input text. - - Supported formats: ASCII only - securitySchemes: - APIAuthorizer: - type: apiKey - name: x-api-key - in: header - x-amazon-apigateway-authtype: custom - description: Authentication is done using the x-api-key in the request header From 9242c2a7754082e7974010713c126dd0011a20a8 Mon Sep 17 00:00:00 2001 From: rameshsentient <51635015+rameshsentient@users.noreply.github.com> Date: Tue, 23 Feb 2021 17:07:15 +0530 Subject: [PATCH 502/792] Delete inverse_text_normalisation_eng_v1.0.yaml --- .../inverse_text_normalisation_eng_v1.0.yaml | 248 ------------------ 1 file changed, 248 deletions(-) delete mode 100644 utility/inverse_text_normalisation_eng_v1.0.yaml diff --git a/utility/inverse_text_normalisation_eng_v1.0.yaml b/utility/inverse_text_normalisation_eng_v1.0.yaml deleted file mode 100644 index 63e1e1e8b..000000000 --- a/utility/inverse_text_normalisation_eng_v1.0.yaml +++ /dev/null @@ -1,248 +0,0 @@ -openapi: 3.0.1 -info: - title: Inverse Text Normalisation ENG - description: |+ - This NLP microservice recovers the missing punctuations such as full stop, comma, exclamation mark, and question mark from the input text. - - It converts pre-defined abbreviations from lower case to upper case and also first letters of sentences to upper case. - - Do ensure that your text is within **5000 characters**. - version: '1.0.0' - x-additionalinfo: |+ - Suggested Use Cases: - - Can be integrated into services or apps that offer digital writing assistance to make writing clear and effective. - x-subscribelink: inverse_text_normalisation_eng -servers: - - url: 'https://apis.sentient.io' -tags: -- name: "v1.0.0" - description: "Published Date - Oct 30, 2020" -paths: - /microservices/nlp/inversenorm/v1/getpredictions: - post: - tags: - - v1.0.0 - responses: - '200': - description: success response - content: - application/json: - schema: - $ref: '#/components/schemas/success' - example: - results: - '0': |+ - Apple said, the project-financing fund was the 1 of its kind, real estate developers, - often secure bonds for affordable housing development, but must service the debt - during construction, until the houses are built and start to generate revenue, apple - and state officials hope to provide bridge financing during construction at rates - below those from commercial lenders. - '1': |+ - The $2000000000 in funding will be deployable across NTU while the remaining - 5500000000 will go toward efforts specific to apple's home region in northern california, - where fast-growing tech companies have drawn protests from residents who blame them - for rising, housing costs. - message: Successfully Processed - status: Success - '401': - description: Unauthorized - content: - application/json: - schema: - $ref: '#/components/schemas/unauthorized' - '402': - description: Payment Required - content: - application/json: - schema: - $ref: '#/components/schemas/paymentrequired' - '403': - description: Forbidden - content: - application/json: - schema: - $ref: '#/components/schemas/forbidden' - '404': - description: Not Found - content: - application/json: - schema: - $ref: '#/components/schemas/notfound' - '419': - description: Input Field Missing - content: - application/json: - schema: - $ref: '#/components/schemas/inputfieldmissing' - '413': - description: Input Limit Exceeded - content: - application/json: - schema: - $ref: '#/components/schemas/inputlimitexceeded' - '415': - description: Invalid Input - content: - application/json: - schema: - $ref: '#/components/schemas/invalidinput' - '500': - description: Internal Server Error - content: - application/json: - schema: - $ref: '#/components/schemas/servererror' - '504': - description: Gateway Timeout - content: - application/json: - schema: - $ref: '#/components/schemas/gatewaytimeout' - security: - - APIAuthorizer: [] - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/input' - required: true -components: - schemas: - success: - type: object - properties: - results: - type: object - description: The result of the API call. - example: { "" } - properties: - : - x-name: - type: string - example: { 0: Apple said, the project-financing fund was the 1 of its kind, real estate developers, often secure bonds for affordable housing development, but must service the debt during construction, until the houses are built and start to generate revenue, apple and state officials hope to provide bridge financing during construction at rates below those from commercial lenders.} - description: Order sequence number - message: - type: string - example: Successfully Processed - description: Detail description on the API status - status: - type: string - example: Success - description: The status of the API call success/failure - unauthorized: - type: object - properties: - message: - type: string - example: Missing Authentication Token - status: - type: string - example: Failure - forbidden: - type: object - properties: - message: - type: string - example: Access Denied Unauthorized User - status: - type: string - example: Failure - paymentrequired: - type: object - properties: - message: - type: string - example: Insufficient Credits Kindly Top Up - status: - type: string - example: Failure - notfound: - type: object - properties: - message: - type: string - example: Invalid Request URL - status: - type: string - example: Failure - servererror: - type: object - properties: - message: - type: string - example: Internal Server Error - status: - type: string - example: Failure - gatewaytimeout: - type: object - properties: - message: - type: string - example: Request Timeout - status: - type: string - example: Failure - inputfieldmissing: - type: object - properties: - message: - type: string - example: Input Field Missing - status: - type: string - example: Failure - inputlimitexceeded: - type: object - properties: - message: - type: string - example: Input Limit Exceeded - status: - type: string - example: Failure - invalidinput: - type: object - properties: - message: - type: string - example: Invalid Input - status: - type: string - example: Failure - versions: - type: object - properties: - v1.0.0: - type: array - items: - oneOf: - - type: string - example: Published Date - Oct 30,2020 - description: Standardizing Output JSON - v0.1.0: - type: array - items: - oneOf: - - type: string - example: Published Date - Mar 24, 2020 - description: Initial version release - input: - type: object - required: - - text - properties: - text: - x-name: text - type: string - default: true - example: Apple said the project-financing fund was the first of its kind Real estate developers often secure bonds for affordable housing development but must service the debt during construction until the houses are built and start to generate revenue Apple and state officials hope to provide bridge financing during construction at rates below those from commercial lenders - description: |+ - Input text - securitySchemes: - APIAuthorizer: - type: apiKey - name: x-api-key - in: header - x-amazon-apigateway-authtype: custom - description: Authentication is done using the x-api-key in the request header From 8b16c5cf276cad8c18c0a09512925a75a20726a3 Mon Sep 17 00:00:00 2001 From: rameshsentient <51635015+rameshsentient@users.noreply.github.com> Date: Tue, 23 Feb 2021 17:07:54 +0530 Subject: [PATCH 503/792] Delete download_dataset.yaml --- utility/download_dataset.yaml | 10 ---------- 1 file changed, 10 deletions(-) delete mode 100644 utility/download_dataset.yaml diff --git a/utility/download_dataset.yaml b/utility/download_dataset.yaml deleted file mode 100644 index 34c1dc112..000000000 --- a/utility/download_dataset.yaml +++ /dev/null @@ -1,10 +0,0 @@ -info: - title: Data Alliance - Download Dataset API - version: '0.1.0' -# tags must include in to the documentation, to read the description text for published date -tags: -- name: "v0.1.0" - description: " " -html: |+ - From c05442c7f7dbf53a20ef3d35862d497d32b21473 Mon Sep 17 00:00:00 2001 From: rameshsentient <51635015+rameshsentient@users.noreply.github.com> Date: Tue, 23 Feb 2021 17:25:27 +0530 Subject: [PATCH 504/792] Update encryption_using_pki_key.yaml --- utility/encryption_using_pki_key.yaml | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/utility/encryption_using_pki_key.yaml b/utility/encryption_using_pki_key.yaml index 89f64add2..b088e3ea3 100644 --- a/utility/encryption_using_pki_key.yaml +++ b/utility/encryption_using_pki_key.yaml @@ -24,7 +24,7 @@ paths: - v0.1.0 responses: '200': - description: success response + description: Ok content: application/json: schema: @@ -64,13 +64,13 @@ paths: schema: $ref: '#/components/schemas/inputfieldmissing' '413': - description: Input Limit Exceeded + description: Payload Too Large content: application/json: schema: $ref: '#/components/schemas/inputlimitexceeded' '415': - description: Invalid Input + description: Unsupported Media Type content: application/json: schema: From b58adbd45798832718765297cee34259dc76cd32 Mon Sep 17 00:00:00 2001 From: rameshsentient <51635015+rameshsentient@users.noreply.github.com> Date: Tue, 23 Feb 2021 17:26:20 +0530 Subject: [PATCH 505/792] Update json-csv_convertor.yaml --- utility/json-csv_convertor.yaml | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/utility/json-csv_convertor.yaml b/utility/json-csv_convertor.yaml index bd89410b6..19afc07ff 100644 --- a/utility/json-csv_convertor.yaml +++ b/utility/json-csv_convertor.yaml @@ -20,7 +20,7 @@ paths: - v1.0.0 responses: '200': - description: success response + description: Ok content: application/json: schema: @@ -61,13 +61,13 @@ paths: schema: $ref: '#/components/schemas/inputfieldmissing' '413': - description: Input Limit Exceeded + description: Payload Too Large content: application/json: schema: $ref: '#/components/schemas/inputlimitexceeded' '415': - description: Invalid Input + description: Unsupported Media Type content: application/json: schema: From 1e03d1cf1d8806d336922b629ead0b77fe74bf28 Mon Sep 17 00:00:00 2001 From: rameshsentient <51635015+rameshsentient@users.noreply.github.com> Date: Tue, 23 Feb 2021 17:27:24 +0530 Subject: [PATCH 506/792] Update newspaper_article_scraper.yaml --- utility/newspaper_article_scraper.yaml | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/utility/newspaper_article_scraper.yaml b/utility/newspaper_article_scraper.yaml index dcefbee00..4739c06ea 100644 --- a/utility/newspaper_article_scraper.yaml +++ b/utility/newspaper_article_scraper.yaml @@ -24,7 +24,7 @@ paths: - v0.1.0 responses: '200': - description: success response + description: Ok content: application/json: schema: @@ -100,13 +100,13 @@ paths: schema: $ref: '#/components/schemas/inputfieldmissing' '413': - description: Input Limit Exceeded + description: Payload Too Large content: application/json: schema: $ref: '#/components/schemas/inputlimitexceeded' '415': - description: Invalid Input + description: Unsupported Media Type content: application/json: schema: From 9c84916aa22007886fcce9850f2bbca5eda77d15 Mon Sep 17 00:00:00 2001 From: rameshsentient <51635015+rameshsentient@users.noreply.github.com> Date: Tue, 23 Feb 2021 17:28:25 +0530 Subject: [PATCH 507/792] Update pdf_extractor.yaml --- utility/pdf_extractor.yaml | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/utility/pdf_extractor.yaml b/utility/pdf_extractor.yaml index 69e7aaf66..0c821bc48 100644 --- a/utility/pdf_extractor.yaml +++ b/utility/pdf_extractor.yaml @@ -30,7 +30,7 @@ paths: - v1.0.0 responses: '200': - description: success response + description: Ok content: application/json: schema: @@ -75,13 +75,13 @@ paths: schema: $ref: '#/components/schemas/inputfieldmissing' '413': - description: Input Limit Exceeded + description: Payload Too Large content: application/json: schema: $ref: '#/components/schemas/inputlimitexceeded' '415': - description: Invalid Input + description: Unsupported Media Type content: application/json: schema: From 824fdfd826d920a68b0c520a634f1852ef435cad Mon Sep 17 00:00:00 2001 From: rameshsentient <51635015+rameshsentient@users.noreply.github.com> Date: Tue, 23 Feb 2021 17:29:03 +0530 Subject: [PATCH 508/792] Update pki_key_generator.yaml --- utility/pki_key_generator.yaml | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/utility/pki_key_generator.yaml b/utility/pki_key_generator.yaml index 76443b7cd..d6ca1219b 100644 --- a/utility/pki_key_generator.yaml +++ b/utility/pki_key_generator.yaml @@ -20,7 +20,7 @@ paths: - v0.1.0 responses: '200': - description: success response + description: Ok content: application/json: schema: @@ -60,13 +60,13 @@ paths: schema: $ref: '#/components/schemas/inputfieldmissing' '413': - description: Input Limit Exceeded + description: Payload Too Large content: application/json: schema: $ref: '#/components/schemas/inputlimitexceeded' '415': - description: Invalid Input + description: Unsupported Media Type content: application/json: schema: From 93ea1da8fd656aa6b2234818659dfe794103191d Mon Sep 17 00:00:00 2001 From: rameshsentient <51635015+rameshsentient@users.noreply.github.com> Date: Tue, 23 Feb 2021 17:42:18 +0530 Subject: [PATCH 509/792] Update urls_retrieval.yaml --- utility/urls_retrieval.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/utility/urls_retrieval.yaml b/utility/urls_retrieval.yaml index fe63ae65d..29fd3ceaf 100644 --- a/utility/urls_retrieval.yaml +++ b/utility/urls_retrieval.yaml @@ -75,7 +75,7 @@ paths: application/json: schema: $ref: '#/components/schemas/inputlimitexceeded' - '415': + '422': description: Invalid Input content: application/json: From 72c8857799325e5149aa71581b22159b02e91ec1 Mon Sep 17 00:00:00 2001 From: rameshsentient <51635015+rameshsentient@users.noreply.github.com> Date: Tue, 23 Feb 2021 17:46:03 +0530 Subject: [PATCH 510/792] Update video-to-audio_convertor.yaml --- utility/video-to-audio_convertor.yaml | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/utility/video-to-audio_convertor.yaml b/utility/video-to-audio_convertor.yaml index febe39416..555f70e96 100644 --- a/utility/video-to-audio_convertor.yaml +++ b/utility/video-to-audio_convertor.yaml @@ -4,7 +4,7 @@ info: description: |+ This API is used to extract the sound from a video file and save it in an audio file. - The size of your video file should **not exceed 3.5 MB**. + The size of your video file should **not exceed 10 MB**. version: '0.1.0' x-additionalinfo: |+ Suggested Use Cases: @@ -22,7 +22,7 @@ paths: - v0.1.0 responses: '200': - description: success response + description: Ok content: application/json: schema: @@ -63,13 +63,13 @@ paths: schema: $ref: '#/components/schemas/inputfieldmissing' '413': - description: Input Limit Exceeded + description: Payload Too Large content: application/json: schema: $ref: '#/components/schemas/inputlimitexceeded' '415': - description: Invalid Input + description: Unsupported Media Type content: application/json: schema: From de48f7fe43a2734a4ef7857a02ec78153b6872f2 Mon Sep 17 00:00:00 2001 From: rameshsentient <51635015+rameshsentient@users.noreply.github.com> Date: Tue, 23 Feb 2021 17:49:57 +0530 Subject: [PATCH 511/792] Update video-to-image_convertor.yaml --- utility/video-to-image_convertor.yaml | 1 + 1 file changed, 1 insertion(+) diff --git a/utility/video-to-image_convertor.yaml b/utility/video-to-image_convertor.yaml index bb2b996ee..aae3b9a9a 100644 --- a/utility/video-to-image_convertor.yaml +++ b/utility/video-to-image_convertor.yaml @@ -5,6 +5,7 @@ info: This Utility microservice captures the images from the input video file at the frame rate of 1 frame per second. Supported formats are : 3g2, avi, flv, mkv, mov, mp4, ogv, webm, wmv, m4v with H.264 codec encoded. + The size of your video file should **not exceed 10 MB**. x-additionalinfo: |+ Suggested Use Cases: - Can be integrated into video editing software to create a quick preview of the footage the user is editing. From 56efddb940a23995be76156b505dcac7dede87a4 Mon Sep 17 00:00:00 2001 From: rameshsentient <51635015+rameshsentient@users.noreply.github.com> Date: Tue, 23 Feb 2021 17:51:08 +0530 Subject: [PATCH 512/792] Update video-to-image_convertor.yaml --- utility/video-to-image_convertor.yaml | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/utility/video-to-image_convertor.yaml b/utility/video-to-image_convertor.yaml index aae3b9a9a..9c97244b7 100644 --- a/utility/video-to-image_convertor.yaml +++ b/utility/video-to-image_convertor.yaml @@ -23,7 +23,7 @@ paths: - v0.1.0 responses: '200': - description: success response + description: Ok content: application/json: schema: @@ -64,13 +64,13 @@ paths: schema: $ref: '#/components/schemas/inputfieldmissing' '413': - description: Input Limit Exceeded + description: Payload Too Large content: application/json: schema: $ref: '#/components/schemas/inputlimitexceeded' '415': - description: Invalid Input + description: Unsupported Media Type content: application/json: schema: From 2dc3e422340cdbd11dbc0d53926278e9ec8a5f19 Mon Sep 17 00:00:00 2001 From: rameshsentient <51635015+rameshsentient@users.noreply.github.com> Date: Tue, 23 Feb 2021 17:52:51 +0530 Subject: [PATCH 513/792] Update web_scraper.yaml --- utility/web_scraper.yaml | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/utility/web_scraper.yaml b/utility/web_scraper.yaml index 565429bdb..5a7c4503e 100644 --- a/utility/web_scraper.yaml +++ b/utility/web_scraper.yaml @@ -69,7 +69,7 @@ paths: - v1.1.1 responses: '200': - description: success response + description: Ok content: application/json: schema: @@ -126,13 +126,13 @@ paths: schema: $ref: '#/components/schemas/inputfieldmissing' '413': - description: Input Limit Exceeded + description: Payload Too Large content: application/json: schema: $ref: '#/components/schemas/inputlimitexceeded' '415': - description: Invalid Input + description: Unsupported Media Type content: application/json: schema: From 631e82b9084d76fa40edf1b58697423e67765eaa Mon Sep 17 00:00:00 2001 From: rameshsentient <51635015+rameshsentient@users.noreply.github.com> Date: Tue, 23 Feb 2021 17:53:24 +0530 Subject: [PATCH 514/792] Update wikipedia_retrieval.yaml --- utility/wikipedia_retrieval.yaml | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/utility/wikipedia_retrieval.yaml b/utility/wikipedia_retrieval.yaml index 4e8891646..9e3127ba9 100644 --- a/utility/wikipedia_retrieval.yaml +++ b/utility/wikipedia_retrieval.yaml @@ -22,7 +22,7 @@ paths: - v0.1.0 responses: '200': - description: success response + description: Ok content: application/json: schema: @@ -82,13 +82,13 @@ paths: schema: $ref: '#/components/schemas/inputfieldmissing' '413': - description: Input Limit Exceeded + description: Payload Too Large content: application/json: schema: $ref: '#/components/schemas/inputlimitexceeded' '415': - description: Invalid Input + description: Unsupported Media Type content: application/json: schema: From f3af10757b6a31357961562a6662c5092d364acd Mon Sep 17 00:00:00 2001 From: rameshsentient <51635015+rameshsentient@users.noreply.github.com> Date: Tue, 23 Feb 2021 17:53:52 +0530 Subject: [PATCH 515/792] Update wikipedia_retrieval_v1.0.yaml --- utility/wikipedia_retrieval_v1.0.yaml | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/utility/wikipedia_retrieval_v1.0.yaml b/utility/wikipedia_retrieval_v1.0.yaml index b423cc9b8..e9c410354 100644 --- a/utility/wikipedia_retrieval_v1.0.yaml +++ b/utility/wikipedia_retrieval_v1.0.yaml @@ -22,7 +22,7 @@ paths: - v1.0.0 responses: '200': - description: success response + description: Ok content: application/json: schema: @@ -86,13 +86,13 @@ paths: schema: $ref: '#/components/schemas/inputfieldmissing' '413': - description: Input Limit Exceeded + description: Payload Too Large content: application/json: schema: $ref: '#/components/schemas/inputlimitexceeded' '415': - description: Invalid Input + description: Unsupported Media Type content: application/json: schema: From 2c832ef11708cc665a80c3ab2e62cd94b28cb4ff Mon Sep 17 00:00:00 2001 From: rameshsentient <51635015+rameshsentient@users.noreply.github.com> Date: Tue, 23 Feb 2021 17:54:24 +0530 Subject: [PATCH 516/792] Update youtube_video_downloader.yaml --- utility/youtube_video_downloader.yaml | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/utility/youtube_video_downloader.yaml b/utility/youtube_video_downloader.yaml index 2975beb08..a1ef415eb 100644 --- a/utility/youtube_video_downloader.yaml +++ b/utility/youtube_video_downloader.yaml @@ -20,7 +20,7 @@ paths: - v0.1.0 responses: '200': - description: success response + description: Ok content: application/json: schema: @@ -61,13 +61,13 @@ paths: schema: $ref: '#/components/schemas/inputfieldmissing' '413': - description: Input Limit Exceeded + description: Payload Too Large content: application/json: schema: $ref: '#/components/schemas/inputlimitexceeded' '415': - description: Invalid Input + description: Unsupported Media Type content: application/json: schema: From 47316cbd89c135e807a238991d3bcc64c0d0b646 Mon Sep 17 00:00:00 2001 From: rameshsentient <51635015+rameshsentient@users.noreply.github.com> Date: Wed, 24 Feb 2021 09:22:31 +0530 Subject: [PATCH 517/792] Update urls_retrieval.yaml --- utility/urls_retrieval.yaml | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/utility/urls_retrieval.yaml b/utility/urls_retrieval.yaml index 29fd3ceaf..f6234ac63 100644 --- a/utility/urls_retrieval.yaml +++ b/utility/urls_retrieval.yaml @@ -70,13 +70,13 @@ paths: schema: $ref: '#/components/schemas/inputfieldmissing' '413': - description: Input Limit Exceeded + description: Payload Too Large content: application/json: schema: $ref: '#/components/schemas/inputlimitexceeded' - '422': - description: Invalid Input + '415': + description: Unsupported Media Type content: application/json: schema: From da42166d9317e00e303e6e67b2f789c2203ca01b Mon Sep 17 00:00:00 2001 From: rameshsentient <51635015+rameshsentient@users.noreply.github.com> Date: Wed, 24 Feb 2021 17:25:45 +0530 Subject: [PATCH 518/792] Create traffic_incidents.yaml --- data/traffic_incidents.yaml | 285 ++++++++++++++++++++++++++++++++++++ 1 file changed, 285 insertions(+) create mode 100644 data/traffic_incidents.yaml diff --git a/data/traffic_incidents.yaml b/data/traffic_incidents.yaml new file mode 100644 index 000000000..2315ffc0c --- /dev/null +++ b/data/traffic_incidents.yaml @@ -0,0 +1,285 @@ +openapi: 3.0.1 +info: + title: Traffic Incidents + description: |+ + This api returns incidents currently happening on the roads, such as + Accidents, Vehicle Breakdowns, Road Blocks, Traffic Diversions etc. + + version: '0.2.0' +servers: + - url: 'https://api.sentient.io' +tags: +- name: "v0.2.0" + description: "Published Date - Feb 30, 2021" +paths: + /DaaS/dev/lta/TrafficIncidents: + get: + tags: + - v0.2.0 + responses: + '200': + description: success response + content: + application/json: + schema: + $ref: '#/components/schemas/success' + example: + odata.metadata: http://datamall2.mytransport.sg/ltaodataservice/$metadata#IncidentSet + value: + - Type: Vehicle breakdown + Latitude: 1.3765155261589948 + Longitude: 103.72976844706339 + Message: "(24/2)19:01 Vehicle breakdown on KJE (towards BKE) before Sungei Tengah + Exit." + - Type: Vehicle breakdown + Latitude: 1.3177093559093849 + Longitude: 103.84973925377123 + Message: "(24/2)18:56 Vehicle breakdown on CTE (towards AYE) after Moulmein Rd Exit. + Avoid lane 5." + - Type: Heavy Traffic + Latitude: 1.3479754506023685 + Longitude: 103.73535385312147 + Message: "(24/2)18:49 Heavy Traffic on PIE (towards Changi Airport) at Jurong Town + Hall Exit." + - Type: Heavy Traffic + Latitude: 1.3262023431265177 + Longitude: 103.9058126592148 + Message: "(24/2)18:43 Heavy Traffic on PIE (towards Changi Airport) between Paya + Lebar Rd and Jalan Eunos." + - Type: Accident + Latitude: 1.3506439481672337 + Longitude: 103.87326241750307 + Message: "(24/2)18:42 Accident on Serangoon Central (towards Serangoon Central Drive) + after Upper Serangoon Road. Avoid left lane." + - Type: Heavy Traffic + Latitude: 1.3244681744648545 + Longitude: 103.87199555510936 + Message: "(24/2)18:39 Heavy Traffic on PIE (towards Tuas) between Paya Lebar Rd + and KPE Exit." + - Type: Heavy Traffic + Latitude: 1.423537423894956 + Longitude: 103.79376756753699 + Message: "(24/2)18:37 Heavy Traffic on SLE (towards CTE) at Woodlands Ave 12 Exit." + - Type: Heavy Traffic + Latitude: 1.421704848057889 + Longitude: 103.79589714886528 + Message: "(24/2)18:36 Heavy Traffic on SLE (towards BKE) at Woodlands Ave 12 Exit." + - Type: Heavy Traffic + Latitude: 1.4189908586972941 + Longitude: 103.7708046525311 + Message: "(24/2)18:13 Heavy Traffic on BKE (towards Woodlands) at SLE Exit." + - Type: Heavy Traffic + Latitude: 1.3246268590009196 + Longitude: 103.872267738438 + Message: "(24/2)18:06 Heavy Traffic on PIE (towards Changi Airport) at KPE Exit." + - Type: Heavy Traffic + Latitude: 1.2838074370179324 + Longitude: 103.8066088698767 + Message: "(24/2)18:03 Heavy Traffic on AYE (towards MCE) between Buona Vista Exit + and Alexandra." + - Type: Vehicle breakdown + Latitude: 1.2990111766105807 + Longitude: 103.90254595653626 + Message: "(24/2)18:02 Vehicle breakdown on ECP (towards Changi Airport) before Still + Rd Sth Exit. Avoid lane 4." + - Type: Roadwork + Latitude: 1.3497992256482165 + Longitude: 103.7091860681545 + Message: "(24/2)17:06 Roadworks on Jurong West Avenue 2 towards Jurong West Street + 23." + - Type: Roadwork + Latitude: 1.396968671445086 + Longitude: 103.81851492215516 + Message: "(24/2)14:11 Roadworks on Upper Thomson Road (towards Newton) after Mandai + Road." + - Type: Roadwork + Latitude: 1.3963103220975503 + Longitude: 103.81860207958121 + Message: "(24/2)14:09 Roadworks on Upper Thomson Road (towards SLE) after SLE." + '401': + description: Unauthorized + content: + application/json: + schema: + $ref: '#/components/schemas/unauthorized' + '402': + description: Payment Required + content: + application/json: + schema: + $ref: '#/components/schemas/paymentrequired' + '403': + description: Forbidden + content: + application/json: + schema: + $ref: '#/components/schemas/forbidden' + '404': + description: Not Found + content: + application/json: + schema: + $ref: '#/components/schemas/notfound' + '419': + description: Input Field Missing + content: + application/json: + schema: + $ref: '#/components/schemas/inputfieldmissing' + '420': + description: Input Limit Exceeded + content: + application/json: + schema: + $ref: '#/components/schemas/inputlimitexceeded' + '422': + description: Invalid Input + content: + application/json: + schema: + $ref: '#/components/schemas/invalidinput' + '500': + description: Internal Server Error + content: + application/json: + schema: + $ref: '#/components/schemas/servererror' + '504': + description: Gateway Timeout + content: + application/json: + schema: + $ref: '#/components/schemas/gatewaytimeout' + security: + - APIAuthorizer: [] +components: + schemas: + success: + type: object + properties: + odata.metadata: + type: string + example: http://datamall2.mytransport.sg/ltaodataservice/$metadata#IncidentSet + description: url + value: + type: array + example: [{ + "Type": "Vehicle breakdown", + "Latitude": 1.3765155261589948, + "Longitude": 103.72976844706339, + "Message": "(24/2)19:01 Vehicle breakdown on KJE (towards BKE) before Sungei Tengah Exit." + }] + description: + Incident Types. + • Accident + • Road Works + • Vehicle Breakdown + • Weather + • Obstacle + • Road Block + • Heavy Traffic + • Misc. + • Diversion + • Unattended Vehicle + items: + oneOf: + - type: string + example: Accident + unauthorized: + type: object + properties: + message: + type: string + example: Missing Authentication Token + status: + type: string + example: Failure + forbidden: + type: object + properties: + message: + type: string + example: Access Denied Unauthorized User + status: + type: string + example: Failure + paymentrequired: + type: object + properties: + message: + type: string + example: Insufficient Credits Kindly Top Up + status: + type: string + example: Failure + notfound: + type: object + properties: + message: + type: string + example: Invalid Request URL + status: + type: string + example: Failure + servererror: + type: object + properties: + message: + type: string + example: Internal Server Error + status: + type: string + example: Failure + gatewaytimeout: + type: object + properties: + message: + type: string + example: Request Timeout + status: + type: string + example: Failure + inputfieldmissing: + type: object + properties: + message: + type: string + example: Input Field Missing + status: + type: string + example: Failure + inputlimitexceeded: + type: object + properties: + message: + type: string + example: Input Limit Exceeded + status: + type: string + example: Failure + invalidinput: + type: object + properties: + message: + type: string + example: Invalid Input + status: + type: string + example: Failure + versions: + type: object + properties: + v0.1.0: + type: array + items: + oneOf: + - type: string + example: Published Date - Feb 30, 2021 + description: Initial version release + securitySchemes: + APIAuthorizer: + type: apiKey + name: x-api-key + in: header + x-amazon-apigateway-authtype: custom + description: Authentication is done using the x-api-key in the request header. From a36a728388c0bee95b4e64df913f5d861ba4e00a Mon Sep 17 00:00:00 2001 From: rameshsentient <51635015+rameshsentient@users.noreply.github.com> Date: Wed, 24 Feb 2021 17:27:32 +0530 Subject: [PATCH 519/792] Update index.yaml --- index.yaml | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/index.yaml b/index.yaml index 2c3128b46..21fc94ef7 100644 --- a/index.yaml +++ b/index.yaml @@ -280,6 +280,10 @@ data: title: IHI Point Cloud versions: 0.1.0: 'ihi_data_pointcloud.yaml' + traffic_incidents: + title: Traffic Incidents + versions: + 0.1.0: 'traffic_incidents.yaml' data alliance: download_dataset_api: title: Download Dataset API From 9c71420d6c53fe60e490ca236cce519b7dd1ce21 Mon Sep 17 00:00:00 2001 From: rameshsentient <51635015+rameshsentient@users.noreply.github.com> Date: Wed, 24 Feb 2021 17:42:46 +0530 Subject: [PATCH 520/792] Update traffic_incidents.yaml --- data/traffic_incidents.yaml | 36 ++++++++++++------------------------ 1 file changed, 12 insertions(+), 24 deletions(-) diff --git a/data/traffic_incidents.yaml b/data/traffic_incidents.yaml index 2315ffc0c..04933d3c0 100644 --- a/data/traffic_incidents.yaml +++ b/data/traffic_incidents.yaml @@ -16,6 +16,18 @@ paths: get: tags: - v0.2.0 + parameters: + - in: query + name: querystring + schema: + type: string + description: |+ + Simple keyword search for matches in all searchable fields. Keywords separated by spaces will return results containing any of those keywords. For exact phrase match, put entire phrase in double quotes (" "). + + If this field is set to null, by default the microservice will return all carparks (within the stated limit), which can be further refined through the filterdata field for more sophisticated queries. + + example: BE33 + default: false responses: '200': description: success response @@ -161,30 +173,6 @@ components: type: string example: http://datamall2.mytransport.sg/ltaodataservice/$metadata#IncidentSet description: url - value: - type: array - example: [{ - "Type": "Vehicle breakdown", - "Latitude": 1.3765155261589948, - "Longitude": 103.72976844706339, - "Message": "(24/2)19:01 Vehicle breakdown on KJE (towards BKE) before Sungei Tengah Exit." - }] - description: - Incident Types. - • Accident - • Road Works - • Vehicle Breakdown - • Weather - • Obstacle - • Road Block - • Heavy Traffic - • Misc. - • Diversion - • Unattended Vehicle - items: - oneOf: - - type: string - example: Accident unauthorized: type: object properties: From 480f37173b18e98931e7810f5f8c7a6a9d4195d5 Mon Sep 17 00:00:00 2001 From: rameshsentient <51635015+rameshsentient@users.noreply.github.com> Date: Thu, 25 Feb 2021 10:20:01 +0530 Subject: [PATCH 521/792] Create weather --- data/weather | 375 +++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 375 insertions(+) create mode 100644 data/weather diff --git a/data/weather b/data/weather new file mode 100644 index 000000000..5437fee6a --- /dev/null +++ b/data/weather @@ -0,0 +1,375 @@ +openapi: 3.0.1 +info: + title: Weather Api + description: |+ + Current weather or realtime weather API method allows a user to get up to date current weather information. The data is returned as a Current Object. + + Current object contains current or realtime weather information for a given city. + + version: '0.2.0' +servers: + - url: 'https://dev-apis.sentient.io' +tags: +- name: "v0.1.0" + description: "Published Date - Feb 30, 2021" +paths: + /microservices/data/weather/v0/getdata: + post: + tags: + - v0.1.0 + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/success' + example: + current: + cloud: 25 + condition: + code: 1030 + icon: "//cdn.weatherapi.com/weather/64x64/day/143.png" + text: Mist + feelslike_c: 25.7 + feelslike_f: 78.3 + gust_kph: 7.9 + gust_mph: 4.9 + humidity: 83 + is_day: 1 + last_updated: 2021-02-25 08:30 + last_updated_epoch: 1614222011 + precip_in: 0 + precip_mm: 0 + pressure_in: 30.4 + pressure_mb: 1013 + temp_c: 24 + temp_f: 75.2 + uv: 1 + vis_km: 1.5 + vis_miles: 0 + wind_degree: 320 + wind_dir: NW + wind_kph: 6.1 + wind_mph: 3.8 + location: + country: India + lat: 13.08 + localtime: 2021-02-25 8:31 + localtime_epoch: 1614222076 + lon: 80.28 + name: Chennai + region: Tamil Nadu + tz_id: Asia/Kolkata + '401': + description: Unauthorized + content: + application/json: + schema: + $ref: '#/components/schemas/unauthorized' + '402': + description: Payment Required + content: + application/json: + schema: + $ref: '#/components/schemas/paymentrequired' + '403': + description: Forbidden + content: + application/json: + schema: + $ref: '#/components/schemas/forbidden' + '404': + description: Not Found + content: + application/json: + schema: + $ref: '#/components/schemas/notfound' + '419': + description: Input Field Missing + content: + application/json: + schema: + $ref: '#/components/schemas/inputfieldmissing' + '420': + description: Input Limit Exceeded + content: + application/json: + schema: + $ref: '#/components/schemas/inputlimitexceeded' + '422': + description: Invalid Input + content: + application/json: + schema: + $ref: '#/components/schemas/invalidinput' + '500': + description: Internal Server Error + content: + application/json: + schema: + $ref: '#/components/schemas/servererror' + '504': + description: Gateway Timeout + content: + application/json: + schema: + $ref: '#/components/schemas/gatewaytimeout' + security: + - APIAuthorizer: [] +components: + schemas: + success: + type: object + properties: + current: + type: object + properties: + cloud: + type: integer + example: 25 + description: Cloud cover as percentage + condition: + type: object + properties: + code: + type: number + example: 1030 + description: Weather condition unique code. + icon: + type: string + example: //cdn.weatherapi.com/weather/64x64/day/143.png + description: Weather icon url. + text: + type: string + example: mist + description: Weather condition text. + feelslike_c: + type: number + example: 25.7 + description: Feels like temperature in celsius + feelslike_f: + type: number + example: 78.3 + description: Feels like temperature in fahrenheit + gust_kph: + type: number + example: 7.9 + description: Wind gust in kilometer per hour + gust_mph: + type: number + example: 4.9 + description: Wind gust in miles per hour + humidity: + type: number + example: 83 + description: Humidity as percentage + is_day: + type: number + example: 1 + description: 1 = Yes 0 = No + Whether to show day condition icon or night icon + last_updated: + type: string + example: 2021-02-25 08:30 + description: Local time when the real time data was updated. + last_updated_epoch: + type: number + example: 21614222011 + description: Local time when the real time data was updated in unix time. + precip_in: + type: number + example: 0.0 + description: Precipitation amount in inches + precip_mm: + type: number + example: 0.0 + description: Precipitation amount in millimeters + pressure_in: + type: number + example: 30.4 + description: Pressure in inches + pressure_mb: + type: number + example: 1013.0 + description: Pressure in millibars + temp_c: + type: number + example: 24.0 + description: Temperature in celsius + temp_f: + type: number + example: 75.2 + description: Temperature in fahrenheit + uv: + type: number + example: 1.0 + description: UV Index + vis_km: + type: number + example: 1.5 + description: Average visibility in kilometer + vis_miles: + type: number + example: 0.0 + description: Average visibility in miles + wind_degree: + type: number + example: 320 + description: Wind direction in degrees + wind_dir: + type: string + example: "NW" + description: Wind direction as 16 point compass. e.g.- NSW + wind_kph: + type: number + example: 6.1 + description: Wind speed in kilometer per hour + wind_mph: + type: number + example: 3.8 + description: Wind speed in miles per hour + location: + type: object + properties: + country: + type: string + example: India + description: Name of country + lat: + type: number + example: 13.08 + description: Latitude in decimal degree + localtime: + type: string + example: 2021-02-25 8:31 + description: Latitude in decimal degree + localtime_epoch: + type: number + example: 1614222076 + description: Time as epoch + lon: + type: number + example: 80.28 + description: Longitude in decimal degree + name: + type: string + example: Chennai + description: City name + region: + type: string + example: Tamil Nadu + description: Region name + tz_id: + type: string + example: Asia/Kolkata + description: Time zone + unauthorized: + type: object + properties: + message: + type: string + example: Missing Authentication Token + status: + type: string + example: Failure + forbidden: + type: object + properties: + message: + type: string + example: Access Denied Unauthorized User + status: + type: string + example: Failure + paymentrequired: + type: object + properties: + message: + type: string + example: Insufficient Credits Kindly Top Up + status: + type: string + example: Failure + notfound: + type: object + properties: + message: + type: string + example: Invalid Request URL + status: + type: string + example: Failure + servererror: + type: object + properties: + message: + type: string + example: Internal Server Error + status: + type: string + example: Failure + gatewaytimeout: + type: object + properties: + message: + type: string + example: Request Timeout + status: + type: string + example: Failure + inputfieldmissing: + type: object + properties: + message: + type: string + example: Input Field Missing + status: + type: string + example: Failure + inputlimitexceeded: + type: object + properties: + message: + type: string + example: Input Limit Exceeded + status: + type: string + example: Failure + invalidinput: + type: object + properties: + message: + type: string + example: Invalid Input + status: + type: string + example: Failure + versions: + type: object + properties: + v0.1.0: + type: array + items: + oneOf: + - type: string + example: Published Date - Feb 30, 2021 + description: Initial version release + input: + type: object + required: + - city + properties: + city: + type: string + default: true + example: chennai + description: city name + + securitySchemes: + APIAuthorizer: + type: apiKey + name: x-api-key + in: header + x-amazon-apigateway-authtype: custom + description: Authentication is done using the x-api-key in the request header. From 2b688afd515cae87cd70709cd83f363897c390e0 Mon Sep 17 00:00:00 2001 From: rameshsentient <51635015+rameshsentient@users.noreply.github.com> Date: Thu, 25 Feb 2021 10:20:39 +0530 Subject: [PATCH 522/792] Rename weather to weather.yaml --- data/{weather => weather.yaml} | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename data/{weather => weather.yaml} (100%) diff --git a/data/weather b/data/weather.yaml similarity index 100% rename from data/weather rename to data/weather.yaml From 7aa88e99ad5d1952c6c26d46e0edc52a41699431 Mon Sep 17 00:00:00 2001 From: rameshsentient <51635015+rameshsentient@users.noreply.github.com> Date: Thu, 25 Feb 2021 10:21:47 +0530 Subject: [PATCH 523/792] Update index.yaml --- index.yaml | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/index.yaml b/index.yaml index 21fc94ef7..bce7b10d6 100644 --- a/index.yaml +++ b/index.yaml @@ -283,7 +283,11 @@ data: traffic_incidents: title: Traffic Incidents versions: - 0.1.0: 'traffic_incidents.yaml' + 0.1.0: 'traffic_incidents.yaml' + weather: + title: Weather Api + versions: + 0.1.0: 'weather.yaml' data alliance: download_dataset_api: title: Download Dataset API From 3264f13acf6b7a178395ef0f63b55abffeefb916 Mon Sep 17 00:00:00 2001 From: rameshsentient <51635015+rameshsentient@users.noreply.github.com> Date: Thu, 25 Feb 2021 10:31:43 +0530 Subject: [PATCH 524/792] Update weather.yaml --- data/weather.yaml | 62 +++++++++++++++++++++++++++++++---------------- 1 file changed, 41 insertions(+), 21 deletions(-) diff --git a/data/weather.yaml b/data/weather.yaml index 5437fee6a..359b58495 100644 --- a/data/weather.yaml +++ b/data/weather.yaml @@ -6,7 +6,7 @@ info: Current object contains current or realtime weather information for a given city. - version: '0.2.0' + version: '0.1.0' servers: - url: 'https://dev-apis.sentient.io' tags: @@ -19,7 +19,7 @@ paths: - v0.1.0 responses: '200': - description: OK + description: Ok content: application/json: schema: @@ -60,7 +60,13 @@ paths: lon: 80.28 name: Chennai region: Tamil Nadu - tz_id: Asia/Kolkata + tz_id: Asia/Kolkata + '400': + description: Restricted + content: + application/json: + schema: + $ref: '#/components/schemas/restricted' '401': description: Unauthorized content: @@ -91,14 +97,14 @@ paths: application/json: schema: $ref: '#/components/schemas/inputfieldmissing' - '420': - description: Input Limit Exceeded + '413': + description: Payload Too Large content: application/json: schema: - $ref: '#/components/schemas/inputlimitexceeded' - '422': - description: Invalid Input + $ref: '#/components/schemas/inputlimitexceeded' + '415': + description: Unsupported Media Type content: application/json: schema: @@ -117,6 +123,12 @@ paths: $ref: '#/components/schemas/gatewaytimeout' security: - APIAuthorizer: [] + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/input' + required: true components: schemas: success: @@ -263,7 +275,7 @@ components: tz_id: type: string example: Asia/Kolkata - description: Time zone + description: Time zone unauthorized: type: object properties: @@ -273,6 +285,15 @@ components: status: type: string example: Failure + restricted: + type: object + properties: + message: + type: string + example: The content is restricted + status: + type: string + example: Failure forbidden: type: object properties: @@ -296,7 +317,16 @@ components: properties: message: type: string - example: Invalid Request URL + example: Invalid Request + status: + type: string + example: Failure + invalidinput: + type: object + properties: + message: + type: string + example: Invalid Input status: type: string example: Failure @@ -336,15 +366,6 @@ components: status: type: string example: Failure - invalidinput: - type: object - properties: - message: - type: string - example: Invalid Input - status: - type: string - example: Failure versions: type: object properties: @@ -365,11 +386,10 @@ components: default: true example: chennai description: city name - securitySchemes: APIAuthorizer: type: apiKey name: x-api-key in: header x-amazon-apigateway-authtype: custom - description: Authentication is done using the x-api-key in the request header. + description: Authentication is done using the x-api-key in the request header From 454a353f29059979f794bd90dd09b93e2c03f71e Mon Sep 17 00:00:00 2001 From: rameshsentient <51635015+rameshsentient@users.noreply.github.com> Date: Thu, 25 Feb 2021 10:33:16 +0530 Subject: [PATCH 525/792] Update index.yaml --- index.yaml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/index.yaml b/index.yaml index bce7b10d6..39dcbca1e 100644 --- a/index.yaml +++ b/index.yaml @@ -284,10 +284,10 @@ data: title: Traffic Incidents versions: 0.1.0: 'traffic_incidents.yaml' - weather: + realtime_weather: title: Weather Api versions: - 0.1.0: 'weather.yaml' + 0.1.0: 'weather_api.yaml' data alliance: download_dataset_api: title: Download Dataset API From 5e9634558cf43aa571343dcec28cda93c88aaeee Mon Sep 17 00:00:00 2001 From: rameshsentient <51635015+rameshsentient@users.noreply.github.com> Date: Thu, 25 Feb 2021 10:33:28 +0530 Subject: [PATCH 526/792] Rename weather.yaml to weather_api.yaml --- data/{weather.yaml => weather_api.yaml} | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename data/{weather.yaml => weather_api.yaml} (100%) diff --git a/data/weather.yaml b/data/weather_api.yaml similarity index 100% rename from data/weather.yaml rename to data/weather_api.yaml From 02babf97e762dbf97ee27a3277dd64447acc2f10 Mon Sep 17 00:00:00 2001 From: rameshsentient <51635015+rameshsentient@users.noreply.github.com> Date: Thu, 25 Feb 2021 10:44:01 +0530 Subject: [PATCH 527/792] Update weather_api.yaml --- data/weather_api.yaml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/data/weather_api.yaml b/data/weather_api.yaml index 359b58495..a22fcdf9c 100644 --- a/data/weather_api.yaml +++ b/data/weather_api.yaml @@ -11,7 +11,7 @@ servers: - url: 'https://dev-apis.sentient.io' tags: - name: "v0.1.0" - description: "Published Date - Feb 30, 2021" + description: "Published Date - Feb 28, 2021" paths: /microservices/data/weather/v0/getdata: post: @@ -374,7 +374,7 @@ components: items: oneOf: - type: string - example: Published Date - Feb 30, 2021 + example: Published Date - Feb 28, 2021 description: Initial version release input: type: object From 5950ebdf9f59f5ad99eabe26c44f57591238de8a Mon Sep 17 00:00:00 2001 From: rameshsentient <51635015+rameshsentient@users.noreply.github.com> Date: Thu, 25 Feb 2021 11:42:35 +0530 Subject: [PATCH 528/792] Update traffic_incidents.yaml --- data/traffic_incidents.yaml | 136 ++++++++++++------------------------ 1 file changed, 46 insertions(+), 90 deletions(-) diff --git a/data/traffic_incidents.yaml b/data/traffic_incidents.yaml index 04933d3c0..15880d9a2 100644 --- a/data/traffic_incidents.yaml +++ b/data/traffic_incidents.yaml @@ -2,35 +2,22 @@ openapi: 3.0.1 info: title: Traffic Incidents description: |+ - This api returns incidents currently happening on the roads, such as + Returns incidents currently happening on the roads, such as Accidents, Vehicle Breakdowns, Road Blocks, Traffic Diversions etc. - - version: '0.2.0' + version: '0.1.0' servers: - url: 'https://api.sentient.io' tags: -- name: "v0.2.0" - description: "Published Date - Feb 30, 2021" +- name: "v0.1.0" + description: "Published Date - Feb 28, 2021" paths: /DaaS/dev/lta/TrafficIncidents: get: tags: - - v0.2.0 - parameters: - - in: query - name: querystring - schema: - type: string - description: |+ - Simple keyword search for matches in all searchable fields. Keywords separated by spaces will return results containing any of those keywords. For exact phrase match, put entire phrase in double quotes (" "). - - If this field is set to null, by default the microservice will return all carparks (within the stated limit), which can be further refined through the filterdata field for more sophisticated queries. - - example: BE33 - default: false + - v0.1.0 responses: '200': - description: success response + description: Ok content: application/json: schema: @@ -38,76 +25,10 @@ paths: example: odata.metadata: http://datamall2.mytransport.sg/ltaodataservice/$metadata#IncidentSet value: - - Type: Vehicle breakdown + - Type: Roadwork Latitude: 1.3765155261589948 Longitude: 103.72976844706339 - Message: "(24/2)19:01 Vehicle breakdown on KJE (towards BKE) before Sungei Tengah - Exit." - - Type: Vehicle breakdown - Latitude: 1.3177093559093849 - Longitude: 103.84973925377123 - Message: "(24/2)18:56 Vehicle breakdown on CTE (towards AYE) after Moulmein Rd Exit. - Avoid lane 5." - - Type: Heavy Traffic - Latitude: 1.3479754506023685 - Longitude: 103.73535385312147 - Message: "(24/2)18:49 Heavy Traffic on PIE (towards Changi Airport) at Jurong Town - Hall Exit." - - Type: Heavy Traffic - Latitude: 1.3262023431265177 - Longitude: 103.9058126592148 - Message: "(24/2)18:43 Heavy Traffic on PIE (towards Changi Airport) between Paya - Lebar Rd and Jalan Eunos." - - Type: Accident - Latitude: 1.3506439481672337 - Longitude: 103.87326241750307 - Message: "(24/2)18:42 Accident on Serangoon Central (towards Serangoon Central Drive) - after Upper Serangoon Road. Avoid left lane." - - Type: Heavy Traffic - Latitude: 1.3244681744648545 - Longitude: 103.87199555510936 - Message: "(24/2)18:39 Heavy Traffic on PIE (towards Tuas) between Paya Lebar Rd - and KPE Exit." - - Type: Heavy Traffic - Latitude: 1.423537423894956 - Longitude: 103.79376756753699 - Message: "(24/2)18:37 Heavy Traffic on SLE (towards CTE) at Woodlands Ave 12 Exit." - - Type: Heavy Traffic - Latitude: 1.421704848057889 - Longitude: 103.79589714886528 - Message: "(24/2)18:36 Heavy Traffic on SLE (towards BKE) at Woodlands Ave 12 Exit." - - Type: Heavy Traffic - Latitude: 1.4189908586972941 - Longitude: 103.7708046525311 - Message: "(24/2)18:13 Heavy Traffic on BKE (towards Woodlands) at SLE Exit." - - Type: Heavy Traffic - Latitude: 1.3246268590009196 - Longitude: 103.872267738438 - Message: "(24/2)18:06 Heavy Traffic on PIE (towards Changi Airport) at KPE Exit." - - Type: Heavy Traffic - Latitude: 1.2838074370179324 - Longitude: 103.8066088698767 - Message: "(24/2)18:03 Heavy Traffic on AYE (towards MCE) between Buona Vista Exit - and Alexandra." - - Type: Vehicle breakdown - Latitude: 1.2990111766105807 - Longitude: 103.90254595653626 - Message: "(24/2)18:02 Vehicle breakdown on ECP (towards Changi Airport) before Still - Rd Sth Exit. Avoid lane 4." - - Type: Roadwork - Latitude: 1.3497992256482165 - Longitude: 103.7091860681545 - Message: "(24/2)17:06 Roadworks on Jurong West Avenue 2 towards Jurong West Street - 23." - - Type: Roadwork - Latitude: 1.396968671445086 - Longitude: 103.81851492215516 - Message: "(24/2)14:11 Roadworks on Upper Thomson Road (towards Newton) after Mandai - Road." - - Type: Roadwork - Latitude: 1.3963103220975503 - Longitude: 103.81860207958121 - Message: "(24/2)14:09 Roadworks on Upper Thomson Road (towards SLE) after SLE." + Message: "(25/2)13:13 Roadworks on Boon Lay Way (towards City) after Jalan Boon Lay. Avoid right lane." '401': description: Unauthorized content: @@ -138,13 +59,13 @@ paths: application/json: schema: $ref: '#/components/schemas/inputfieldmissing' - '420': + '413': description: Input Limit Exceeded content: application/json: schema: $ref: '#/components/schemas/inputlimitexceeded' - '422': + '415': description: Invalid Input content: application/json: @@ -173,6 +94,41 @@ components: type: string example: http://datamall2.mytransport.sg/ltaodataservice/$metadata#IncidentSet description: url + value: + type: array + items: + type: object + properties: + Type: + type: string + example: Roadwork + description: + Incident Types - + • Accident + • Road Works + • Vehicle Breakdown + • Weather + • Obstacle + • Road Block + • Heavy Traffic + • Misc. + • Diversion + • Unattended Vehicle + Latitude: + type: string + example: 1.3415018509600185 + description: Latitude map coordinates for the + start point of this road incident + Longitude: + type: string + example: 103.71215415465709 + description: Longitude map coordinates for + the start point of this incident + Message: + type: string + example: (25/2)13:13 Roadworks on Boon Lay Way (towards City) after Jalan Boon Lay. Avoid right lane. + description: Description message for this incident + unauthorized: type: object properties: @@ -262,7 +218,7 @@ components: items: oneOf: - type: string - example: Published Date - Feb 30, 2021 + example: Published Date - Feb 28, 2021 description: Initial version release securitySchemes: APIAuthorizer: From 12f2b9488eb668ace65ef11eb5a18f7f102c94dd Mon Sep 17 00:00:00 2001 From: rameshsentient <51635015+rameshsentient@users.noreply.github.com> Date: Thu, 25 Feb 2021 11:44:14 +0530 Subject: [PATCH 529/792] Update traffic_incidents.yaml From 89bd8731e936b955c073f6924a876153f90a9059 Mon Sep 17 00:00:00 2001 From: rameshsentient <51635015+rameshsentient@users.noreply.github.com> Date: Thu, 25 Feb 2021 11:53:35 +0530 Subject: [PATCH 530/792] Update traffic_incidents.yaml From 295c41bb2c4d94a592a8a63783672132c754bdce Mon Sep 17 00:00:00 2001 From: rameshsentient <51635015+rameshsentient@users.noreply.github.com> Date: Thu, 25 Feb 2021 12:08:51 +0530 Subject: [PATCH 531/792] Create faulty_traffic_lights.yaml --- data/faulty_traffic_lights.yaml | 235 ++++++++++++++++++++++++++++++++ 1 file changed, 235 insertions(+) create mode 100644 data/faulty_traffic_lights.yaml diff --git a/data/faulty_traffic_lights.yaml b/data/faulty_traffic_lights.yaml new file mode 100644 index 000000000..7818de255 --- /dev/null +++ b/data/faulty_traffic_lights.yaml @@ -0,0 +1,235 @@ +openapi: 3.0.1 +info: + title: FAULTY TRAFFIC LIGHTS + description: |+ + Returns alerts of traffic lights that are currently faulty, or currently + undergoing scheduled maintenance. + 2 minutes – whenever there are updates + version: '0.1.0' +servers: + - url: 'https://api.sentient.io' +tags: +- name: "v0.1.0" + description: "Published Date - Feb 28, 2021" +paths: + /DaaS/dev/lta/FaultyTrafficLights: + get: + tags: + - v0.1.0 + responses: + '200': + description: Ok + content: + application/json: + schema: + $ref: '#/components/schemas/success' + example: + odata.metadata: http://datamall2.mytransport.sg/ltaodataservice/$metadata#IncidentSet + value: + - AlarmID: GL703034136 + NodeID: 703034136 + Type: 13 + StartDate: 2014-04-12 01:58:00.0 + EndDate: 2014-04-13 01:58:00.0 + Message: (23/1)8:58 Flashing Yellow at + Bedok North Interchange/Bedok + North Street 1 Junc + '401': + description: Unauthorized + content: + application/json: + schema: + $ref: '#/components/schemas/unauthorized' + '402': + description: Payment Required + content: + application/json: + schema: + $ref: '#/components/schemas/paymentrequired' + '403': + description: Forbidden + content: + application/json: + schema: + $ref: '#/components/schemas/forbidden' + '404': + description: Not Found + content: + application/json: + schema: + $ref: '#/components/schemas/notfound' + '419': + description: Input Field Missing + content: + application/json: + schema: + $ref: '#/components/schemas/inputfieldmissing' + '413': + description: Input Limit Exceeded + content: + application/json: + schema: + $ref: '#/components/schemas/inputlimitexceeded' + '415': + description: Invalid Input + content: + application/json: + schema: + $ref: '#/components/schemas/invalidinput' + '500': + description: Internal Server Error + content: + application/json: + schema: + $ref: '#/components/schemas/servererror' + '504': + description: Gateway Timeout + content: + application/json: + schema: + $ref: '#/components/schemas/gatewaytimeout' + security: + - APIAuthorizer: [] +components: + schemas: + success: + type: object + properties: + odata.metadata: + type: string + example: http://datamall2.mytransport.sg/ltaodataservice/$metadata#FaultyTrafficLights + description: url + value: + type: array + items: + type: object + properties: + AlarmID: + type: string + example: GL703034136 + description: Technical alarm ID + NodeID: + type: string + example: 703034136 + description: A unique code to represent each + unique traffic light node + Type: + type: number + example: 13 + description: Type of the technical alarm + • 4 (Blackout) + • 13 (Flashing Yellow) + StartDate: + type: string + example: 2014-04-12 01:58:00.0 + description: YYYY-MM-DD HH:MM:SS.ms + EndDate: + type: string + example: 2014-04-13 01:58:00.0 + description: YYYY-MM-DD HH:MM:SS.ms + (empty field if this is not a + scheduled maintenance) + Message: + type: string + example: (23/1)8:58 Flashing Yellow at + Bedok North Interchange/Bedok + North Street 1 Junc + description: Canning Message + unauthorized: + type: object + properties: + message: + type: string + example: Missing Authentication Token + status: + type: string + example: Failure + forbidden: + type: object + properties: + message: + type: string + example: Access Denied Unauthorized User + status: + type: string + example: Failure + paymentrequired: + type: object + properties: + message: + type: string + example: Insufficient Credits Kindly Top Up + status: + type: string + example: Failure + notfound: + type: object + properties: + message: + type: string + example: Invalid Request URL + status: + type: string + example: Failure + servererror: + type: object + properties: + message: + type: string + example: Internal Server Error + status: + type: string + example: Failure + gatewaytimeout: + type: object + properties: + message: + type: string + example: Request Timeout + status: + type: string + example: Failure + inputfieldmissing: + type: object + properties: + message: + type: string + example: Input Field Missing + status: + type: string + example: Failure + inputlimitexceeded: + type: object + properties: + message: + type: string + example: Input Limit Exceeded + status: + type: string + example: Failure + invalidinput: + type: object + properties: + message: + type: string + example: Invalid Input + status: + type: string + example: Failure + versions: + type: object + properties: + v0.1.0: + type: array + items: + oneOf: + - type: string + example: Published Date - Feb 28, 2021 + description: Initial version release + securitySchemes: + APIAuthorizer: + type: apiKey + name: x-api-key + in: header + x-amazon-apigateway-authtype: custom + description: Authentication is done using the x-api-key in the request header. From 6be2c10d0163c3dc3386694a387dd8a11b9d133e Mon Sep 17 00:00:00 2001 From: rameshsentient <51635015+rameshsentient@users.noreply.github.com> Date: Thu, 25 Feb 2021 12:10:15 +0530 Subject: [PATCH 532/792] Update faulty_traffic_lights.yaml --- data/faulty_traffic_lights.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/data/faulty_traffic_lights.yaml b/data/faulty_traffic_lights.yaml index 7818de255..28aa538ae 100644 --- a/data/faulty_traffic_lights.yaml +++ b/data/faulty_traffic_lights.yaml @@ -1,6 +1,6 @@ openapi: 3.0.1 info: - title: FAULTY TRAFFIC LIGHTS + title: Faulty Traffic Lights description: |+ Returns alerts of traffic lights that are currently faulty, or currently undergoing scheduled maintenance. From 892ed8843822a984755b74a2cbe4ca915e3803f0 Mon Sep 17 00:00:00 2001 From: rameshsentient <51635015+rameshsentient@users.noreply.github.com> Date: Thu, 25 Feb 2021 12:10:41 +0530 Subject: [PATCH 533/792] Update index.yaml --- index.yaml | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/index.yaml b/index.yaml index 39dcbca1e..e93e7e443 100644 --- a/index.yaml +++ b/index.yaml @@ -284,6 +284,10 @@ data: title: Traffic Incidents versions: 0.1.0: 'traffic_incidents.yaml' + faulty_traffic_lights: + title: Faulty Traffic Lights + versions: + 0.1.0: 'faulty_traffic_lights.yaml' realtime_weather: title: Weather Api versions: From 62fe01dafb52460ed9f8532e60e88177b0acec8d Mon Sep 17 00:00:00 2001 From: rameshsentient <51635015+rameshsentient@users.noreply.github.com> Date: Thu, 25 Feb 2021 12:15:00 +0530 Subject: [PATCH 534/792] Delete traffic_incidents.yaml --- data/traffic_incidents.yaml | 229 ------------------------------------ 1 file changed, 229 deletions(-) delete mode 100644 data/traffic_incidents.yaml diff --git a/data/traffic_incidents.yaml b/data/traffic_incidents.yaml deleted file mode 100644 index 15880d9a2..000000000 --- a/data/traffic_incidents.yaml +++ /dev/null @@ -1,229 +0,0 @@ -openapi: 3.0.1 -info: - title: Traffic Incidents - description: |+ - Returns incidents currently happening on the roads, such as - Accidents, Vehicle Breakdowns, Road Blocks, Traffic Diversions etc. - version: '0.1.0' -servers: - - url: 'https://api.sentient.io' -tags: -- name: "v0.1.0" - description: "Published Date - Feb 28, 2021" -paths: - /DaaS/dev/lta/TrafficIncidents: - get: - tags: - - v0.1.0 - responses: - '200': - description: Ok - content: - application/json: - schema: - $ref: '#/components/schemas/success' - example: - odata.metadata: http://datamall2.mytransport.sg/ltaodataservice/$metadata#IncidentSet - value: - - Type: Roadwork - Latitude: 1.3765155261589948 - Longitude: 103.72976844706339 - Message: "(25/2)13:13 Roadworks on Boon Lay Way (towards City) after Jalan Boon Lay. Avoid right lane." - '401': - description: Unauthorized - content: - application/json: - schema: - $ref: '#/components/schemas/unauthorized' - '402': - description: Payment Required - content: - application/json: - schema: - $ref: '#/components/schemas/paymentrequired' - '403': - description: Forbidden - content: - application/json: - schema: - $ref: '#/components/schemas/forbidden' - '404': - description: Not Found - content: - application/json: - schema: - $ref: '#/components/schemas/notfound' - '419': - description: Input Field Missing - content: - application/json: - schema: - $ref: '#/components/schemas/inputfieldmissing' - '413': - description: Input Limit Exceeded - content: - application/json: - schema: - $ref: '#/components/schemas/inputlimitexceeded' - '415': - description: Invalid Input - content: - application/json: - schema: - $ref: '#/components/schemas/invalidinput' - '500': - description: Internal Server Error - content: - application/json: - schema: - $ref: '#/components/schemas/servererror' - '504': - description: Gateway Timeout - content: - application/json: - schema: - $ref: '#/components/schemas/gatewaytimeout' - security: - - APIAuthorizer: [] -components: - schemas: - success: - type: object - properties: - odata.metadata: - type: string - example: http://datamall2.mytransport.sg/ltaodataservice/$metadata#IncidentSet - description: url - value: - type: array - items: - type: object - properties: - Type: - type: string - example: Roadwork - description: - Incident Types - - • Accident - • Road Works - • Vehicle Breakdown - • Weather - • Obstacle - • Road Block - • Heavy Traffic - • Misc. - • Diversion - • Unattended Vehicle - Latitude: - type: string - example: 1.3415018509600185 - description: Latitude map coordinates for the - start point of this road incident - Longitude: - type: string - example: 103.71215415465709 - description: Longitude map coordinates for - the start point of this incident - Message: - type: string - example: (25/2)13:13 Roadworks on Boon Lay Way (towards City) after Jalan Boon Lay. Avoid right lane. - description: Description message for this incident - - unauthorized: - type: object - properties: - message: - type: string - example: Missing Authentication Token - status: - type: string - example: Failure - forbidden: - type: object - properties: - message: - type: string - example: Access Denied Unauthorized User - status: - type: string - example: Failure - paymentrequired: - type: object - properties: - message: - type: string - example: Insufficient Credits Kindly Top Up - status: - type: string - example: Failure - notfound: - type: object - properties: - message: - type: string - example: Invalid Request URL - status: - type: string - example: Failure - servererror: - type: object - properties: - message: - type: string - example: Internal Server Error - status: - type: string - example: Failure - gatewaytimeout: - type: object - properties: - message: - type: string - example: Request Timeout - status: - type: string - example: Failure - inputfieldmissing: - type: object - properties: - message: - type: string - example: Input Field Missing - status: - type: string - example: Failure - inputlimitexceeded: - type: object - properties: - message: - type: string - example: Input Limit Exceeded - status: - type: string - example: Failure - invalidinput: - type: object - properties: - message: - type: string - example: Invalid Input - status: - type: string - example: Failure - versions: - type: object - properties: - v0.1.0: - type: array - items: - oneOf: - - type: string - example: Published Date - Feb 28, 2021 - description: Initial version release - securitySchemes: - APIAuthorizer: - type: apiKey - name: x-api-key - in: header - x-amazon-apigateway-authtype: custom - description: Authentication is done using the x-api-key in the request header. From f28937077a98fd58299c931bf6abc6ef0edb5bfa Mon Sep 17 00:00:00 2001 From: rameshsentient <51635015+rameshsentient@users.noreply.github.com> Date: Thu, 25 Feb 2021 12:15:25 +0530 Subject: [PATCH 535/792] Create traffic_incidents.yaml --- data/traffic_incidents.yaml | 229 ++++++++++++++++++++++++++++++++++++ 1 file changed, 229 insertions(+) create mode 100644 data/traffic_incidents.yaml diff --git a/data/traffic_incidents.yaml b/data/traffic_incidents.yaml new file mode 100644 index 000000000..15880d9a2 --- /dev/null +++ b/data/traffic_incidents.yaml @@ -0,0 +1,229 @@ +openapi: 3.0.1 +info: + title: Traffic Incidents + description: |+ + Returns incidents currently happening on the roads, such as + Accidents, Vehicle Breakdowns, Road Blocks, Traffic Diversions etc. + version: '0.1.0' +servers: + - url: 'https://api.sentient.io' +tags: +- name: "v0.1.0" + description: "Published Date - Feb 28, 2021" +paths: + /DaaS/dev/lta/TrafficIncidents: + get: + tags: + - v0.1.0 + responses: + '200': + description: Ok + content: + application/json: + schema: + $ref: '#/components/schemas/success' + example: + odata.metadata: http://datamall2.mytransport.sg/ltaodataservice/$metadata#IncidentSet + value: + - Type: Roadwork + Latitude: 1.3765155261589948 + Longitude: 103.72976844706339 + Message: "(25/2)13:13 Roadworks on Boon Lay Way (towards City) after Jalan Boon Lay. Avoid right lane." + '401': + description: Unauthorized + content: + application/json: + schema: + $ref: '#/components/schemas/unauthorized' + '402': + description: Payment Required + content: + application/json: + schema: + $ref: '#/components/schemas/paymentrequired' + '403': + description: Forbidden + content: + application/json: + schema: + $ref: '#/components/schemas/forbidden' + '404': + description: Not Found + content: + application/json: + schema: + $ref: '#/components/schemas/notfound' + '419': + description: Input Field Missing + content: + application/json: + schema: + $ref: '#/components/schemas/inputfieldmissing' + '413': + description: Input Limit Exceeded + content: + application/json: + schema: + $ref: '#/components/schemas/inputlimitexceeded' + '415': + description: Invalid Input + content: + application/json: + schema: + $ref: '#/components/schemas/invalidinput' + '500': + description: Internal Server Error + content: + application/json: + schema: + $ref: '#/components/schemas/servererror' + '504': + description: Gateway Timeout + content: + application/json: + schema: + $ref: '#/components/schemas/gatewaytimeout' + security: + - APIAuthorizer: [] +components: + schemas: + success: + type: object + properties: + odata.metadata: + type: string + example: http://datamall2.mytransport.sg/ltaodataservice/$metadata#IncidentSet + description: url + value: + type: array + items: + type: object + properties: + Type: + type: string + example: Roadwork + description: + Incident Types - + • Accident + • Road Works + • Vehicle Breakdown + • Weather + • Obstacle + • Road Block + • Heavy Traffic + • Misc. + • Diversion + • Unattended Vehicle + Latitude: + type: string + example: 1.3415018509600185 + description: Latitude map coordinates for the + start point of this road incident + Longitude: + type: string + example: 103.71215415465709 + description: Longitude map coordinates for + the start point of this incident + Message: + type: string + example: (25/2)13:13 Roadworks on Boon Lay Way (towards City) after Jalan Boon Lay. Avoid right lane. + description: Description message for this incident + + unauthorized: + type: object + properties: + message: + type: string + example: Missing Authentication Token + status: + type: string + example: Failure + forbidden: + type: object + properties: + message: + type: string + example: Access Denied Unauthorized User + status: + type: string + example: Failure + paymentrequired: + type: object + properties: + message: + type: string + example: Insufficient Credits Kindly Top Up + status: + type: string + example: Failure + notfound: + type: object + properties: + message: + type: string + example: Invalid Request URL + status: + type: string + example: Failure + servererror: + type: object + properties: + message: + type: string + example: Internal Server Error + status: + type: string + example: Failure + gatewaytimeout: + type: object + properties: + message: + type: string + example: Request Timeout + status: + type: string + example: Failure + inputfieldmissing: + type: object + properties: + message: + type: string + example: Input Field Missing + status: + type: string + example: Failure + inputlimitexceeded: + type: object + properties: + message: + type: string + example: Input Limit Exceeded + status: + type: string + example: Failure + invalidinput: + type: object + properties: + message: + type: string + example: Invalid Input + status: + type: string + example: Failure + versions: + type: object + properties: + v0.1.0: + type: array + items: + oneOf: + - type: string + example: Published Date - Feb 28, 2021 + description: Initial version release + securitySchemes: + APIAuthorizer: + type: apiKey + name: x-api-key + in: header + x-amazon-apigateway-authtype: custom + description: Authentication is done using the x-api-key in the request header. From 2029c20c67262ffd950b7d9c17404972e56db4df Mon Sep 17 00:00:00 2001 From: rameshsentient <51635015+rameshsentient@users.noreply.github.com> Date: Thu, 25 Feb 2021 12:40:59 +0530 Subject: [PATCH 536/792] Create road_works.yaml --- data/road_works.yaml | 233 +++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 233 insertions(+) create mode 100644 data/road_works.yaml diff --git a/data/road_works.yaml b/data/road_works.yaml new file mode 100644 index 000000000..e596cca9c --- /dev/null +++ b/data/road_works.yaml @@ -0,0 +1,233 @@ +openapi: 3.0.1 +info: + title: Road Works + description: |+ + Returns all road works being / to be carried out. + 24 hours – whenever there are updates + version: '0.1.0' +servers: + - url: 'https://api.sentient.io' +tags: +- name: "v0.1.0" + description: "Published Date - Feb 28, 2021" +paths: + /DaaS/dev/lta/RoadWorks: + get: + tags: + - v0.1.0 + responses: + '200': + description: Ok + content: + application/json: + schema: + $ref: '#/components/schemas/success' + example: + odata.metadata: http://datamall2.mytransport.sg/ltaodataservice/$metadata#RoadWorks + value: + - EventID: RMAPP-201512-0217 + StartDate: 2021-2-14 + EndDate: 2021-3-31 + SvcDept: SP POWERGRID LTD - REGIONAL + NETWORK CENTRAL + RoadName: ADAM DRIVE + Other: For details, please call 67273085 + '401': + description: Unauthorized + content: + application/json: + schema: + $ref: '#/components/schemas/unauthorized' + '402': + description: Payment Required + content: + application/json: + schema: + $ref: '#/components/schemas/paymentrequired' + '403': + description: Forbidden + content: + application/json: + schema: + $ref: '#/components/schemas/forbidden' + '404': + description: Not Found + content: + application/json: + schema: + $ref: '#/components/schemas/notfound' + '419': + description: Input Field Missing + content: + application/json: + schema: + $ref: '#/components/schemas/inputfieldmissing' + '413': + description: Input Limit Exceeded + content: + application/json: + schema: + $ref: '#/components/schemas/inputlimitexceeded' + '415': + description: Invalid Input + content: + application/json: + schema: + $ref: '#/components/schemas/invalidinput' + '500': + description: Internal Server Error + content: + application/json: + schema: + $ref: '#/components/schemas/servererror' + '504': + description: Gateway Timeout + content: + application/json: + schema: + $ref: '#/components/schemas/gatewaytimeout' + security: + - APIAuthorizer: [] +components: + schemas: + success: + type: object + properties: + odata.metadata: + type: string + example: http://datamall2.mytransport.sg/ltaodataservice/$metadata#RoadWorks + description: url + value: + type: array + items: + type: object + properties: + EventID: + type: string + example: RMAPP-201512-0217 + description: ID for this road work + StartDate: + type: string + example: 2021-2-14 + description: Start date for the works + performed for this road work + (in YYYY-MM-DD format) + EndDate: + type: string + example: 2021-3-31 + description: End date for works performed + for this road work + (in YYYY-MM-DD format) + SvcDept: + type: string + example: SP POWERGRID LTD - REGIONAL + NETWORK CENTRAL + description: Department or company + performing this road work + RoadName: + type: string + example: ADAM DRIVE + description: Name of road where work is + being performed. + Other: + type: string + example: For details, please call 67273085 + description: Additional information or messages. + unauthorized: + type: object + properties: + message: + type: string + example: Missing Authentication Token + status: + type: string + example: Failure + forbidden: + type: object + properties: + message: + type: string + example: Access Denied Unauthorized User + status: + type: string + example: Failure + paymentrequired: + type: object + properties: + message: + type: string + example: Insufficient Credits Kindly Top Up + status: + type: string + example: Failure + notfound: + type: object + properties: + message: + type: string + example: Invalid Request URL + status: + type: string + example: Failure + servererror: + type: object + properties: + message: + type: string + example: Internal Server Error + status: + type: string + example: Failure + gatewaytimeout: + type: object + properties: + message: + type: string + example: Request Timeout + status: + type: string + example: Failure + inputfieldmissing: + type: object + properties: + message: + type: string + example: Input Field Missing + status: + type: string + example: Failure + inputlimitexceeded: + type: object + properties: + message: + type: string + example: Input Limit Exceeded + status: + type: string + example: Failure + invalidinput: + type: object + properties: + message: + type: string + example: Invalid Input + status: + type: string + example: Failure + versions: + type: object + properties: + v0.1.0: + type: array + items: + oneOf: + - type: string + example: Published Date - Feb 28, 2021 + description: Initial version release + securitySchemes: + APIAuthorizer: + type: apiKey + name: x-api-key + in: header + x-amazon-apigateway-authtype: custom + description: Authentication is done using the x-api-key in the request header. From 52ef082e3ae3e1cf8acdeb06066a71c2061e9d43 Mon Sep 17 00:00:00 2001 From: rameshsentient <51635015+rameshsentient@users.noreply.github.com> Date: Thu, 25 Feb 2021 12:42:08 +0530 Subject: [PATCH 537/792] Update index.yaml --- index.yaml | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/index.yaml b/index.yaml index e93e7e443..d7db9f9ed 100644 --- a/index.yaml +++ b/index.yaml @@ -287,7 +287,11 @@ data: faulty_traffic_lights: title: Faulty Traffic Lights versions: - 0.1.0: 'faulty_traffic_lights.yaml' + 0.1.0: 'faulty_traffic_lights.yaml' + road_works: + title: Road Works + versions: + 0.1.0: 'road_works.yaml' realtime_weather: title: Weather Api versions: From 5ed29e4d1c7d3f05a3c2b077cfd1e1456c38a16f Mon Sep 17 00:00:00 2001 From: rameshsentient <51635015+rameshsentient@users.noreply.github.com> Date: Thu, 25 Feb 2021 12:52:21 +0530 Subject: [PATCH 538/792] Create vms.yaml --- data/vms.yaml | 219 ++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 219 insertions(+) create mode 100644 data/vms.yaml diff --git a/data/vms.yaml b/data/vms.yaml new file mode 100644 index 000000000..3cd3cd3cb --- /dev/null +++ b/data/vms.yaml @@ -0,0 +1,219 @@ +openapi: 3.0.1 +info: + title: VMS + description: |+ + Returns traffic advisories (via variable message services) concerning + current traffic conditions that are displayed on EMAS signboards + along expressways and arterial roads. + 2 minutes – whenever there are updates + version: '0.1.0' +servers: + - url: 'https://api.sentient.io' +tags: +- name: "v0.1.0" + description: "Published Date - Feb 28, 2021" +paths: + /DaaS/dev/lta/VMS: + get: + tags: + - v0.1.0 + responses: + '200': + description: Ok + content: + application/json: + schema: + $ref: '#/components/schemas/success' + example: + odata.metadata: http://datamall2.mytransport.sg/ltaodataservice/$metadata#VMS + value: + - EquipmentID: AVMS_01_00501 + Latitude: 1.3290499998616139 + Longitude: 103.87474391991731 + Message: ROAD|WORKS ON|BENDEMEER + '401': + description: Unauthorized + content: + application/json: + schema: + $ref: '#/components/schemas/unauthorized' + '402': + description: Payment Required + content: + application/json: + schema: + $ref: '#/components/schemas/paymentrequired' + '403': + description: Forbidden + content: + application/json: + schema: + $ref: '#/components/schemas/forbidden' + '404': + description: Not Found + content: + application/json: + schema: + $ref: '#/components/schemas/notfound' + '419': + description: Input Field Missing + content: + application/json: + schema: + $ref: '#/components/schemas/inputfieldmissing' + '413': + description: Input Limit Exceeded + content: + application/json: + schema: + $ref: '#/components/schemas/inputlimitexceeded' + '415': + description: Invalid Input + content: + application/json: + schema: + $ref: '#/components/schemas/invalidinput' + '500': + description: Internal Server Error + content: + application/json: + schema: + $ref: '#/components/schemas/servererror' + '504': + description: Gateway Timeout + content: + application/json: + schema: + $ref: '#/components/schemas/gatewaytimeout' + security: + - APIAuthorizer: [] +components: + schemas: + success: + type: object + properties: + odata.metadata: + type: string + example: http://datamall2.mytransport.sg/ltaodataservice/$metadata#RoadWorks + description: url + value: + type: array + items: + type: object + properties: + EquipmentID: + type: string + example: AVMS_01_00501 + description: EMAS equipment ID + Latitude: + type: string + example: 1.3290499998616139 + description: Latitude map coordinates of + electronic signboard. + Longitude: + type: string + example: 103.87474391991731 + description: Longitude map coordinates of + electronic signboard. + Message: + type: string + example: ROAD|WORKS ON|BENDEMEER + description: VEH BREAKDOWN SH,AFTU.THOMSON + unauthorized: + type: object + properties: + message: + type: string + example: Missing Authentication Token + status: + type: string + example: Failure + forbidden: + type: object + properties: + message: + type: string + example: Access Denied Unauthorized User + status: + type: string + example: Failure + paymentrequired: + type: object + properties: + message: + type: string + example: Insufficient Credits Kindly Top Up + status: + type: string + example: Failure + notfound: + type: object + properties: + message: + type: string + example: Invalid Request URL + status: + type: string + example: Failure + servererror: + type: object + properties: + message: + type: string + example: Internal Server Error + status: + type: string + example: Failure + gatewaytimeout: + type: object + properties: + message: + type: string + example: Request Timeout + status: + type: string + example: Failure + inputfieldmissing: + type: object + properties: + message: + type: string + example: Input Field Missing + status: + type: string + example: Failure + inputlimitexceeded: + type: object + properties: + message: + type: string + example: Input Limit Exceeded + status: + type: string + example: Failure + invalidinput: + type: object + properties: + message: + type: string + example: Invalid Input + status: + type: string + example: Failure + versions: + type: object + properties: + v0.1.0: + type: array + items: + oneOf: + - type: string + example: Published Date - Feb 28, 2021 + description: Initial version release + securitySchemes: + APIAuthorizer: + type: apiKey + name: x-api-key + in: header + x-amazon-apigateway-authtype: custom + description: Authentication is done using the x-api-key in the request header. From 5ac4fdee5184d02204c6ecd549183e6d69211e94 Mon Sep 17 00:00:00 2001 From: rameshsentient <51635015+rameshsentient@users.noreply.github.com> Date: Thu, 25 Feb 2021 12:53:16 +0530 Subject: [PATCH 539/792] Update index.yaml --- index.yaml | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/index.yaml b/index.yaml index d7db9f9ed..df3aca8ca 100644 --- a/index.yaml +++ b/index.yaml @@ -291,7 +291,11 @@ data: road_works: title: Road Works versions: - 0.1.0: 'road_works.yaml' + 0.1.0: 'road_works.yaml' + vms: + title: VMS + versions: + 0.1.0: 'vms.yaml' realtime_weather: title: Weather Api versions: From 75602c3c51ba5100abfcac47abd033e588eacaef Mon Sep 17 00:00:00 2001 From: rameshsentient <51635015+rameshsentient@users.noreply.github.com> Date: Thu, 25 Feb 2021 13:12:15 +0530 Subject: [PATCH 540/792] Create traffic_images.yaml --- data/traffic_images.yaml | 222 +++++++++++++++++++++++++++++++++++++++ 1 file changed, 222 insertions(+) create mode 100644 data/traffic_images.yaml diff --git a/data/traffic_images.yaml b/data/traffic_images.yaml new file mode 100644 index 000000000..9ff632f3d --- /dev/null +++ b/data/traffic_images.yaml @@ -0,0 +1,222 @@ +openapi: 3.0.1 +info: + title: Traffic Images + description: |+ + Returns links to images of live traffic conditions along expressways and + Woodlands & Tuas Checkpoints. + 1 to 5 minutes – whenever there are updates + version: '0.1.0' +servers: + - url: 'https://api.sentient.io' +tags: +- name: "v0.1.0" + description: "Published Date - Feb 28, 2021" +paths: + /DaaS/dev/lta/Traffic-Imagesv2: + get: + tags: + - v0.1.0 + responses: + '200': + description: Ok + content: + application/json: + schema: + $ref: '#/components/schemas/success' + example: + odata.metadata: http://datamall2.mytransport.sg/ltaodataservice/$metadata#Traffic-Imagesv2 + value: + - CameraID: 1001 + Latitude: 1.3290499998616139 + Longitude: 103.87474391991731 + ImageLink: https://dm-traffic-camera-itsc.s3.amazonaws.com/2021-02-25/15-27/1001_1523_20210225152731_1c29e4.jpg?x-amz-security-token=IQoJb3JpZ2luX2VjEA8aDmFwLXNvdXRoZWFzdC0xIkYwRAIgB9vybH4h7daI43qfBeZMS%2FSX6av1yjSu73Q0kqbTD4ICIDTHpUSoXG7OU3EOtK0z0F6NGxf1c0xQwrULNgEbaiFhKqMDCCgQAhoMMzQwNjQ1MzgxMzA0IgyLggWjvfs4g1sMc4UqgAOZXEmpoGYRlnDs9tu6COLECjNNgalDexWPvFpq1a3A9dDM%2Bp6mRAQxxuja%2Bcob2Ox1fPgE%2Bhf24arud9Xr11cNNybleHqCWnBGsjhOo6JNP2gOraux84cXhEjGarHp4%2FvwXGVFQbmF%2B1J9QQlCa2D4LW%2Ffr8hnBsNGKVMe7k7MoS1QfKePl500wUYvhDJEZqPej54BGt%2BlPGorwFBQ%2B10n8vyiwShBxd%2BHBQFxpbuf72fRS9VAYilkCyp8%2FeohmSVh%2BeJXVWvcS5rGiIKd%2FyTOK7nL91s08EiJ0uhwZNJdbu3XdZPFXPTI%2Ban%2BHSkurfa3%2B05mSo4aP%2FGm5NPxP9xzCphiu65ugpN%2BOYxUwwErT7oTPQjI1ZiUJOXvWGhSA5WpKEzVTNPx3aYDtjB8T7qDky8A%2BjsQyvKQARdxM9buz8H1pej8KDsnHr%2BAgupNy%2F9kNk9kBdxPnj67WaVot9WdIOHcj8knf4SVIZCy%2FMESBMVkXT%2BwRLJ8XJaSFR13sl4wvY3dgQY67AG3IH44KUVXKCnh36UJ5nCpEaT162Y6dleCP2Okragprp%2BhIMQHcb3spNoLRHVcq3Zj%2B53o2s4yF6%2FO6BUe1nSZ31X890J6Wao3yFwhrbyULbRAA8Ni3R%2ForYYK0l3213NtV%2FyaIp9o02EAyG7sWOhvsD7MbofMBI2GS%2FbrmEYHjdSTrMCkZje0zG6Q5L60rWgiRVBn5Sa2ogUYk0c%2F4ecnQ8taiVzEuoQsV5CTB5ou2pQVKP1fbefNyu1B18542VLLqJW8mHZ6eoYf%2FwGK7tqJaJf1sPRr2qZ0YbVtkQCo03ZYm0fetH3mXsCYWQ%3D%3D&AWSAccessKeyId=ASIAU6UAMAS4GTPW2LXI&Expires=1614238351&Signature=6xg03%2FpXKMJDVKyXV7X%2FjeLhVb8%3D + '401': + description: Unauthorized + content: + application/json: + schema: + $ref: '#/components/schemas/unauthorized' + '402': + description: Payment Required + content: + application/json: + schema: + $ref: '#/components/schemas/paymentrequired' + '403': + description: Forbidden + content: + application/json: + schema: + $ref: '#/components/schemas/forbidden' + '404': + description: Not Found + content: + application/json: + schema: + $ref: '#/components/schemas/notfound' + '419': + description: Input Field Missing + content: + application/json: + schema: + $ref: '#/components/schemas/inputfieldmissing' + '413': + description: Input Limit Exceeded + content: + application/json: + schema: + $ref: '#/components/schemas/inputlimitexceeded' + '415': + description: Invalid Input + content: + application/json: + schema: + $ref: '#/components/schemas/invalidinput' + '500': + description: Internal Server Error + content: + application/json: + schema: + $ref: '#/components/schemas/servererror' + '504': + description: Gateway Timeout + content: + application/json: + schema: + $ref: '#/components/schemas/gatewaytimeout' + security: + - APIAuthorizer: [] +components: + schemas: + success: + type: object + properties: + odata.metadata: + type: string + example: http://datamall2.mytransport.sg/ltaodataservice/$metadata#RoadWorks + description: url + value: + type: array + items: + type: object + properties: + CameraID: + type: string + example: 1001 + description: A unique ID for this camera + Latitude: + type: string + example: 1.3290499998616139 + description: Latitude map coordinates + Longitude: + type: string + example: 103.87474391991731 + description: Longitude map coordinates + ImageLink: + type: string + example: https://dm-traffic-camera-itsc.s3.amazonaws.com/2021-02-25/15-27/1001_1523_20210225152731_1c29e4.jpg?x-amz-security-token=IQoJb3JpZ2luX2VjEA8aDmFwLXNvdXRoZWFzdC0xIkYwRAIgB9vybH4h7daI43qfBeZMS%2FSX6av1yjSu73Q0kqbTD4ICIDTHpUSoXG7OU3EOtK0z0F6NGxf1c0xQwrULNgEbaiFhKqMDCCgQAhoMMzQwNjQ1MzgxMzA0IgyLggWjvfs4g1sMc4UqgAOZXEmpoGYRlnDs9tu6COLECjNNgalDexWPvFpq1a3A9dDM%2Bp6mRAQxxuja%2Bcob2Ox1fPgE%2Bhf24arud9Xr11cNNybleHqCWnBGsjhOo6JNP2gOraux84cXhEjGarHp4%2FvwXGVFQbmF%2B1J9QQlCa2D4LW%2Ffr8hnBsNGKVMe7k7MoS1QfKePl500wUYvhDJEZqPej54BGt%2BlPGorwFBQ%2B10n8vyiwShBxd%2BHBQFxpbuf72fRS9VAYilkCyp8%2FeohmSVh%2BeJXVWvcS5rGiIKd%2FyTOK7nL91s08EiJ0uhwZNJdbu3XdZPFXPTI%2Ban%2BHSkurfa3%2B05mSo4aP%2FGm5NPxP9xzCphiu65ugpN%2BOYxUwwErT7oTPQjI1ZiUJOXvWGhSA5WpKEzVTNPx3aYDtjB8T7qDky8A%2BjsQyvKQARdxM9buz8H1pej8KDsnHr%2BAgupNy%2F9kNk9kBdxPnj67WaVot9WdIOHcj8knf4SVIZCy%2FMESBMVkXT%2BwRLJ8XJaSFR13sl4wvY3dgQY67AG3IH44KUVXKCnh36UJ5nCpEaT162Y6dleCP2Okragprp%2BhIMQHcb3spNoLRHVcq3Zj%2B53o2s4yF6%2FO6BUe1nSZ31X890J6Wao3yFwhrbyULbRAA8Ni3R%2ForYYK0l3213NtV%2FyaIp9o02EAyG7sWOhvsD7MbofMBI2GS%2FbrmEYHjdSTrMCkZje0zG6Q5L60rWgiRVBn5Sa2ogUYk0c%2F4ecnQ8taiVzEuoQsV5CTB5ou2pQVKP1fbefNyu1B18542VLLqJW8mHZ6eoYf%2FwGK7tqJaJf1sPRr2qZ0YbVtkQCo03ZYm0fetH3mXsCYWQ%3D%3D&AWSAccessKeyId=ASIAU6UAMAS4GTPW2LXI&Expires=1614238351&Signature=6xg03%2FpXKMJDVKyXV7X%2FjeLhVb8%3D + description: • Link for + downloading + this image. + • Link will + expire after + 5 minutes + + unauthorized: + type: object + properties: + message: + type: string + example: Missing Authentication Token + status: + type: string + example: Failure + forbidden: + type: object + properties: + message: + type: string + example: Access Denied Unauthorized User + status: + type: string + example: Failure + paymentrequired: + type: object + properties: + message: + type: string + example: Insufficient Credits Kindly Top Up + status: + type: string + example: Failure + notfound: + type: object + properties: + message: + type: string + example: Invalid Request URL + status: + type: string + example: Failure + servererror: + type: object + properties: + message: + type: string + example: Internal Server Error + status: + type: string + example: Failure + gatewaytimeout: + type: object + properties: + message: + type: string + example: Request Timeout + status: + type: string + example: Failure + inputfieldmissing: + type: object + properties: + message: + type: string + example: Input Field Missing + status: + type: string + example: Failure + inputlimitexceeded: + type: object + properties: + message: + type: string + example: Input Limit Exceeded + status: + type: string + example: Failure + invalidinput: + type: object + properties: + message: + type: string + example: Invalid Input + status: + type: string + example: Failure + versions: + type: object + properties: + v0.1.0: + type: array + items: + oneOf: + - type: string + example: Published Date - Feb 28, 2021 + description: Initial version release + securitySchemes: + APIAuthorizer: + type: apiKey + name: x-api-key + in: header + x-amazon-apigateway-authtype: custom + description: Authentication is done using the x-api-key in the request header. From a7f3f54b68985cec6c9b62e8adb67fcedee211a5 Mon Sep 17 00:00:00 2001 From: rameshsentient <51635015+rameshsentient@users.noreply.github.com> Date: Thu, 25 Feb 2021 13:13:10 +0530 Subject: [PATCH 541/792] Update index.yaml --- index.yaml | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/index.yaml b/index.yaml index df3aca8ca..c538a394d 100644 --- a/index.yaml +++ b/index.yaml @@ -295,7 +295,11 @@ data: vms: title: VMS versions: - 0.1.0: 'vms.yaml' + 0.1.0: 'vms.yaml' + traffic_images: + title: Traffic Images + versions: + 0.1.0: 'traffic_images.yaml' realtime_weather: title: Weather Api versions: From a66141fc6f59ef03abd12cd72a09b2550e98886d Mon Sep 17 00:00:00 2001 From: rameshsentient <51635015+rameshsentient@users.noreply.github.com> Date: Thu, 25 Feb 2021 13:38:02 +0530 Subject: [PATCH 542/792] Delete traffic_incidents.yaml --- data/traffic_incidents.yaml | 229 ------------------------------------ 1 file changed, 229 deletions(-) delete mode 100644 data/traffic_incidents.yaml diff --git a/data/traffic_incidents.yaml b/data/traffic_incidents.yaml deleted file mode 100644 index 15880d9a2..000000000 --- a/data/traffic_incidents.yaml +++ /dev/null @@ -1,229 +0,0 @@ -openapi: 3.0.1 -info: - title: Traffic Incidents - description: |+ - Returns incidents currently happening on the roads, such as - Accidents, Vehicle Breakdowns, Road Blocks, Traffic Diversions etc. - version: '0.1.0' -servers: - - url: 'https://api.sentient.io' -tags: -- name: "v0.1.0" - description: "Published Date - Feb 28, 2021" -paths: - /DaaS/dev/lta/TrafficIncidents: - get: - tags: - - v0.1.0 - responses: - '200': - description: Ok - content: - application/json: - schema: - $ref: '#/components/schemas/success' - example: - odata.metadata: http://datamall2.mytransport.sg/ltaodataservice/$metadata#IncidentSet - value: - - Type: Roadwork - Latitude: 1.3765155261589948 - Longitude: 103.72976844706339 - Message: "(25/2)13:13 Roadworks on Boon Lay Way (towards City) after Jalan Boon Lay. Avoid right lane." - '401': - description: Unauthorized - content: - application/json: - schema: - $ref: '#/components/schemas/unauthorized' - '402': - description: Payment Required - content: - application/json: - schema: - $ref: '#/components/schemas/paymentrequired' - '403': - description: Forbidden - content: - application/json: - schema: - $ref: '#/components/schemas/forbidden' - '404': - description: Not Found - content: - application/json: - schema: - $ref: '#/components/schemas/notfound' - '419': - description: Input Field Missing - content: - application/json: - schema: - $ref: '#/components/schemas/inputfieldmissing' - '413': - description: Input Limit Exceeded - content: - application/json: - schema: - $ref: '#/components/schemas/inputlimitexceeded' - '415': - description: Invalid Input - content: - application/json: - schema: - $ref: '#/components/schemas/invalidinput' - '500': - description: Internal Server Error - content: - application/json: - schema: - $ref: '#/components/schemas/servererror' - '504': - description: Gateway Timeout - content: - application/json: - schema: - $ref: '#/components/schemas/gatewaytimeout' - security: - - APIAuthorizer: [] -components: - schemas: - success: - type: object - properties: - odata.metadata: - type: string - example: http://datamall2.mytransport.sg/ltaodataservice/$metadata#IncidentSet - description: url - value: - type: array - items: - type: object - properties: - Type: - type: string - example: Roadwork - description: - Incident Types - - • Accident - • Road Works - • Vehicle Breakdown - • Weather - • Obstacle - • Road Block - • Heavy Traffic - • Misc. - • Diversion - • Unattended Vehicle - Latitude: - type: string - example: 1.3415018509600185 - description: Latitude map coordinates for the - start point of this road incident - Longitude: - type: string - example: 103.71215415465709 - description: Longitude map coordinates for - the start point of this incident - Message: - type: string - example: (25/2)13:13 Roadworks on Boon Lay Way (towards City) after Jalan Boon Lay. Avoid right lane. - description: Description message for this incident - - unauthorized: - type: object - properties: - message: - type: string - example: Missing Authentication Token - status: - type: string - example: Failure - forbidden: - type: object - properties: - message: - type: string - example: Access Denied Unauthorized User - status: - type: string - example: Failure - paymentrequired: - type: object - properties: - message: - type: string - example: Insufficient Credits Kindly Top Up - status: - type: string - example: Failure - notfound: - type: object - properties: - message: - type: string - example: Invalid Request URL - status: - type: string - example: Failure - servererror: - type: object - properties: - message: - type: string - example: Internal Server Error - status: - type: string - example: Failure - gatewaytimeout: - type: object - properties: - message: - type: string - example: Request Timeout - status: - type: string - example: Failure - inputfieldmissing: - type: object - properties: - message: - type: string - example: Input Field Missing - status: - type: string - example: Failure - inputlimitexceeded: - type: object - properties: - message: - type: string - example: Input Limit Exceeded - status: - type: string - example: Failure - invalidinput: - type: object - properties: - message: - type: string - example: Invalid Input - status: - type: string - example: Failure - versions: - type: object - properties: - v0.1.0: - type: array - items: - oneOf: - - type: string - example: Published Date - Feb 28, 2021 - description: Initial version release - securitySchemes: - APIAuthorizer: - type: apiKey - name: x-api-key - in: header - x-amazon-apigateway-authtype: custom - description: Authentication is done using the x-api-key in the request header. From e87de67dfe14809a9855300dc0bc38ce81656179 Mon Sep 17 00:00:00 2001 From: rameshsentient <51635015+rameshsentient@users.noreply.github.com> Date: Thu, 25 Feb 2021 13:38:21 +0530 Subject: [PATCH 543/792] Update index.yaml --- index.yaml | 6 +----- 1 file changed, 1 insertion(+), 5 deletions(-) diff --git a/index.yaml b/index.yaml index c538a394d..1883da547 100644 --- a/index.yaml +++ b/index.yaml @@ -279,11 +279,7 @@ data: ihi_data_pointcloud: title: IHI Point Cloud versions: - 0.1.0: 'ihi_data_pointcloud.yaml' - traffic_incidents: - title: Traffic Incidents - versions: - 0.1.0: 'traffic_incidents.yaml' + 0.1.0: 'ihi_data_pointcloud.yaml' faulty_traffic_lights: title: Faulty Traffic Lights versions: From d39eb96f8efd210f4b47be929f15b786c714b901 Mon Sep 17 00:00:00 2001 From: rameshsentient <51635015+rameshsentient@users.noreply.github.com> Date: Thu, 25 Feb 2021 13:38:50 +0530 Subject: [PATCH 544/792] Create traffic_incidents.yaml --- data/traffic_incidents.yaml | 230 ++++++++++++++++++++++++++++++++++++ 1 file changed, 230 insertions(+) create mode 100644 data/traffic_incidents.yaml diff --git a/data/traffic_incidents.yaml b/data/traffic_incidents.yaml new file mode 100644 index 000000000..0a3005a03 --- /dev/null +++ b/data/traffic_incidents.yaml @@ -0,0 +1,230 @@ +openapi: 3.0.1 +info: + title: Traffic Incidents + description: |+ + Returns incidents currently happening on the roads, such as + Accidents, Vehicle Breakdowns, Road Blocks, Traffic Diversions etc. + 2 minutes – whenever there are updates + version: '0.1.0' +servers: + - url: 'https://api.sentient.io' +tags: +- name: "v0.1.0" + description: "Published Date - Feb 28, 2021" +paths: + /DaaS/dev/lta/TrafficIncidents: + get: + tags: + - v0.1.0 + responses: + '200': + description: Ok + content: + application/json: + schema: + $ref: '#/components/schemas/success' + example: + odata.metadata: http://datamall2.mytransport.sg/ltaodataservice/$metadata#IncidentSet + value: + - Type: Roadwork + Latitude: 1.3765155261589948 + Longitude: 103.72976844706339 + Message: "(25/2)13:13 Roadworks on Boon Lay Way (towards City) after Jalan Boon Lay. Avoid right lane." + '401': + description: Unauthorized + content: + application/json: + schema: + $ref: '#/components/schemas/unauthorized' + '402': + description: Payment Required + content: + application/json: + schema: + $ref: '#/components/schemas/paymentrequired' + '403': + description: Forbidden + content: + application/json: + schema: + $ref: '#/components/schemas/forbidden' + '404': + description: Not Found + content: + application/json: + schema: + $ref: '#/components/schemas/notfound' + '419': + description: Input Field Missing + content: + application/json: + schema: + $ref: '#/components/schemas/inputfieldmissing' + '413': + description: Input Limit Exceeded + content: + application/json: + schema: + $ref: '#/components/schemas/inputlimitexceeded' + '415': + description: Invalid Input + content: + application/json: + schema: + $ref: '#/components/schemas/invalidinput' + '500': + description: Internal Server Error + content: + application/json: + schema: + $ref: '#/components/schemas/servererror' + '504': + description: Gateway Timeout + content: + application/json: + schema: + $ref: '#/components/schemas/gatewaytimeout' + security: + - APIAuthorizer: [] +components: + schemas: + success: + type: object + properties: + odata.metadata: + type: string + example: http://datamall2.mytransport.sg/ltaodataservice/$metadata#IncidentSet + description: url + value: + type: array + items: + type: object + properties: + Type: + type: string + example: Roadwork + description: + Incident Types - + • Accident + • Road Works + • Vehicle Breakdown + • Weather + • Obstacle + • Road Block + • Heavy Traffic + • Misc. + • Diversion + • Unattended Vehicle + Latitude: + type: string + example: 1.3415018509600185 + description: Latitude map coordinates for the + start point of this road incident + Longitude: + type: string + example: 103.71215415465709 + description: Longitude map coordinates for + the start point of this incident + Message: + type: string + example: (25/2)13:13 Roadworks on Boon Lay Way (towards City) after Jalan Boon Lay. Avoid right lane. + description: Description message for this incident + + unauthorized: + type: object + properties: + message: + type: string + example: Missing Authentication Token + status: + type: string + example: Failure + forbidden: + type: object + properties: + message: + type: string + example: Access Denied Unauthorized User + status: + type: string + example: Failure + paymentrequired: + type: object + properties: + message: + type: string + example: Insufficient Credits Kindly Top Up + status: + type: string + example: Failure + notfound: + type: object + properties: + message: + type: string + example: Invalid Request URL + status: + type: string + example: Failure + servererror: + type: object + properties: + message: + type: string + example: Internal Server Error + status: + type: string + example: Failure + gatewaytimeout: + type: object + properties: + message: + type: string + example: Request Timeout + status: + type: string + example: Failure + inputfieldmissing: + type: object + properties: + message: + type: string + example: Input Field Missing + status: + type: string + example: Failure + inputlimitexceeded: + type: object + properties: + message: + type: string + example: Input Limit Exceeded + status: + type: string + example: Failure + invalidinput: + type: object + properties: + message: + type: string + example: Invalid Input + status: + type: string + example: Failure + versions: + type: object + properties: + v0.1.0: + type: array + items: + oneOf: + - type: string + example: Published Date - Feb 28, 2021 + description: Initial version release + securitySchemes: + APIAuthorizer: + type: apiKey + name: x-api-key + in: header + x-amazon-apigateway-authtype: custom + description: Authentication is done using the x-api-key in the request header. From 004b621dcbeee50d45ca9ed3f98c7e039439d98b Mon Sep 17 00:00:00 2001 From: rameshsentient <51635015+rameshsentient@users.noreply.github.com> Date: Thu, 25 Feb 2021 13:39:45 +0530 Subject: [PATCH 545/792] Update index.yaml --- index.yaml | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/index.yaml b/index.yaml index 1883da547..b61aee622 100644 --- a/index.yaml +++ b/index.yaml @@ -296,6 +296,10 @@ data: title: Traffic Images versions: 0.1.0: 'traffic_images.yaml' + traffic_incidents: + title: Traffic Incidents + versions: + 0.1.0: 'traffic_incidents.yaml' realtime_weather: title: Weather Api versions: From f3c7dfe45d125721060e02aed3ffb4e854b4d524 Mon Sep 17 00:00:00 2001 From: rameshsentient <51635015+rameshsentient@users.noreply.github.com> Date: Thu, 25 Feb 2021 13:53:15 +0530 Subject: [PATCH 546/792] Update index.yaml --- index.yaml | 6 +----- 1 file changed, 1 insertion(+), 5 deletions(-) diff --git a/index.yaml b/index.yaml index b61aee622..ca2e78a60 100644 --- a/index.yaml +++ b/index.yaml @@ -295,11 +295,7 @@ data: traffic_images: title: Traffic Images versions: - 0.1.0: 'traffic_images.yaml' - traffic_incidents: - title: Traffic Incidents - versions: - 0.1.0: 'traffic_incidents.yaml' + 0.1.0: 'traffic_images.yaml' realtime_weather: title: Weather Api versions: From 7eb1b7bcc098f36fca22b9d51f5c9c2bd6772e81 Mon Sep 17 00:00:00 2001 From: rameshsentient <51635015+rameshsentient@users.noreply.github.com> Date: Thu, 25 Feb 2021 14:02:56 +0530 Subject: [PATCH 547/792] Update index.yaml --- index.yaml | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/index.yaml b/index.yaml index ca2e78a60..b6e4454d9 100644 --- a/index.yaml +++ b/index.yaml @@ -287,7 +287,7 @@ data: road_works: title: Road Works versions: - 0.1.0: 'road_works.yaml' + 0.1.0: 'road_works.yaml' vms: title: VMS versions: @@ -295,7 +295,11 @@ data: traffic_images: title: Traffic Images versions: - 0.1.0: 'traffic_images.yaml' + 0.1.0: 'traffic_images.yaml' + traffic_incidents: + title: Traffic Incidents + versions: + 0.1.0: 'traffic_incidents.yaml' realtime_weather: title: Weather Api versions: From 3163978c227b55fe0f569d75e53fe78cc08d8128 Mon Sep 17 00:00:00 2001 From: rameshsentient <51635015+rameshsentient@users.noreply.github.com> Date: Thu, 25 Feb 2021 14:16:44 +0530 Subject: [PATCH 548/792] Update amenities_hardcourts_hdb_sg.yaml --- data/amenities_hardcourts_hdb_sg.yaml | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/data/amenities_hardcourts_hdb_sg.yaml b/data/amenities_hardcourts_hdb_sg.yaml index d259b8da7..1cdf3f702 100644 --- a/data/amenities_hardcourts_hdb_sg.yaml +++ b/data/amenities_hardcourts_hdb_sg.yaml @@ -89,13 +89,13 @@ paths: schema: $ref: '#/components/schemas/inputfieldmissing' '413': - description: Input Limit Exceeded + description: Payload Too Large content: application/json: schema: - $ref: '#/components/schemas/inputlimitexceeded' + $ref: '#/components/schemas/inputlimitexceeded' '415': - description: Invalid Input + description: Unsupported Media Type content: application/json: schema: From 40c0ec3bddb839a9efdf99ae23ec9317e8446730 Mon Sep 17 00:00:00 2001 From: rameshsentient <51635015+rameshsentient@users.noreply.github.com> Date: Thu, 25 Feb 2021 14:17:15 +0530 Subject: [PATCH 549/792] Update amenities_lamp_posts_hdb_sg.yaml --- data/amenities_lamp_posts_hdb_sg.yaml | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/data/amenities_lamp_posts_hdb_sg.yaml b/data/amenities_lamp_posts_hdb_sg.yaml index c5fb4f0ad..849848ff1 100644 --- a/data/amenities_lamp_posts_hdb_sg.yaml +++ b/data/amenities_lamp_posts_hdb_sg.yaml @@ -91,17 +91,17 @@ paths: schema: $ref: '#/components/schemas/inputfieldmissing' '413': - description: Input Limit Exceeded + description: Payload Too Large content: application/json: schema: - $ref: '#/components/schemas/inputlimitexceeded' + $ref: '#/components/schemas/inputlimitexceeded' '415': - description: Invalid Input + description: Unsupported Media Type content: application/json: schema: - $ref: '#/components/schemas/invalidinput' + $ref: '#/components/schemas/invalidinput' '500': description: Internal Server Error content: From a5db9ae8cbe152b708045910f8bcd4fa1950ee4e Mon Sep 17 00:00:00 2001 From: rameshsentient <51635015+rameshsentient@users.noreply.github.com> Date: Thu, 25 Feb 2021 14:17:29 +0530 Subject: [PATCH 550/792] Update amenities_shelters_hdb_sg.yaml --- data/amenities_shelters_hdb_sg.yaml | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/data/amenities_shelters_hdb_sg.yaml b/data/amenities_shelters_hdb_sg.yaml index db33f0c34..af0241150 100644 --- a/data/amenities_shelters_hdb_sg.yaml +++ b/data/amenities_shelters_hdb_sg.yaml @@ -94,13 +94,13 @@ paths: schema: $ref: '#/components/schemas/inputfieldmissing' '413': - description: Input Limit Exceeded + description: Payload Too Large content: application/json: schema: - $ref: '#/components/schemas/inputlimitexceeded' + $ref: '#/components/schemas/inputlimitexceeded' '415': - description: Invalid Input + description: Unsupported Media Type content: application/json: schema: From 23d5c89bfbb1372654388a9ea7ab7d97b5f52099 Mon Sep 17 00:00:00 2001 From: rameshsentient <51635015+rameshsentient@users.noreply.github.com> Date: Thu, 25 Feb 2021 14:17:44 +0530 Subject: [PATCH 551/792] Update building_addresses_hdb_sg.yaml --- data/building_addresses_hdb_sg.yaml | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/data/building_addresses_hdb_sg.yaml b/data/building_addresses_hdb_sg.yaml index 78aeb1ee9..4e37835c1 100644 --- a/data/building_addresses_hdb_sg.yaml +++ b/data/building_addresses_hdb_sg.yaml @@ -199,13 +199,13 @@ paths: schema: $ref: '#/components/schemas/inputfieldmissing' '413': - description: Input Limit Exceeded + description: Payload Too Large content: application/json: schema: - $ref: '#/components/schemas/inputlimitexceeded' + $ref: '#/components/schemas/inputlimitexceeded' '415': - description: Invalid Input + description: Unsupported Media Type content: application/json: schema: From a8d2e341b93e7582c41968ed0854bd8609d51e4f Mon Sep 17 00:00:00 2001 From: rameshsentient <51635015+rameshsentient@users.noreply.github.com> Date: Thu, 25 Feb 2021 14:18:11 +0530 Subject: [PATCH 552/792] Update carpark_hdb_sg.yaml --- data/carpark_hdb_sg.yaml | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/data/carpark_hdb_sg.yaml b/data/carpark_hdb_sg.yaml index e3f0a2708..c4ae243db 100644 --- a/data/carpark_hdb_sg.yaml +++ b/data/carpark_hdb_sg.yaml @@ -248,13 +248,13 @@ paths: schema: $ref: '#/components/schemas/inputfieldmissing' '413': - description: Input Limit Exceeded + description: Payload Too Large content: application/json: schema: - $ref: '#/components/schemas/inputlimitexceeded' + $ref: '#/components/schemas/inputlimitexceeded' '415': - description: Invalid Input + description: Unsupported Media Type content: application/json: schema: From ec4e6c118dd3c324042d5f3a039b2cc0fb0299ee Mon Sep 17 00:00:00 2001 From: rameshsentient <51635015+rameshsentient@users.noreply.github.com> Date: Thu, 25 Feb 2021 14:18:26 +0530 Subject: [PATCH 553/792] Update commercial_directories_hdb_sg.yaml --- data/commercial_directories_hdb_sg.yaml | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/data/commercial_directories_hdb_sg.yaml b/data/commercial_directories_hdb_sg.yaml index 8de02e396..1f7db3a55 100644 --- a/data/commercial_directories_hdb_sg.yaml +++ b/data/commercial_directories_hdb_sg.yaml @@ -229,13 +229,13 @@ paths: schema: $ref: '#/components/schemas/inputfieldmissing' '413': - description: Input Limit Exceeded + description: Payload Too Large content: application/json: schema: - $ref: '#/components/schemas/inputlimitexceeded' + $ref: '#/components/schemas/inputlimitexceeded' '415': - description: Invalid Input + description: Unsupported Media Type content: application/json: schema: From df47eee435ca8e888119fe360a11233cfa1f1244 Mon Sep 17 00:00:00 2001 From: rameshsentient <51635015+rameshsentient@users.noreply.github.com> Date: Thu, 25 Feb 2021 14:19:09 +0530 Subject: [PATCH 554/792] Update d&b_basic_individual_search_sg.yaml --- data/d&b_basic_individual_search_sg.yaml | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/data/d&b_basic_individual_search_sg.yaml b/data/d&b_basic_individual_search_sg.yaml index 768d48d54..28c6ca708 100644 --- a/data/d&b_basic_individual_search_sg.yaml +++ b/data/d&b_basic_individual_search_sg.yaml @@ -132,13 +132,13 @@ paths: schema: $ref: '#/components/schemas/inputfieldmissing' '413': - description: Input Limit Exceeded + description: Payload Too Large content: application/json: schema: - $ref: '#/components/schemas/inputlimitexceeded' + $ref: '#/components/schemas/inputlimitexceeded' '415': - description: Invalid Input + description: Unsupported Media Type content: application/json: schema: From 727bd29e09c0b033b53b3f0572e6ac83f143cb04 Mon Sep 17 00:00:00 2001 From: rameshsentient <51635015+rameshsentient@users.noreply.github.com> Date: Thu, 25 Feb 2021 14:19:19 +0530 Subject: [PATCH 555/792] Update d&b_brief_financial_information_sg.yaml --- data/d&b_brief_financial_information_sg.yaml | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/data/d&b_brief_financial_information_sg.yaml b/data/d&b_brief_financial_information_sg.yaml index 22143c37a..4981e4adc 100644 --- a/data/d&b_brief_financial_information_sg.yaml +++ b/data/d&b_brief_financial_information_sg.yaml @@ -91,13 +91,13 @@ paths: schema: $ref: '#/components/schemas/inputfieldmissing' '413': - description: Input Limit Exceeded + description: Payload Too Large content: application/json: schema: - $ref: '#/components/schemas/inputlimitexceeded' + $ref: '#/components/schemas/inputlimitexceeded' '415': - description: Invalid Input + description: Unsupported Media Type content: application/json: schema: From 7b5a537e962abd8fc80e06a7b4d07282fce469d8 Mon Sep 17 00:00:00 2001 From: rameshsentient <51635015+rameshsentient@users.noreply.github.com> Date: Thu, 25 Feb 2021 14:19:33 +0530 Subject: [PATCH 556/792] Update d&b_business_check_plus_sg.yaml --- data/d&b_business_check_plus_sg.yaml | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/data/d&b_business_check_plus_sg.yaml b/data/d&b_business_check_plus_sg.yaml index a96609776..29b63ee86 100644 --- a/data/d&b_business_check_plus_sg.yaml +++ b/data/d&b_business_check_plus_sg.yaml @@ -256,13 +256,13 @@ paths: schema: $ref: '#/components/schemas/inputfieldmissing' '413': - description: Input Limit Exceeded + description: Payload Too Large content: application/json: schema: - $ref: '#/components/schemas/inputlimitexceeded' + $ref: '#/components/schemas/inputlimitexceeded' '415': - description: Invalid Input + description: Unsupported Media Type content: application/json: schema: From ed2dbf8250ff98b94ef83dd6d7f9acd7e3dbe126 Mon Sep 17 00:00:00 2001 From: rameshsentient <51635015+rameshsentient@users.noreply.github.com> Date: Thu, 25 Feb 2021 14:19:43 +0530 Subject: [PATCH 557/792] Update d&b_business_check_sg.yaml --- data/d&b_business_check_sg.yaml | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/data/d&b_business_check_sg.yaml b/data/d&b_business_check_sg.yaml index 3bcfe57af..b656d1800 100644 --- a/data/d&b_business_check_sg.yaml +++ b/data/d&b_business_check_sg.yaml @@ -76,13 +76,13 @@ paths: schema: $ref: '#/components/schemas/inputfieldmissing' '413': - description: Input Limit Exceeded + description: Payload Too Large content: application/json: schema: - $ref: '#/components/schemas/inputlimitexceeded' + $ref: '#/components/schemas/inputlimitexceeded' '415': - description: Invalid Input + description: Unsupported Media Type content: application/json: schema: From ad95c05a56e852fc9c80ca3165dcffb4c0a1a070 Mon Sep 17 00:00:00 2001 From: rameshsentient <51635015+rameshsentient@users.noreply.github.com> Date: Thu, 25 Feb 2021 14:20:22 +0530 Subject: [PATCH 558/792] Update demographics_classification.yaml --- data/demographics_classification.yaml | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/data/demographics_classification.yaml b/data/demographics_classification.yaml index 6fa1083f6..f55e83701 100644 --- a/data/demographics_classification.yaml +++ b/data/demographics_classification.yaml @@ -71,13 +71,13 @@ paths: schema: $ref: '#/components/schemas/inputfieldmissing' '413': - description: Input Limit Exceeded + description: Payload Too Large content: application/json: schema: - $ref: '#/components/schemas/inputlimitexceeded' + $ref: '#/components/schemas/inputlimitexceeded' '415': - description: Invalid Input + description: Unsupported Media Type content: application/json: schema: From 2977fd013c7398a36964611516fa0e2637e5abfc Mon Sep 17 00:00:00 2001 From: rameshsentient <51635015+rameshsentient@users.noreply.github.com> Date: Thu, 25 Feb 2021 14:20:38 +0530 Subject: [PATCH 559/792] Update demographics_hdb_sg.yaml --- data/demographics_hdb_sg.yaml | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/data/demographics_hdb_sg.yaml b/data/demographics_hdb_sg.yaml index bc9353022..633459393 100644 --- a/data/demographics_hdb_sg.yaml +++ b/data/demographics_hdb_sg.yaml @@ -195,13 +195,13 @@ paths: schema: $ref: '#/components/schemas/inputfieldmissing' '413': - description: Input Limit Exceeded + description: Payload Too Large content: application/json: schema: - $ref: '#/components/schemas/inputlimitexceeded' + $ref: '#/components/schemas/inputlimitexceeded' '415': - description: Invalid Input + description: Unsupported Media Type content: application/json: schema: From 80a2bbc6f52cb0f4160255d01a7ba23ce116c624 Mon Sep 17 00:00:00 2001 From: rameshsentient <51635015+rameshsentient@users.noreply.github.com> Date: Thu, 25 Feb 2021 14:20:49 +0530 Subject: [PATCH 560/792] Update directory_of_singapore_startups.yaml --- data/directory_of_singapore_startups.yaml | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/data/directory_of_singapore_startups.yaml b/data/directory_of_singapore_startups.yaml index 87562de87..79eabcca0 100644 --- a/data/directory_of_singapore_startups.yaml +++ b/data/directory_of_singapore_startups.yaml @@ -218,13 +218,13 @@ paths: schema: $ref: '#/components/schemas/inputfieldmissing' '413': - description: Input Limit Exceeded + description: Payload Too Large content: application/json: schema: - $ref: '#/components/schemas/inputlimitexceeded' + $ref: '#/components/schemas/inputlimitexceeded' '415': - description: Invalid Input + description: Unsupported Media Type content: application/json: schema: From 6b5a17e69f354289a9010d78752f66299ea60ceb Mon Sep 17 00:00:00 2001 From: rameshsentient <51635015+rameshsentient@users.noreply.github.com> Date: Thu, 25 Feb 2021 14:20:57 +0530 Subject: [PATCH 561/792] Update faulty_traffic_lights.yaml --- data/faulty_traffic_lights.yaml | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/data/faulty_traffic_lights.yaml b/data/faulty_traffic_lights.yaml index 28aa538ae..9be7169f8 100644 --- a/data/faulty_traffic_lights.yaml +++ b/data/faulty_traffic_lights.yaml @@ -65,13 +65,13 @@ paths: schema: $ref: '#/components/schemas/inputfieldmissing' '413': - description: Input Limit Exceeded + description: Payload Too Large content: application/json: schema: - $ref: '#/components/schemas/inputlimitexceeded' + $ref: '#/components/schemas/inputlimitexceeded' '415': - description: Invalid Input + description: Unsupported Media Type content: application/json: schema: From fa41395ea7eee2406e0e9b5c87b12b52a8c5b124 Mon Sep 17 00:00:00 2001 From: rameshsentient <51635015+rameshsentient@users.noreply.github.com> Date: Thu, 25 Feb 2021 14:21:45 +0530 Subject: [PATCH 562/792] Delete page_profiler_eng.yaml --- data/page_profiler_eng.yaml | 255 ------------------------------------ 1 file changed, 255 deletions(-) delete mode 100644 data/page_profiler_eng.yaml diff --git a/data/page_profiler_eng.yaml b/data/page_profiler_eng.yaml deleted file mode 100644 index 780eb4217..000000000 --- a/data/page_profiler_eng.yaml +++ /dev/null @@ -1,255 +0,0 @@ - openapi: 3.0.1 - info: - title: Page Profiler ENG - description: |+ - This NLP microservice retrieves web content in English from the input URL. - - From the web content, the microservice then applies natural language processing to extracts named-entities and returns the output. - - The named-entity classes extracted are persons, locations, organisations and miscellaneous.

This microservice automatically extracts structured information from unstructured text data such as chatlogs, emails, news articles, etc. - - Do ensure that your URL text is in the **ASCII format**. - x-additionalinfo: |+ - Suggested Use Cases: - - Gain insights from online customers - extract structured information from unstructured text data such as chatlogs, emails, news articles, etc. to find and label fields within a document and then apply sentiment analysis to understand customer opinions to find actionable product and UX insights. - - - Entity analysis - identify entities within documents, including receipts, invoices, and contracts; and label them by types such as date, person, contact information, organization, location, events, products, and media. - version: '1.0.0' - x-subscribelink: page_profiler_eng - x-depreciated: "Oct 15, 2020" - servers: - - url: 'https://apis.sentient.io' - tags: - - name: "v1.0.0" - description: "Published Date - May 15, 2020" - paths: - /microservices/nlp/pageprofiler/v1.0/getpredictions: - post: - tags: - - v1.0.0 - responses: - '200': - description: success response - content: - application/json: - schema: - $ref: '#/components/schemas/success' - example: {"LOC": ["Beijing","Atlanta","Indonesia"], "MISC": [Twiight,Singaporean],"ORG": [CNA,Singapore Parliament],"PER": [Skip Navigation,Bookmarks]} - '401': - description: Unauthorized - content: - application/json: - schema: - $ref: '#/components/schemas/unauthorized' - '402': - description: Payment Required - content: - application/json: - schema: - $ref: '#/components/schemas/paymentrequired' - '403': - description: Forbidden - content: - application/json: - schema: - $ref: '#/components/schemas/forbidden' - '404': - description: Not Found - content: - application/json: - schema: - $ref: '#/components/schemas/notfound' - '419': - description: Not Found - content: - application/json: - schema: - $ref: '#/components/schemas/inputfieldmissing' - '420': - description: Not Found - content: - application/json: - schema: - $ref: '#/components/schemas/inputlimitexceeded' - '422': - description: Invalid Input - content: - application/json: - schema: - $ref: '#/components/schemas/invalidinput' - '500': - description: Internal Server Error - content: - application/json: - schema: - $ref: '#/components/schemas/servererror' - '504': - description: Gateway Timeout - content: - application/json: - schema: - $ref: '#/components/schemas/gatewaytimeout' - security: - - APIAuthorizer: [] - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/input' - required: true - components: - schemas: - success: - type: object - properties: - LOC: - type: array - example: ["Beijing","Atlanta","Indonesia"] - description: "name of location found in the text string" - MISC: - type: array - example: [Twiight,Singaporean] - description: "name of miscellaneous names found in the text string" - ORG: - type: array - example: [CNA,Singapore Parliament] - description: "name of organizations found in the text string" - PER: - type: array - example: [Skip Navigation,Bookmarks] - description: "name of persons found in the text string" - - unauthorized: - type: object - properties: - message: - type: string - example: Missing Authentication Token - status: - type: string - example: Failure - forbidden: - type: object - properties: - message: - type: string - example: Access Denied Unauthorized User - status: - type: string - example: Failure - paymentrequired: - type: object - properties: - message: - type: string - example: Insufficient Credits Kindly Top Up - status: - type: string - example: Failure - notfound: - type: object - properties: - message: - type: string - example: Invalid Request URL - status: - type: string - example: Failure - servererror: - type: object - properties: - message: - type: string - example: Internal Server Error - status: - type: string - example: Failure - invalidinput: - type: object - properties: - message: - type: string - example: Invalid Input - status: - type: string - example: Failure - gatewaytimeout: - type: object - properties: - message: - type: string - example: Request Timeout - status: - type: string - example: Failure - inputfieldmissing: - type: object - properties: - message: - type: string - example: Input Field Missing - status: - type: string - example: Failure - inputlimitexceeded: - type: object - properties: - message: - type: string - example: Input Limit Exceeded - status: - type: string - example: Failure - versions: - type: object - properties: - v2.1.0: - type: array - items: - oneOf: - - type: string - example: Published Date - Oct 30, 2020 - description: Partial URL support - v2.0.0: - type: array - items: - oneOf: - - type: string - example: Published Date - Sep 30, 2020 - description: Standardizing Output JSON - v1.0.0: - type: array - items: - oneOf: - - type: string - example: Published Date - May 15, 2018 - description: Swaping the NLP with Named-Entity Recognition ENG - v0.1.0: - type: array - items: - oneOf: - - type: string - example: Published Date - Apr 16, 2018 - description: Initial version release - input: - type: object - required: - - url - properties: - url: - x-name: url - type: string - default: true - example: https://www.sentient.io/en/ - description: |+ - The URL of the page to be profiled. - - Note that the URL has to be spelt in full, including "https://www." - - securitySchemes: - APIAuthorizer: - type: apiKey - name: x-api-key - in: header - x-amazon-apigateway-authtype: custom - description: Authentication is done using the x-api-key in the request header From c3af2cf79f25e7625ff0d50c961b4769c8e8eedf Mon Sep 17 00:00:00 2001 From: rameshsentient <51635015+rameshsentient@users.noreply.github.com> Date: Thu, 25 Feb 2021 14:22:23 +0530 Subject: [PATCH 563/792] Update residential_sales_and_rental_hdb_sg.yaml --- data/residential_sales_and_rental_hdb_sg.yaml | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/data/residential_sales_and_rental_hdb_sg.yaml b/data/residential_sales_and_rental_hdb_sg.yaml index 3e298bc09..2894d1aa0 100644 --- a/data/residential_sales_and_rental_hdb_sg.yaml +++ b/data/residential_sales_and_rental_hdb_sg.yaml @@ -212,13 +212,13 @@ paths: schema: $ref: '#/components/schemas/inputfieldmissing' '413': - description: Input Limit Exceeded + description: Payload Too Large content: application/json: schema: - $ref: '#/components/schemas/inputlimitexceeded' + $ref: '#/components/schemas/inputlimitexceeded' '415': - description: Invalid Input + description: Unsupported Media Type content: application/json: schema: From e9a20d948627ac528203472c3613bbe9e7597c0c Mon Sep 17 00:00:00 2001 From: rameshsentient <51635015+rameshsentient@users.noreply.github.com> Date: Thu, 25 Feb 2021 14:22:32 +0530 Subject: [PATCH 564/792] Update fitness_stations_and_playgrounds_hdb_sg.yaml --- data/fitness_stations_and_playgrounds_hdb_sg.yaml | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/data/fitness_stations_and_playgrounds_hdb_sg.yaml b/data/fitness_stations_and_playgrounds_hdb_sg.yaml index 5dd69f4c5..d8b96e000 100644 --- a/data/fitness_stations_and_playgrounds_hdb_sg.yaml +++ b/data/fitness_stations_and_playgrounds_hdb_sg.yaml @@ -90,13 +90,13 @@ paths: schema: $ref: '#/components/schemas/inputfieldmissing' '413': - description: Input Limit Exceeded + description: Payload Too Large content: application/json: schema: - $ref: '#/components/schemas/inputlimitexceeded' + $ref: '#/components/schemas/inputlimitexceeded' '415': - description: Invalid Input + description: Unsupported Media Type content: application/json: schema: From b7b7754c454340d66b8d1ea0e1d36438f500f8ff Mon Sep 17 00:00:00 2001 From: rameshsentient <51635015+rameshsentient@users.noreply.github.com> Date: Thu, 25 Feb 2021 14:22:43 +0530 Subject: [PATCH 565/792] Update flat_ownership_hdb_sg.yaml --- data/flat_ownership_hdb_sg.yaml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/data/flat_ownership_hdb_sg.yaml b/data/flat_ownership_hdb_sg.yaml index 0961fd126..717738521 100644 --- a/data/flat_ownership_hdb_sg.yaml +++ b/data/flat_ownership_hdb_sg.yaml @@ -200,13 +200,13 @@ paths: schema: $ref: '#/components/schemas/inputfieldmissing' '413': - description: Input Limit Exceeded + description: Payload Too Large content: application/json: schema: $ref: '#/components/schemas/inputlimitexceeded' '415': - description: Invalid Input + description: Unsupported Media Type content: application/json: schema: From bd12632c1691b123edda5b7aaa3865fc7adc5304 Mon Sep 17 00:00:00 2001 From: rameshsentient <51635015+rameshsentient@users.noreply.github.com> Date: Thu, 25 Feb 2021 14:22:54 +0530 Subject: [PATCH 566/792] Update ihi_data_pointcloud.yaml --- data/ihi_data_pointcloud.yaml | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/data/ihi_data_pointcloud.yaml b/data/ihi_data_pointcloud.yaml index eeb22bae8..98f1192fa 100644 --- a/data/ihi_data_pointcloud.yaml +++ b/data/ihi_data_pointcloud.yaml @@ -202,13 +202,13 @@ paths: schema: $ref: '#/components/schemas/inputfieldmissing' '413': - description: Input Limit Exceeded + description: Payload Too Large content: application/json: schema: - $ref: '#/components/schemas/inputlimitexceeded' + $ref: '#/components/schemas/inputlimitexceeded' '415': - description: Invalid Input + description: Unsupported Media Type content: application/json: schema: From a188ccf3315936f56570fc7f7958d164c44f23de Mon Sep 17 00:00:00 2001 From: rameshsentient <51635015+rameshsentient@users.noreply.github.com> Date: Thu, 25 Feb 2021 14:23:41 +0530 Subject: [PATCH 567/792] Update road_works.yaml --- data/road_works.yaml | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/data/road_works.yaml b/data/road_works.yaml index e596cca9c..557aa6f4a 100644 --- a/data/road_works.yaml +++ b/data/road_works.yaml @@ -63,13 +63,13 @@ paths: schema: $ref: '#/components/schemas/inputfieldmissing' '413': - description: Input Limit Exceeded + description: Payload Too Large content: application/json: schema: - $ref: '#/components/schemas/inputlimitexceeded' + $ref: '#/components/schemas/inputlimitexceeded' '415': - description: Invalid Input + description: Unsupported Media Type content: application/json: schema: From 15e20a3c5f492750cc83ae47191f3fb60a495736 Mon Sep 17 00:00:00 2001 From: rameshsentient <51635015+rameshsentient@users.noreply.github.com> Date: Thu, 25 Feb 2021 14:23:50 +0530 Subject: [PATCH 568/792] Update season_parking_availability_hdb_sg.yaml --- data/season_parking_availability_hdb_sg.yaml | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/data/season_parking_availability_hdb_sg.yaml b/data/season_parking_availability_hdb_sg.yaml index ffe3d2bd6..80a6e7876 100644 --- a/data/season_parking_availability_hdb_sg.yaml +++ b/data/season_parking_availability_hdb_sg.yaml @@ -194,13 +194,13 @@ paths: schema: $ref: '#/components/schemas/inputfieldmissing' '413': - description: Input Limit Exceeded + description: Payload Too Large content: application/json: schema: - $ref: '#/components/schemas/inputlimitexceeded' + $ref: '#/components/schemas/inputlimitexceeded' '415': - description: Invalid Input + description: Unsupported Media Type content: application/json: schema: From b8679b2b7bea91ee41eed223af646c048319c66c Mon Sep 17 00:00:00 2001 From: rameshsentient <51635015+rameshsentient@users.noreply.github.com> Date: Thu, 25 Feb 2021 14:23:57 +0530 Subject: [PATCH 569/792] Update traffic_images.yaml --- data/traffic_images.yaml | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/data/traffic_images.yaml b/data/traffic_images.yaml index 9ff632f3d..11273d1bf 100644 --- a/data/traffic_images.yaml +++ b/data/traffic_images.yaml @@ -61,13 +61,13 @@ paths: schema: $ref: '#/components/schemas/inputfieldmissing' '413': - description: Input Limit Exceeded + description: Payload Too Large content: application/json: schema: - $ref: '#/components/schemas/inputlimitexceeded' + $ref: '#/components/schemas/inputlimitexceeded' '415': - description: Invalid Input + description: Unsupported Media Type content: application/json: schema: From 5415a7f4a03b90210948358aee0a386e174bde32 Mon Sep 17 00:00:00 2001 From: rameshsentient <51635015+rameshsentient@users.noreply.github.com> Date: Thu, 25 Feb 2021 14:24:06 +0530 Subject: [PATCH 570/792] Update traffic_incidents.yaml --- data/traffic_incidents.yaml | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/data/traffic_incidents.yaml b/data/traffic_incidents.yaml index 0a3005a03..f1f4c5d29 100644 --- a/data/traffic_incidents.yaml +++ b/data/traffic_incidents.yaml @@ -61,13 +61,13 @@ paths: schema: $ref: '#/components/schemas/inputfieldmissing' '413': - description: Input Limit Exceeded + description: Payload Too Large content: application/json: schema: - $ref: '#/components/schemas/inputlimitexceeded' + $ref: '#/components/schemas/inputlimitexceeded' '415': - description: Invalid Input + description: Unsupported Media Type content: application/json: schema: From a2ef469310e4ce59b2ef3c162587c3a7d76781c2 Mon Sep 17 00:00:00 2001 From: rameshsentient <51635015+rameshsentient@users.noreply.github.com> Date: Thu, 25 Feb 2021 14:24:14 +0530 Subject: [PATCH 571/792] Update vms.yaml --- data/vms.yaml | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/data/vms.yaml b/data/vms.yaml index 3cd3cd3cb..80fe5d34e 100644 --- a/data/vms.yaml +++ b/data/vms.yaml @@ -62,13 +62,13 @@ paths: schema: $ref: '#/components/schemas/inputfieldmissing' '413': - description: Input Limit Exceeded + description: Payload Too Large content: application/json: schema: - $ref: '#/components/schemas/inputlimitexceeded' + $ref: '#/components/schemas/inputlimitexceeded' '415': - description: Invalid Input + description: Unsupported Media Type content: application/json: schema: From 750b51a62a275a25c7b1bcb9f315dabe7a72c32d Mon Sep 17 00:00:00 2001 From: priyaPeristera Date: Thu, 25 Feb 2021 20:13:21 +1100 Subject: [PATCH 572/792] Update the name --- data/{weather_api.yaml => realtime_weather.yaml} | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) rename data/{weather_api.yaml => realtime_weather.yaml} (99%) diff --git a/data/weather_api.yaml b/data/realtime_weather.yaml similarity index 99% rename from data/weather_api.yaml rename to data/realtime_weather.yaml index a22fcdf9c..2140ffb24 100644 --- a/data/weather_api.yaml +++ b/data/realtime_weather.yaml @@ -1,6 +1,6 @@ openapi: 3.0.1 info: - title: Weather Api + title: Realtime Weather description: |+ Current weather or realtime weather API method allows a user to get up to date current weather information. The data is returned as a Current Object. From a059839d491f69f08e20e3f4629d43264696beb6 Mon Sep 17 00:00:00 2001 From: priyaPeristera Date: Thu, 25 Feb 2021 20:19:09 +1100 Subject: [PATCH 573/792] Update the file names --- index.yaml | 40 ++++++++++++++++++++-------------------- 1 file changed, 20 insertions(+), 20 deletions(-) diff --git a/index.yaml b/index.yaml index b6e4454d9..c2ce8a3e4 100644 --- a/index.yaml +++ b/index.yaml @@ -276,34 +276,34 @@ data: title: D&B Brief Financial Information (SG) versions: 0.1.0: 'd&b_brief_financial_information_sg.yaml' - ihi_data_pointcloud: - title: IHI Point Cloud + lidar_trajectory_data: + title: LiDAR Trajectory Data versions: - 0.1.0: 'ihi_data_pointcloud.yaml' - faulty_traffic_lights: - title: Faulty Traffic Lights + 0.1.0: 'lidar_trajectory_data.yaml' + lta_faulty_traffic_lights: + title: LTA Faulty Traffic Lights versions: - 0.1.0: 'faulty_traffic_lights.yaml' - road_works: - title: Road Works + 0.1.0: 'lta_faulty_traffic_lights.yaml' + lta_road_works: + title: LTA Road Works versions: - 0.1.0: 'road_works.yaml' - vms: - title: VMS + 0.1.0: 'lta_road_works.yaml' + lta_vms: + title: LTA VMS versions: - 0.1.0: 'vms.yaml' - traffic_images: - title: Traffic Images + 0.1.0: 'lta_vms.yaml' + lta_traffic_images: + title: LTA Traffic Images versions: - 0.1.0: 'traffic_images.yaml' - traffic_incidents: - title: Traffic Incidents + 0.1.0: 'lta_traffic_images.yaml' + lta_traffic_incidents: + title: LTA Traffic Incidents versions: - 0.1.0: 'traffic_incidents.yaml' + 0.1.0: 'lta_traffic_incidents.yaml' realtime_weather: - title: Weather Api + title: Realtime Weather versions: - 0.1.0: 'weather_api.yaml' + 0.1.0: 'realtime_weather.yaml' data alliance: download_dataset_api: title: Download Dataset API From 66cd9d1930354483d8cc45bcf614eaf04f92f171 Mon Sep 17 00:00:00 2001 From: priyaPeristera Date: Thu, 25 Feb 2021 20:20:21 +1100 Subject: [PATCH 574/792] Update and rename faulty_traffic_lights.yaml to lta_faulty_traffic_lights.yaml --- ...y_traffic_lights.yaml => lta_faulty_traffic_lights.yaml} | 6 ++---- 1 file changed, 2 insertions(+), 4 deletions(-) rename data/{faulty_traffic_lights.yaml => lta_faulty_traffic_lights.yaml} (97%) diff --git a/data/faulty_traffic_lights.yaml b/data/lta_faulty_traffic_lights.yaml similarity index 97% rename from data/faulty_traffic_lights.yaml rename to data/lta_faulty_traffic_lights.yaml index 9be7169f8..a096d0292 100644 --- a/data/faulty_traffic_lights.yaml +++ b/data/lta_faulty_traffic_lights.yaml @@ -1,10 +1,8 @@ openapi: 3.0.1 info: - title: Faulty Traffic Lights + title: LTA Faulty Traffic Lights description: |+ - Returns alerts of traffic lights that are currently faulty, or currently - undergoing scheduled maintenance. - 2 minutes – whenever there are updates + Returns alerts of traffic lights that are currently faulty, or currently undergoing scheduled maintenance. Updated every 2 minutes or whenever there are updates version: '0.1.0' servers: - url: 'https://api.sentient.io' From 50ca6cc78c5990e90eecb0730d4026bcd29e74e8 Mon Sep 17 00:00:00 2001 From: priyaPeristera Date: Thu, 25 Feb 2021 20:22:14 +1100 Subject: [PATCH 575/792] Update and rename ihi_data_pointcloud.yaml to lidar_trajectory_data.yaml --- data/{ihi_data_pointcloud.yaml => lidar_trajectory_data.yaml} | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) rename data/{ihi_data_pointcloud.yaml => lidar_trajectory_data.yaml} (99%) diff --git a/data/ihi_data_pointcloud.yaml b/data/lidar_trajectory_data.yaml similarity index 99% rename from data/ihi_data_pointcloud.yaml rename to data/lidar_trajectory_data.yaml index 98f1192fa..4026706c3 100644 --- a/data/ihi_data_pointcloud.yaml +++ b/data/lidar_trajectory_data.yaml @@ -1,7 +1,7 @@ openapi: 3.0.1 info: - title: IHI Pointcloud Data - x-subscribelink: ihi_data + title: LiDAR Trajectory Data + x-subscribelink: lidar_trajectory_data description: |+ This microservice returns information on Ishikawajima-Harima Heavy Industries(IHI) Pointcloud Data which includes the 3DLR Location of Boon Lay Way-Yuan Ching Road, Singapore. The Data comprises all the vehicle detection and does not contain any pedestrian data. The IHI LiDAR programme makes selected public and non-public datasets available to developers and companies to improve their service offerings to benefit the lives of Singapore citizens. Sentient.io is proud to partner with IHI to manage and facilitate the sharing of data for the LiDAR Programme. From dc73c8bdf0c814e9c91728d5424ba3832c5312c7 Mon Sep 17 00:00:00 2001 From: priyaPeristera Date: Thu, 25 Feb 2021 20:27:50 +1100 Subject: [PATCH 576/792] Update and rename traffic_images.yaml to lta_traffic_images.yaml --- data/{traffic_images.yaml => lta_traffic_images.yaml} | 6 ++---- 1 file changed, 2 insertions(+), 4 deletions(-) rename data/{traffic_images.yaml => lta_traffic_images.yaml} (98%) diff --git a/data/traffic_images.yaml b/data/lta_traffic_images.yaml similarity index 98% rename from data/traffic_images.yaml rename to data/lta_traffic_images.yaml index 11273d1bf..2bdf1bf53 100644 --- a/data/traffic_images.yaml +++ b/data/lta_traffic_images.yaml @@ -1,10 +1,8 @@ openapi: 3.0.1 info: - title: Traffic Images + title: LTA Traffic Images description: |+ - Returns links to images of live traffic conditions along expressways and - Woodlands & Tuas Checkpoints. - 1 to 5 minutes – whenever there are updates + Returns links to images of live traffic conditions along expressways and Woodlands & Tuas Checkpoints. Updates every 1 to 5 minutes or whenever there are updates. version: '0.1.0' servers: - url: 'https://api.sentient.io' From e1089138b4cbb639f2508c2a1a3bae7f68503daa Mon Sep 17 00:00:00 2001 From: priyaPeristera Date: Thu, 25 Feb 2021 20:34:11 +1100 Subject: [PATCH 577/792] Update realtime_weather.yaml --- data/realtime_weather.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/data/realtime_weather.yaml b/data/realtime_weather.yaml index 2140ffb24..3d19b057c 100644 --- a/data/realtime_weather.yaml +++ b/data/realtime_weather.yaml @@ -384,7 +384,7 @@ components: city: type: string default: true - example: chennai + example: punggol description: city name securitySchemes: APIAuthorizer: From 6cde7c318cea2097f6cb63b8b855f4f8e5e3d8ca Mon Sep 17 00:00:00 2001 From: priyaPeristera Date: Thu, 25 Feb 2021 21:08:30 +1100 Subject: [PATCH 578/792] Update and rename traffic_incidents.yaml to lta_traffic_incidents.yaml --- data/{traffic_incidents.yaml => lta_traffic_incidents.yaml} | 6 ++---- 1 file changed, 2 insertions(+), 4 deletions(-) rename data/{traffic_incidents.yaml => lta_traffic_incidents.yaml} (96%) diff --git a/data/traffic_incidents.yaml b/data/lta_traffic_incidents.yaml similarity index 96% rename from data/traffic_incidents.yaml rename to data/lta_traffic_incidents.yaml index f1f4c5d29..9917331c7 100644 --- a/data/traffic_incidents.yaml +++ b/data/lta_traffic_incidents.yaml @@ -1,10 +1,8 @@ openapi: 3.0.1 info: - title: Traffic Incidents + title: LTA Traffic Incidents description: |+ - Returns incidents currently happening on the roads, such as - Accidents, Vehicle Breakdowns, Road Blocks, Traffic Diversions etc. - 2 minutes – whenever there are updates + Returns incidents currently happening on the roads, such as Accidents, Vehicle Breakdowns, Road Blocks, Traffic Diversions etc. Updated every 2 minutes or whenever there are updates. version: '0.1.0' servers: - url: 'https://api.sentient.io' From 74a4e83b51fe0183f2387044ceb690e8dd8bedf7 Mon Sep 17 00:00:00 2001 From: priyaPeristera Date: Thu, 25 Feb 2021 21:14:27 +1100 Subject: [PATCH 579/792] Update lta_faulty_traffic_lights.yaml --- data/lta_faulty_traffic_lights.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/data/lta_faulty_traffic_lights.yaml b/data/lta_faulty_traffic_lights.yaml index a096d0292..19958fd86 100644 --- a/data/lta_faulty_traffic_lights.yaml +++ b/data/lta_faulty_traffic_lights.yaml @@ -10,7 +10,7 @@ tags: - name: "v0.1.0" description: "Published Date - Feb 28, 2021" paths: - /DaaS/dev/lta/FaultyTrafficLights: + /DaaS/dev/lta/TrafficIncidents: get: tags: - v0.1.0 From 0b7bb5e165a874b2f393e937437752f4716bd83d Mon Sep 17 00:00:00 2001 From: priyaPeristera Date: Thu, 25 Feb 2021 21:16:47 +1100 Subject: [PATCH 580/792] Update lta_faulty_traffic_lights.yaml --- data/lta_faulty_traffic_lights.yaml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/data/lta_faulty_traffic_lights.yaml b/data/lta_faulty_traffic_lights.yaml index 19958fd86..f3016cac3 100644 --- a/data/lta_faulty_traffic_lights.yaml +++ b/data/lta_faulty_traffic_lights.yaml @@ -1,8 +1,8 @@ openapi: 3.0.1 info: - title: LTA Faulty Traffic Lights + title: LTA Traffic Incidents description: |+ - Returns alerts of traffic lights that are currently faulty, or currently undergoing scheduled maintenance. Updated every 2 minutes or whenever there are updates + Returns incidents currently happening on the roads, such as Accidents, Vehicle Breakdowns, Road Blocks, Traffic Diversions etc. Updated every 2 minutes or whenever there are updates. version: '0.1.0' servers: - url: 'https://api.sentient.io' From 7e4e9301b40b32c0796b22be9e9cb915d7523857 Mon Sep 17 00:00:00 2001 From: priyaPeristera Date: Thu, 25 Feb 2021 21:53:55 +1100 Subject: [PATCH 581/792] Update lta_traffic_incidents.yaml --- data/lta_traffic_incidents.yaml | 1 + 1 file changed, 1 insertion(+) diff --git a/data/lta_traffic_incidents.yaml b/data/lta_traffic_incidents.yaml index 9917331c7..c1edfeb19 100644 --- a/data/lta_traffic_incidents.yaml +++ b/data/lta_traffic_incidents.yaml @@ -1,6 +1,7 @@ openapi: 3.0.1 info: title: LTA Traffic Incidents + x-subscribelink: lta_traffic_incidents description: |+ Returns incidents currently happening on the roads, such as Accidents, Vehicle Breakdowns, Road Blocks, Traffic Diversions etc. Updated every 2 minutes or whenever there are updates. version: '0.1.0' From 13ed61bdb885f0ca4c8d9b8e0e9fa8b68de7b0b0 Mon Sep 17 00:00:00 2001 From: priyaPeristera Date: Thu, 25 Feb 2021 22:00:11 +1100 Subject: [PATCH 582/792] Update lta_traffic_incidents.yaml --- data/lta_traffic_incidents.yaml | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/data/lta_traffic_incidents.yaml b/data/lta_traffic_incidents.yaml index c1edfeb19..f5fff2805 100644 --- a/data/lta_traffic_incidents.yaml +++ b/data/lta_traffic_incidents.yaml @@ -1,9 +1,9 @@ openapi: 3.0.1 info: - title: LTA Traffic Incidents + title: LTA Faulty Traffic Lights x-subscribelink: lta_traffic_incidents description: |+ - Returns incidents currently happening on the roads, such as Accidents, Vehicle Breakdowns, Road Blocks, Traffic Diversions etc. Updated every 2 minutes or whenever there are updates. + Returns alerts of traffic lights that are currently faulty, or currently undergoing scheduled maintenance. Updated every 2 minutes or whenever there are updates. version: '0.1.0' servers: - url: 'https://api.sentient.io' @@ -11,7 +11,7 @@ tags: - name: "v0.1.0" description: "Published Date - Feb 28, 2021" paths: - /DaaS/dev/lta/TrafficIncidents: + /DaaS/dev/lta/FaultyTrafficLights: get: tags: - v0.1.0 From a0e04810f921d53c7e346ed8302ce95ea97378cf Mon Sep 17 00:00:00 2001 From: priyaPeristera Date: Thu, 25 Feb 2021 22:07:31 +1100 Subject: [PATCH 583/792] Update lta_traffic_incidents.yaml --- data/lta_traffic_incidents.yaml | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/data/lta_traffic_incidents.yaml b/data/lta_traffic_incidents.yaml index f5fff2805..c1edfeb19 100644 --- a/data/lta_traffic_incidents.yaml +++ b/data/lta_traffic_incidents.yaml @@ -1,9 +1,9 @@ openapi: 3.0.1 info: - title: LTA Faulty Traffic Lights + title: LTA Traffic Incidents x-subscribelink: lta_traffic_incidents description: |+ - Returns alerts of traffic lights that are currently faulty, or currently undergoing scheduled maintenance. Updated every 2 minutes or whenever there are updates. + Returns incidents currently happening on the roads, such as Accidents, Vehicle Breakdowns, Road Blocks, Traffic Diversions etc. Updated every 2 minutes or whenever there are updates. version: '0.1.0' servers: - url: 'https://api.sentient.io' @@ -11,7 +11,7 @@ tags: - name: "v0.1.0" description: "Published Date - Feb 28, 2021" paths: - /DaaS/dev/lta/FaultyTrafficLights: + /DaaS/dev/lta/TrafficIncidents: get: tags: - v0.1.0 From 9425b8b63f3ab7f6d82455841322c652e46d3ec0 Mon Sep 17 00:00:00 2001 From: priyaPeristera Date: Thu, 25 Feb 2021 22:25:27 +1100 Subject: [PATCH 584/792] Update lta_faulty_traffic_lights.yaml --- data/lta_faulty_traffic_lights.yaml | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/data/lta_faulty_traffic_lights.yaml b/data/lta_faulty_traffic_lights.yaml index f3016cac3..bad5a5843 100644 --- a/data/lta_faulty_traffic_lights.yaml +++ b/data/lta_faulty_traffic_lights.yaml @@ -1,8 +1,9 @@ openapi: 3.0.1 info: - title: LTA Traffic Incidents + title: LTA Faulty Traffic Lights + x-subscribelink: lta_faulty_traffic_lights description: |+ - Returns incidents currently happening on the roads, such as Accidents, Vehicle Breakdowns, Road Blocks, Traffic Diversions etc. Updated every 2 minutes or whenever there are updates. + Returns alerts of traffic lights that are currently faulty, or currently undergoing scheduled maintenance. Updated every 2 minutes or whenever there are updates. version: '0.1.0' servers: - url: 'https://api.sentient.io' @@ -10,7 +11,7 @@ tags: - name: "v0.1.0" description: "Published Date - Feb 28, 2021" paths: - /DaaS/dev/lta/TrafficIncidents: + /DaaS/dev/lta/FaultyTrafficLights: get: tags: - v0.1.0 From 00a1955fbdbc5cd558c86a30a57874450ad8a930 Mon Sep 17 00:00:00 2001 From: Priyadharshini <57977344+priyadharshini-sent@users.noreply.github.com> Date: Fri, 26 Feb 2021 17:24:00 +0530 Subject: [PATCH 585/792] Update index.yaml --- index.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/index.yaml b/index.yaml index c2ce8a3e4..cbbe21df8 100644 --- a/index.yaml +++ b/index.yaml @@ -287,7 +287,7 @@ data: lta_road_works: title: LTA Road Works versions: - 0.1.0: 'lta_road_works.yaml' + 0.1.0: 'road_works.yaml' lta_vms: title: LTA VMS versions: From c74f290298cdf0a0fe66b3d42c35c89af7909830 Mon Sep 17 00:00:00 2001 From: Priyadharshini <57977344+priyadharshini-sent@users.noreply.github.com> Date: Fri, 26 Feb 2021 17:24:30 +0530 Subject: [PATCH 586/792] Update index.yaml --- index.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/index.yaml b/index.yaml index cbbe21df8..c2ce8a3e4 100644 --- a/index.yaml +++ b/index.yaml @@ -287,7 +287,7 @@ data: lta_road_works: title: LTA Road Works versions: - 0.1.0: 'road_works.yaml' + 0.1.0: 'lta_road_works.yaml' lta_vms: title: LTA VMS versions: From c5fbbe2044adfdc769248c8646b5165a65accdf1 Mon Sep 17 00:00:00 2001 From: Priyadharshini <57977344+priyadharshini-sent@users.noreply.github.com> Date: Fri, 26 Feb 2021 17:24:40 +0530 Subject: [PATCH 587/792] Rename road_works.yaml to lta_road_works.yaml --- data/{road_works.yaml => lta_road_works.yaml} | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename data/{road_works.yaml => lta_road_works.yaml} (100%) diff --git a/data/road_works.yaml b/data/lta_road_works.yaml similarity index 100% rename from data/road_works.yaml rename to data/lta_road_works.yaml From c880932c2910737c1fe1359a96e8a0da761a33a2 Mon Sep 17 00:00:00 2001 From: rameshsentient <51635015+rameshsentient@users.noreply.github.com> Date: Mon, 1 Mar 2021 09:37:24 +0530 Subject: [PATCH 588/792] Update lta_traffic_images.yaml --- data/lta_traffic_images.yaml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/data/lta_traffic_images.yaml b/data/lta_traffic_images.yaml index 2bdf1bf53..6d8c33eda 100644 --- a/data/lta_traffic_images.yaml +++ b/data/lta_traffic_images.yaml @@ -1,8 +1,9 @@ openapi: 3.0.1 info: title: LTA Traffic Images + x-subscribelink: lta_traffic_images description: |+ - Returns links to images of live traffic conditions along expressways and Woodlands & Tuas Checkpoints. Updates every 1 to 5 minutes or whenever there are updates. + Returns links to images of live traffic conditions along expressways and Woodlands & Tuas Checkpoints. Updates every 1 to 5 minutes or whenever there are updates. version: '0.1.0' servers: - url: 'https://api.sentient.io' @@ -119,7 +120,6 @@ components: • Link will expire after 5 minutes - unauthorized: type: object properties: From 8b865fad1a2ce66939d2391d139c69f0ca93d757 Mon Sep 17 00:00:00 2001 From: rameshsentient <51635015+rameshsentient@users.noreply.github.com> Date: Mon, 1 Mar 2021 09:51:58 +0530 Subject: [PATCH 589/792] Update lta_traffic_images.yaml --- data/lta_traffic_images.yaml | 68 ++++++++++++++++++++++-------------- 1 file changed, 41 insertions(+), 27 deletions(-) diff --git a/data/lta_traffic_images.yaml b/data/lta_traffic_images.yaml index 6d8c33eda..bad5a5843 100644 --- a/data/lta_traffic_images.yaml +++ b/data/lta_traffic_images.yaml @@ -1,9 +1,9 @@ openapi: 3.0.1 info: - title: LTA Traffic Images - x-subscribelink: lta_traffic_images + title: LTA Faulty Traffic Lights + x-subscribelink: lta_faulty_traffic_lights description: |+ - Returns links to images of live traffic conditions along expressways and Woodlands & Tuas Checkpoints. Updates every 1 to 5 minutes or whenever there are updates. + Returns alerts of traffic lights that are currently faulty, or currently undergoing scheduled maintenance. Updated every 2 minutes or whenever there are updates. version: '0.1.0' servers: - url: 'https://api.sentient.io' @@ -11,7 +11,7 @@ tags: - name: "v0.1.0" description: "Published Date - Feb 28, 2021" paths: - /DaaS/dev/lta/Traffic-Imagesv2: + /DaaS/dev/lta/FaultyTrafficLights: get: tags: - v0.1.0 @@ -23,12 +23,16 @@ paths: schema: $ref: '#/components/schemas/success' example: - odata.metadata: http://datamall2.mytransport.sg/ltaodataservice/$metadata#Traffic-Imagesv2 + odata.metadata: http://datamall2.mytransport.sg/ltaodataservice/$metadata#IncidentSet value: - - CameraID: 1001 - Latitude: 1.3290499998616139 - Longitude: 103.87474391991731 - ImageLink: https://dm-traffic-camera-itsc.s3.amazonaws.com/2021-02-25/15-27/1001_1523_20210225152731_1c29e4.jpg?x-amz-security-token=IQoJb3JpZ2luX2VjEA8aDmFwLXNvdXRoZWFzdC0xIkYwRAIgB9vybH4h7daI43qfBeZMS%2FSX6av1yjSu73Q0kqbTD4ICIDTHpUSoXG7OU3EOtK0z0F6NGxf1c0xQwrULNgEbaiFhKqMDCCgQAhoMMzQwNjQ1MzgxMzA0IgyLggWjvfs4g1sMc4UqgAOZXEmpoGYRlnDs9tu6COLECjNNgalDexWPvFpq1a3A9dDM%2Bp6mRAQxxuja%2Bcob2Ox1fPgE%2Bhf24arud9Xr11cNNybleHqCWnBGsjhOo6JNP2gOraux84cXhEjGarHp4%2FvwXGVFQbmF%2B1J9QQlCa2D4LW%2Ffr8hnBsNGKVMe7k7MoS1QfKePl500wUYvhDJEZqPej54BGt%2BlPGorwFBQ%2B10n8vyiwShBxd%2BHBQFxpbuf72fRS9VAYilkCyp8%2FeohmSVh%2BeJXVWvcS5rGiIKd%2FyTOK7nL91s08EiJ0uhwZNJdbu3XdZPFXPTI%2Ban%2BHSkurfa3%2B05mSo4aP%2FGm5NPxP9xzCphiu65ugpN%2BOYxUwwErT7oTPQjI1ZiUJOXvWGhSA5WpKEzVTNPx3aYDtjB8T7qDky8A%2BjsQyvKQARdxM9buz8H1pej8KDsnHr%2BAgupNy%2F9kNk9kBdxPnj67WaVot9WdIOHcj8knf4SVIZCy%2FMESBMVkXT%2BwRLJ8XJaSFR13sl4wvY3dgQY67AG3IH44KUVXKCnh36UJ5nCpEaT162Y6dleCP2Okragprp%2BhIMQHcb3spNoLRHVcq3Zj%2B53o2s4yF6%2FO6BUe1nSZ31X890J6Wao3yFwhrbyULbRAA8Ni3R%2ForYYK0l3213NtV%2FyaIp9o02EAyG7sWOhvsD7MbofMBI2GS%2FbrmEYHjdSTrMCkZje0zG6Q5L60rWgiRVBn5Sa2ogUYk0c%2F4ecnQ8taiVzEuoQsV5CTB5ou2pQVKP1fbefNyu1B18542VLLqJW8mHZ6eoYf%2FwGK7tqJaJf1sPRr2qZ0YbVtkQCo03ZYm0fetH3mXsCYWQ%3D%3D&AWSAccessKeyId=ASIAU6UAMAS4GTPW2LXI&Expires=1614238351&Signature=6xg03%2FpXKMJDVKyXV7X%2FjeLhVb8%3D + - AlarmID: GL703034136 + NodeID: 703034136 + Type: 13 + StartDate: 2014-04-12 01:58:00.0 + EndDate: 2014-04-13 01:58:00.0 + Message: (23/1)8:58 Flashing Yellow at + Bedok North Interchange/Bedok + North Street 1 Junc '401': description: Unauthorized content: @@ -92,34 +96,44 @@ components: properties: odata.metadata: type: string - example: http://datamall2.mytransport.sg/ltaodataservice/$metadata#RoadWorks + example: http://datamall2.mytransport.sg/ltaodataservice/$metadata#FaultyTrafficLights description: url value: type: array items: type: object properties: - CameraID: + AlarmID: type: string - example: 1001 - description: A unique ID for this camera - Latitude: + example: GL703034136 + description: Technical alarm ID + NodeID: type: string - example: 1.3290499998616139 - description: Latitude map coordinates - Longitude: + example: 703034136 + description: A unique code to represent each + unique traffic light node + Type: + type: number + example: 13 + description: Type of the technical alarm + • 4 (Blackout) + • 13 (Flashing Yellow) + StartDate: type: string - example: 103.87474391991731 - description: Longitude map coordinates - ImageLink: + example: 2014-04-12 01:58:00.0 + description: YYYY-MM-DD HH:MM:SS.ms + EndDate: type: string - example: https://dm-traffic-camera-itsc.s3.amazonaws.com/2021-02-25/15-27/1001_1523_20210225152731_1c29e4.jpg?x-amz-security-token=IQoJb3JpZ2luX2VjEA8aDmFwLXNvdXRoZWFzdC0xIkYwRAIgB9vybH4h7daI43qfBeZMS%2FSX6av1yjSu73Q0kqbTD4ICIDTHpUSoXG7OU3EOtK0z0F6NGxf1c0xQwrULNgEbaiFhKqMDCCgQAhoMMzQwNjQ1MzgxMzA0IgyLggWjvfs4g1sMc4UqgAOZXEmpoGYRlnDs9tu6COLECjNNgalDexWPvFpq1a3A9dDM%2Bp6mRAQxxuja%2Bcob2Ox1fPgE%2Bhf24arud9Xr11cNNybleHqCWnBGsjhOo6JNP2gOraux84cXhEjGarHp4%2FvwXGVFQbmF%2B1J9QQlCa2D4LW%2Ffr8hnBsNGKVMe7k7MoS1QfKePl500wUYvhDJEZqPej54BGt%2BlPGorwFBQ%2B10n8vyiwShBxd%2BHBQFxpbuf72fRS9VAYilkCyp8%2FeohmSVh%2BeJXVWvcS5rGiIKd%2FyTOK7nL91s08EiJ0uhwZNJdbu3XdZPFXPTI%2Ban%2BHSkurfa3%2B05mSo4aP%2FGm5NPxP9xzCphiu65ugpN%2BOYxUwwErT7oTPQjI1ZiUJOXvWGhSA5WpKEzVTNPx3aYDtjB8T7qDky8A%2BjsQyvKQARdxM9buz8H1pej8KDsnHr%2BAgupNy%2F9kNk9kBdxPnj67WaVot9WdIOHcj8knf4SVIZCy%2FMESBMVkXT%2BwRLJ8XJaSFR13sl4wvY3dgQY67AG3IH44KUVXKCnh36UJ5nCpEaT162Y6dleCP2Okragprp%2BhIMQHcb3spNoLRHVcq3Zj%2B53o2s4yF6%2FO6BUe1nSZ31X890J6Wao3yFwhrbyULbRAA8Ni3R%2ForYYK0l3213NtV%2FyaIp9o02EAyG7sWOhvsD7MbofMBI2GS%2FbrmEYHjdSTrMCkZje0zG6Q5L60rWgiRVBn5Sa2ogUYk0c%2F4ecnQ8taiVzEuoQsV5CTB5ou2pQVKP1fbefNyu1B18542VLLqJW8mHZ6eoYf%2FwGK7tqJaJf1sPRr2qZ0YbVtkQCo03ZYm0fetH3mXsCYWQ%3D%3D&AWSAccessKeyId=ASIAU6UAMAS4GTPW2LXI&Expires=1614238351&Signature=6xg03%2FpXKMJDVKyXV7X%2FjeLhVb8%3D - description: • Link for - downloading - this image. - • Link will - expire after - 5 minutes + example: 2014-04-13 01:58:00.0 + description: YYYY-MM-DD HH:MM:SS.ms + (empty field if this is not a + scheduled maintenance) + Message: + type: string + example: (23/1)8:58 Flashing Yellow at + Bedok North Interchange/Bedok + North Street 1 Junc + description: Canning Message unauthorized: type: object properties: From 35d9cc14720b7a623394e53081f1cdd8f967015f Mon Sep 17 00:00:00 2001 From: rameshsentient <51635015+rameshsentient@users.noreply.github.com> Date: Mon, 1 Mar 2021 09:54:35 +0530 Subject: [PATCH 590/792] Update index.yaml --- index.yaml | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/index.yaml b/index.yaml index c2ce8a3e4..4aa8775ef 100644 --- a/index.yaml +++ b/index.yaml @@ -292,10 +292,10 @@ data: title: LTA VMS versions: 0.1.0: 'lta_vms.yaml' - lta_traffic_images: - title: LTA Traffic Images + lta_faulty_traffic_lights: + title: LTA Faulty Traffic Lights versions: - 0.1.0: 'lta_traffic_images.yaml' + 0.1.0: 'lta_faulty_traffic_lights.yaml' lta_traffic_incidents: title: LTA Traffic Incidents versions: From e59c6aee78a2f71075c2aac3564dbcffc6868e8c Mon Sep 17 00:00:00 2001 From: rameshsentient <51635015+rameshsentient@users.noreply.github.com> Date: Mon, 1 Mar 2021 09:56:58 +0530 Subject: [PATCH 591/792] Update index.yaml --- index.yaml | 10 +--------- 1 file changed, 1 insertion(+), 9 deletions(-) diff --git a/index.yaml b/index.yaml index 4aa8775ef..1aacca695 100644 --- a/index.yaml +++ b/index.yaml @@ -288,18 +288,10 @@ data: title: LTA Road Works versions: 0.1.0: 'lta_road_works.yaml' - lta_vms: - title: LTA VMS - versions: - 0.1.0: 'lta_vms.yaml' lta_faulty_traffic_lights: title: LTA Faulty Traffic Lights versions: - 0.1.0: 'lta_faulty_traffic_lights.yaml' - lta_traffic_incidents: - title: LTA Traffic Incidents - versions: - 0.1.0: 'lta_traffic_incidents.yaml' + 0.1.0: 'lta_traffic_images.yaml' realtime_weather: title: Realtime Weather versions: From c322875674213d380edb6614d27cfee9c720e478 Mon Sep 17 00:00:00 2001 From: rameshsentient <51635015+rameshsentient@users.noreply.github.com> Date: Mon, 1 Mar 2021 09:59:06 +0530 Subject: [PATCH 592/792] Update index.yaml --- index.yaml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/index.yaml b/index.yaml index 1aacca695..25b220a50 100644 --- a/index.yaml +++ b/index.yaml @@ -288,8 +288,8 @@ data: title: LTA Road Works versions: 0.1.0: 'lta_road_works.yaml' - lta_faulty_traffic_lights: - title: LTA Faulty Traffic Lights + lta_traffic_images: + title: LTA Traffic Images versions: 0.1.0: 'lta_traffic_images.yaml' realtime_weather: From b195728f843ccd6eed1980dfd3e801c88f07d77e Mon Sep 17 00:00:00 2001 From: rameshsentient <51635015+rameshsentient@users.noreply.github.com> Date: Mon, 1 Mar 2021 10:01:19 +0530 Subject: [PATCH 593/792] Update lta_traffic_images.yaml --- data/lta_traffic_images.yaml | 68 ++++++++++++++---------------------- 1 file changed, 27 insertions(+), 41 deletions(-) diff --git a/data/lta_traffic_images.yaml b/data/lta_traffic_images.yaml index bad5a5843..6d8c33eda 100644 --- a/data/lta_traffic_images.yaml +++ b/data/lta_traffic_images.yaml @@ -1,9 +1,9 @@ openapi: 3.0.1 info: - title: LTA Faulty Traffic Lights - x-subscribelink: lta_faulty_traffic_lights + title: LTA Traffic Images + x-subscribelink: lta_traffic_images description: |+ - Returns alerts of traffic lights that are currently faulty, or currently undergoing scheduled maintenance. Updated every 2 minutes or whenever there are updates. + Returns links to images of live traffic conditions along expressways and Woodlands & Tuas Checkpoints. Updates every 1 to 5 minutes or whenever there are updates. version: '0.1.0' servers: - url: 'https://api.sentient.io' @@ -11,7 +11,7 @@ tags: - name: "v0.1.0" description: "Published Date - Feb 28, 2021" paths: - /DaaS/dev/lta/FaultyTrafficLights: + /DaaS/dev/lta/Traffic-Imagesv2: get: tags: - v0.1.0 @@ -23,16 +23,12 @@ paths: schema: $ref: '#/components/schemas/success' example: - odata.metadata: http://datamall2.mytransport.sg/ltaodataservice/$metadata#IncidentSet + odata.metadata: http://datamall2.mytransport.sg/ltaodataservice/$metadata#Traffic-Imagesv2 value: - - AlarmID: GL703034136 - NodeID: 703034136 - Type: 13 - StartDate: 2014-04-12 01:58:00.0 - EndDate: 2014-04-13 01:58:00.0 - Message: (23/1)8:58 Flashing Yellow at - Bedok North Interchange/Bedok - North Street 1 Junc + - CameraID: 1001 + Latitude: 1.3290499998616139 + Longitude: 103.87474391991731 + ImageLink: https://dm-traffic-camera-itsc.s3.amazonaws.com/2021-02-25/15-27/1001_1523_20210225152731_1c29e4.jpg?x-amz-security-token=IQoJb3JpZ2luX2VjEA8aDmFwLXNvdXRoZWFzdC0xIkYwRAIgB9vybH4h7daI43qfBeZMS%2FSX6av1yjSu73Q0kqbTD4ICIDTHpUSoXG7OU3EOtK0z0F6NGxf1c0xQwrULNgEbaiFhKqMDCCgQAhoMMzQwNjQ1MzgxMzA0IgyLggWjvfs4g1sMc4UqgAOZXEmpoGYRlnDs9tu6COLECjNNgalDexWPvFpq1a3A9dDM%2Bp6mRAQxxuja%2Bcob2Ox1fPgE%2Bhf24arud9Xr11cNNybleHqCWnBGsjhOo6JNP2gOraux84cXhEjGarHp4%2FvwXGVFQbmF%2B1J9QQlCa2D4LW%2Ffr8hnBsNGKVMe7k7MoS1QfKePl500wUYvhDJEZqPej54BGt%2BlPGorwFBQ%2B10n8vyiwShBxd%2BHBQFxpbuf72fRS9VAYilkCyp8%2FeohmSVh%2BeJXVWvcS5rGiIKd%2FyTOK7nL91s08EiJ0uhwZNJdbu3XdZPFXPTI%2Ban%2BHSkurfa3%2B05mSo4aP%2FGm5NPxP9xzCphiu65ugpN%2BOYxUwwErT7oTPQjI1ZiUJOXvWGhSA5WpKEzVTNPx3aYDtjB8T7qDky8A%2BjsQyvKQARdxM9buz8H1pej8KDsnHr%2BAgupNy%2F9kNk9kBdxPnj67WaVot9WdIOHcj8knf4SVIZCy%2FMESBMVkXT%2BwRLJ8XJaSFR13sl4wvY3dgQY67AG3IH44KUVXKCnh36UJ5nCpEaT162Y6dleCP2Okragprp%2BhIMQHcb3spNoLRHVcq3Zj%2B53o2s4yF6%2FO6BUe1nSZ31X890J6Wao3yFwhrbyULbRAA8Ni3R%2ForYYK0l3213NtV%2FyaIp9o02EAyG7sWOhvsD7MbofMBI2GS%2FbrmEYHjdSTrMCkZje0zG6Q5L60rWgiRVBn5Sa2ogUYk0c%2F4ecnQ8taiVzEuoQsV5CTB5ou2pQVKP1fbefNyu1B18542VLLqJW8mHZ6eoYf%2FwGK7tqJaJf1sPRr2qZ0YbVtkQCo03ZYm0fetH3mXsCYWQ%3D%3D&AWSAccessKeyId=ASIAU6UAMAS4GTPW2LXI&Expires=1614238351&Signature=6xg03%2FpXKMJDVKyXV7X%2FjeLhVb8%3D '401': description: Unauthorized content: @@ -96,44 +92,34 @@ components: properties: odata.metadata: type: string - example: http://datamall2.mytransport.sg/ltaodataservice/$metadata#FaultyTrafficLights + example: http://datamall2.mytransport.sg/ltaodataservice/$metadata#RoadWorks description: url value: type: array items: type: object properties: - AlarmID: + CameraID: type: string - example: GL703034136 - description: Technical alarm ID - NodeID: + example: 1001 + description: A unique ID for this camera + Latitude: type: string - example: 703034136 - description: A unique code to represent each - unique traffic light node - Type: - type: number - example: 13 - description: Type of the technical alarm - • 4 (Blackout) - • 13 (Flashing Yellow) - StartDate: + example: 1.3290499998616139 + description: Latitude map coordinates + Longitude: type: string - example: 2014-04-12 01:58:00.0 - description: YYYY-MM-DD HH:MM:SS.ms - EndDate: + example: 103.87474391991731 + description: Longitude map coordinates + ImageLink: type: string - example: 2014-04-13 01:58:00.0 - description: YYYY-MM-DD HH:MM:SS.ms - (empty field if this is not a - scheduled maintenance) - Message: - type: string - example: (23/1)8:58 Flashing Yellow at - Bedok North Interchange/Bedok - North Street 1 Junc - description: Canning Message + example: https://dm-traffic-camera-itsc.s3.amazonaws.com/2021-02-25/15-27/1001_1523_20210225152731_1c29e4.jpg?x-amz-security-token=IQoJb3JpZ2luX2VjEA8aDmFwLXNvdXRoZWFzdC0xIkYwRAIgB9vybH4h7daI43qfBeZMS%2FSX6av1yjSu73Q0kqbTD4ICIDTHpUSoXG7OU3EOtK0z0F6NGxf1c0xQwrULNgEbaiFhKqMDCCgQAhoMMzQwNjQ1MzgxMzA0IgyLggWjvfs4g1sMc4UqgAOZXEmpoGYRlnDs9tu6COLECjNNgalDexWPvFpq1a3A9dDM%2Bp6mRAQxxuja%2Bcob2Ox1fPgE%2Bhf24arud9Xr11cNNybleHqCWnBGsjhOo6JNP2gOraux84cXhEjGarHp4%2FvwXGVFQbmF%2B1J9QQlCa2D4LW%2Ffr8hnBsNGKVMe7k7MoS1QfKePl500wUYvhDJEZqPej54BGt%2BlPGorwFBQ%2B10n8vyiwShBxd%2BHBQFxpbuf72fRS9VAYilkCyp8%2FeohmSVh%2BeJXVWvcS5rGiIKd%2FyTOK7nL91s08EiJ0uhwZNJdbu3XdZPFXPTI%2Ban%2BHSkurfa3%2B05mSo4aP%2FGm5NPxP9xzCphiu65ugpN%2BOYxUwwErT7oTPQjI1ZiUJOXvWGhSA5WpKEzVTNPx3aYDtjB8T7qDky8A%2BjsQyvKQARdxM9buz8H1pej8KDsnHr%2BAgupNy%2F9kNk9kBdxPnj67WaVot9WdIOHcj8knf4SVIZCy%2FMESBMVkXT%2BwRLJ8XJaSFR13sl4wvY3dgQY67AG3IH44KUVXKCnh36UJ5nCpEaT162Y6dleCP2Okragprp%2BhIMQHcb3spNoLRHVcq3Zj%2B53o2s4yF6%2FO6BUe1nSZ31X890J6Wao3yFwhrbyULbRAA8Ni3R%2ForYYK0l3213NtV%2FyaIp9o02EAyG7sWOhvsD7MbofMBI2GS%2FbrmEYHjdSTrMCkZje0zG6Q5L60rWgiRVBn5Sa2ogUYk0c%2F4ecnQ8taiVzEuoQsV5CTB5ou2pQVKP1fbefNyu1B18542VLLqJW8mHZ6eoYf%2FwGK7tqJaJf1sPRr2qZ0YbVtkQCo03ZYm0fetH3mXsCYWQ%3D%3D&AWSAccessKeyId=ASIAU6UAMAS4GTPW2LXI&Expires=1614238351&Signature=6xg03%2FpXKMJDVKyXV7X%2FjeLhVb8%3D + description: • Link for + downloading + this image. + • Link will + expire after + 5 minutes unauthorized: type: object properties: From 289b2f3dbc48301f8c126fe4b217127fb9cdb801 Mon Sep 17 00:00:00 2001 From: rameshsentient <51635015+rameshsentient@users.noreply.github.com> Date: Mon, 1 Mar 2021 10:09:18 +0530 Subject: [PATCH 594/792] Update lta_traffic_images.yaml --- data/lta_traffic_images.yaml | 66 ++++++++++++++++++++++-------------- 1 file changed, 40 insertions(+), 26 deletions(-) diff --git a/data/lta_traffic_images.yaml b/data/lta_traffic_images.yaml index 6d8c33eda..140997419 100644 --- a/data/lta_traffic_images.yaml +++ b/data/lta_traffic_images.yaml @@ -1,9 +1,9 @@ openapi: 3.0.1 info: - title: LTA Traffic Images + title: LTA Faulty Traffic Lights x-subscribelink: lta_traffic_images description: |+ - Returns links to images of live traffic conditions along expressways and Woodlands & Tuas Checkpoints. Updates every 1 to 5 minutes or whenever there are updates. + Returns alerts of traffic lights that are currently faulty, or currently undergoing scheduled maintenance. Updated every 2 minutes or whenever there are updates. version: '0.1.0' servers: - url: 'https://api.sentient.io' @@ -11,7 +11,7 @@ tags: - name: "v0.1.0" description: "Published Date - Feb 28, 2021" paths: - /DaaS/dev/lta/Traffic-Imagesv2: + /DaaS/dev/lta/FaultyTrafficLights: get: tags: - v0.1.0 @@ -23,12 +23,16 @@ paths: schema: $ref: '#/components/schemas/success' example: - odata.metadata: http://datamall2.mytransport.sg/ltaodataservice/$metadata#Traffic-Imagesv2 + odata.metadata: http://datamall2.mytransport.sg/ltaodataservice/$metadata#IncidentSet value: - - CameraID: 1001 - Latitude: 1.3290499998616139 - Longitude: 103.87474391991731 - ImageLink: https://dm-traffic-camera-itsc.s3.amazonaws.com/2021-02-25/15-27/1001_1523_20210225152731_1c29e4.jpg?x-amz-security-token=IQoJb3JpZ2luX2VjEA8aDmFwLXNvdXRoZWFzdC0xIkYwRAIgB9vybH4h7daI43qfBeZMS%2FSX6av1yjSu73Q0kqbTD4ICIDTHpUSoXG7OU3EOtK0z0F6NGxf1c0xQwrULNgEbaiFhKqMDCCgQAhoMMzQwNjQ1MzgxMzA0IgyLggWjvfs4g1sMc4UqgAOZXEmpoGYRlnDs9tu6COLECjNNgalDexWPvFpq1a3A9dDM%2Bp6mRAQxxuja%2Bcob2Ox1fPgE%2Bhf24arud9Xr11cNNybleHqCWnBGsjhOo6JNP2gOraux84cXhEjGarHp4%2FvwXGVFQbmF%2B1J9QQlCa2D4LW%2Ffr8hnBsNGKVMe7k7MoS1QfKePl500wUYvhDJEZqPej54BGt%2BlPGorwFBQ%2B10n8vyiwShBxd%2BHBQFxpbuf72fRS9VAYilkCyp8%2FeohmSVh%2BeJXVWvcS5rGiIKd%2FyTOK7nL91s08EiJ0uhwZNJdbu3XdZPFXPTI%2Ban%2BHSkurfa3%2B05mSo4aP%2FGm5NPxP9xzCphiu65ugpN%2BOYxUwwErT7oTPQjI1ZiUJOXvWGhSA5WpKEzVTNPx3aYDtjB8T7qDky8A%2BjsQyvKQARdxM9buz8H1pej8KDsnHr%2BAgupNy%2F9kNk9kBdxPnj67WaVot9WdIOHcj8knf4SVIZCy%2FMESBMVkXT%2BwRLJ8XJaSFR13sl4wvY3dgQY67AG3IH44KUVXKCnh36UJ5nCpEaT162Y6dleCP2Okragprp%2BhIMQHcb3spNoLRHVcq3Zj%2B53o2s4yF6%2FO6BUe1nSZ31X890J6Wao3yFwhrbyULbRAA8Ni3R%2ForYYK0l3213NtV%2FyaIp9o02EAyG7sWOhvsD7MbofMBI2GS%2FbrmEYHjdSTrMCkZje0zG6Q5L60rWgiRVBn5Sa2ogUYk0c%2F4ecnQ8taiVzEuoQsV5CTB5ou2pQVKP1fbefNyu1B18542VLLqJW8mHZ6eoYf%2FwGK7tqJaJf1sPRr2qZ0YbVtkQCo03ZYm0fetH3mXsCYWQ%3D%3D&AWSAccessKeyId=ASIAU6UAMAS4GTPW2LXI&Expires=1614238351&Signature=6xg03%2FpXKMJDVKyXV7X%2FjeLhVb8%3D + - AlarmID: GL703034136 + NodeID: 703034136 + Type: 13 + StartDate: 2014-04-12 01:58:00.0 + EndDate: 2014-04-13 01:58:00.0 + Message: (23/1)8:58 Flashing Yellow at + Bedok North Interchange/Bedok + North Street 1 Junc '401': description: Unauthorized content: @@ -92,34 +96,44 @@ components: properties: odata.metadata: type: string - example: http://datamall2.mytransport.sg/ltaodataservice/$metadata#RoadWorks + example: http://datamall2.mytransport.sg/ltaodataservice/$metadata#FaultyTrafficLights description: url value: type: array items: type: object properties: - CameraID: + AlarmID: type: string - example: 1001 - description: A unique ID for this camera - Latitude: + example: GL703034136 + description: Technical alarm ID + NodeID: type: string - example: 1.3290499998616139 - description: Latitude map coordinates - Longitude: + example: 703034136 + description: A unique code to represent each + unique traffic light node + Type: + type: number + example: 13 + description: Type of the technical alarm + • 4 (Blackout) + • 13 (Flashing Yellow) + StartDate: type: string - example: 103.87474391991731 - description: Longitude map coordinates - ImageLink: + example: 2014-04-12 01:58:00.0 + description: YYYY-MM-DD HH:MM:SS.ms + EndDate: type: string - example: https://dm-traffic-camera-itsc.s3.amazonaws.com/2021-02-25/15-27/1001_1523_20210225152731_1c29e4.jpg?x-amz-security-token=IQoJb3JpZ2luX2VjEA8aDmFwLXNvdXRoZWFzdC0xIkYwRAIgB9vybH4h7daI43qfBeZMS%2FSX6av1yjSu73Q0kqbTD4ICIDTHpUSoXG7OU3EOtK0z0F6NGxf1c0xQwrULNgEbaiFhKqMDCCgQAhoMMzQwNjQ1MzgxMzA0IgyLggWjvfs4g1sMc4UqgAOZXEmpoGYRlnDs9tu6COLECjNNgalDexWPvFpq1a3A9dDM%2Bp6mRAQxxuja%2Bcob2Ox1fPgE%2Bhf24arud9Xr11cNNybleHqCWnBGsjhOo6JNP2gOraux84cXhEjGarHp4%2FvwXGVFQbmF%2B1J9QQlCa2D4LW%2Ffr8hnBsNGKVMe7k7MoS1QfKePl500wUYvhDJEZqPej54BGt%2BlPGorwFBQ%2B10n8vyiwShBxd%2BHBQFxpbuf72fRS9VAYilkCyp8%2FeohmSVh%2BeJXVWvcS5rGiIKd%2FyTOK7nL91s08EiJ0uhwZNJdbu3XdZPFXPTI%2Ban%2BHSkurfa3%2B05mSo4aP%2FGm5NPxP9xzCphiu65ugpN%2BOYxUwwErT7oTPQjI1ZiUJOXvWGhSA5WpKEzVTNPx3aYDtjB8T7qDky8A%2BjsQyvKQARdxM9buz8H1pej8KDsnHr%2BAgupNy%2F9kNk9kBdxPnj67WaVot9WdIOHcj8knf4SVIZCy%2FMESBMVkXT%2BwRLJ8XJaSFR13sl4wvY3dgQY67AG3IH44KUVXKCnh36UJ5nCpEaT162Y6dleCP2Okragprp%2BhIMQHcb3spNoLRHVcq3Zj%2B53o2s4yF6%2FO6BUe1nSZ31X890J6Wao3yFwhrbyULbRAA8Ni3R%2ForYYK0l3213NtV%2FyaIp9o02EAyG7sWOhvsD7MbofMBI2GS%2FbrmEYHjdSTrMCkZje0zG6Q5L60rWgiRVBn5Sa2ogUYk0c%2F4ecnQ8taiVzEuoQsV5CTB5ou2pQVKP1fbefNyu1B18542VLLqJW8mHZ6eoYf%2FwGK7tqJaJf1sPRr2qZ0YbVtkQCo03ZYm0fetH3mXsCYWQ%3D%3D&AWSAccessKeyId=ASIAU6UAMAS4GTPW2LXI&Expires=1614238351&Signature=6xg03%2FpXKMJDVKyXV7X%2FjeLhVb8%3D - description: • Link for - downloading - this image. - • Link will - expire after - 5 minutes + example: 2014-04-13 01:58:00.0 + description: YYYY-MM-DD HH:MM:SS.ms + (empty field if this is not a + scheduled maintenance) + Message: + type: string + example: (23/1)8:58 Flashing Yellow at + Bedok North Interchange/Bedok + North Street 1 Junc + description: Canning Message unauthorized: type: object properties: From e131cd1d16ad9042a5bd23c2eb3169728cdfa851 Mon Sep 17 00:00:00 2001 From: rameshsentient <51635015+rameshsentient@users.noreply.github.com> Date: Mon, 1 Mar 2021 10:10:39 +0530 Subject: [PATCH 595/792] Update lta_traffic_images.yaml --- data/lta_traffic_images.yaml | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/data/lta_traffic_images.yaml b/data/lta_traffic_images.yaml index 140997419..ba34333bb 100644 --- a/data/lta_traffic_images.yaml +++ b/data/lta_traffic_images.yaml @@ -1,9 +1,9 @@ openapi: 3.0.1 info: - title: LTA Faulty Traffic Lights + title: LTA Traffic Images x-subscribelink: lta_traffic_images description: |+ - Returns alerts of traffic lights that are currently faulty, or currently undergoing scheduled maintenance. Updated every 2 minutes or whenever there are updates. + Returns links to images of live traffic conditions along expressways and Woodlands & Tuas Checkpoints. Updates every 1 to 5 minutes or whenever there are updates. version: '0.1.0' servers: - url: 'https://api.sentient.io' @@ -11,7 +11,7 @@ tags: - name: "v0.1.0" description: "Published Date - Feb 28, 2021" paths: - /DaaS/dev/lta/FaultyTrafficLights: + /DaaS/dev/lta/Traffic-Imagesv2: get: tags: - v0.1.0 From 83c49229ec8e4a23dbd515da25893a355433fa8c Mon Sep 17 00:00:00 2001 From: rameshsentient <51635015+rameshsentient@users.noreply.github.com> Date: Mon, 1 Mar 2021 10:17:43 +0530 Subject: [PATCH 596/792] Update lta_traffic_images.yaml --- data/lta_traffic_images.yaml | 16 ++++++---------- 1 file changed, 6 insertions(+), 10 deletions(-) diff --git a/data/lta_traffic_images.yaml b/data/lta_traffic_images.yaml index ba34333bb..ca2e706c8 100644 --- a/data/lta_traffic_images.yaml +++ b/data/lta_traffic_images.yaml @@ -22,17 +22,13 @@ paths: application/json: schema: $ref: '#/components/schemas/success' - example: - odata.metadata: http://datamall2.mytransport.sg/ltaodataservice/$metadata#IncidentSet + example: + odata.metadata: http://datamall2.mytransport.sg/ltaodataservice/$metadata#Traffic-Imagesv2 value: - - AlarmID: GL703034136 - NodeID: 703034136 - Type: 13 - StartDate: 2014-04-12 01:58:00.0 - EndDate: 2014-04-13 01:58:00.0 - Message: (23/1)8:58 Flashing Yellow at - Bedok North Interchange/Bedok - North Street 1 Junc + - CameraID: 1001 + Latitude: 1.3290499998616139 + Longitude: 103.87474391991731 + ImageLink: https://dm-traffic-camera-itsc.s3.amazonaws.com/2021-02-25/15-27/1001_1523_20210225152731_1c29e4.jpg?x-amz-security-token=IQoJb3JpZ2luX2VjEA8aDmFwLXNvdXRoZWFzdC0xIkYwRAIgB9vybH4h7daI43qfBeZMS%2FSX6av1yjSu73Q0kqbTD4ICIDTHpUSoXG7OU3EOtK0z0F6NGxf1c0xQwrULNgEbaiFhKqMDCCgQAhoMMzQwNjQ1MzgxMzA0IgyLggWjvfs4g1sMc4UqgAOZXEmpoGYRlnDs9tu6COLECjNNgalDexWPvFpq1a3A9dDM%2Bp6mRAQxxuja%2Bcob2Ox1fPgE%2Bhf24arud9Xr11cNNybleHqCWnBGsjhOo6JNP2gOraux84cXhEjGarHp4%2FvwXGVFQbmF%2B1J9QQlCa2D4LW%2Ffr8hnBsNGKVMe7k7MoS1QfKePl500wUYvhDJEZqPej54BGt%2BlPGorwFBQ%2B10n8vyiwShBxd%2BHBQFxpbuf72fRS9VAYilkCyp8%2FeohmSVh%2BeJXVWvcS5rGiIKd%2FyTOK7nL91s08EiJ0uhwZNJdbu3XdZPFXPTI%2Ban%2BHSkurfa3%2B05mSo4aP%2FGm5NPxP9xzCphiu65ugpN%2BOYxUwwErT7oTPQjI1ZiUJOXvWGhSA5WpKEzVTNPx3aYDtjB8T7qDky8A%2BjsQyvKQARdxM9buz8H1pej8KDsnHr%2BAgupNy%2F9kNk9kBdxPnj67WaVot9WdIOHcj8knf4SVIZCy%2FMESBMVkXT%2BwRLJ8XJaSFR13sl4wvY3dgQY67AG3IH44KUVXKCnh36UJ5nCpEaT162Y6dleCP2Okragprp%2BhIMQHcb3spNoLRHVcq3Zj%2B53o2s4yF6%2FO6BUe1nSZ31X890J6Wao3yFwhrbyULbRAA8Ni3R%2ForYYK0l3213NtV%2FyaIp9o02EAyG7sWOhvsD7MbofMBI2GS%2FbrmEYHjdSTrMCkZje0zG6Q5L60rWgiRVBn5Sa2ogUYk0c%2F4ecnQ8taiVzEuoQsV5CTB5ou2pQVKP1fbefNyu1B18542VLLqJW8mHZ6eoYf%2FwGK7tqJaJf1sPRr2qZ0YbVtkQCo03ZYm0fetH3mXsCYWQ%3D%3D&AWSAccessKeyId=ASIAU6UAMAS4GTPW2LXI&Expires=1614238351&Signature=6xg03%2FpXKMJDVKyXV7X%2FjeLhVb8%3D '401': description: Unauthorized content: From ddb49142ae9f6137d8c8e2e929da92767b2de781 Mon Sep 17 00:00:00 2001 From: rameshsentient <51635015+rameshsentient@users.noreply.github.com> Date: Mon, 1 Mar 2021 10:21:31 +0530 Subject: [PATCH 597/792] Update lta_traffic_images.yaml --- data/lta_traffic_images.yaml | 46 ++++++++++++++---------------------- 1 file changed, 18 insertions(+), 28 deletions(-) diff --git a/data/lta_traffic_images.yaml b/data/lta_traffic_images.yaml index ca2e706c8..427bb100f 100644 --- a/data/lta_traffic_images.yaml +++ b/data/lta_traffic_images.yaml @@ -92,44 +92,34 @@ components: properties: odata.metadata: type: string - example: http://datamall2.mytransport.sg/ltaodataservice/$metadata#FaultyTrafficLights + example: http://datamall2.mytransport.sg/ltaodataservice/$metadata#RoadWorks description: url value: type: array items: type: object properties: - AlarmID: + CameraID: type: string - example: GL703034136 - description: Technical alarm ID - NodeID: + example: 1001 + description: A unique ID for this camera + Latitude: type: string - example: 703034136 - description: A unique code to represent each - unique traffic light node - Type: - type: number - example: 13 - description: Type of the technical alarm - • 4 (Blackout) - • 13 (Flashing Yellow) - StartDate: + example: 1.3290499998616139 + description: Latitude map coordinates + Longitude: type: string - example: 2014-04-12 01:58:00.0 - description: YYYY-MM-DD HH:MM:SS.ms - EndDate: + example: 103.87474391991731 + description: Longitude map coordinates + ImageLink: type: string - example: 2014-04-13 01:58:00.0 - description: YYYY-MM-DD HH:MM:SS.ms - (empty field if this is not a - scheduled maintenance) - Message: - type: string - example: (23/1)8:58 Flashing Yellow at - Bedok North Interchange/Bedok - North Street 1 Junc - description: Canning Message + example: https://dm-traffic-camera-itsc.s3.amazonaws.com/2021-02-25/15-27/1001_1523_20210225152731_1c29e4.jpg?x-amz-security-token=IQoJb3JpZ2luX2VjEA8aDmFwLXNvdXRoZWFzdC0xIkYwRAIgB9vybH4h7daI43qfBeZMS%2FSX6av1yjSu73Q0kqbTD4ICIDTHpUSoXG7OU3EOtK0z0F6NGxf1c0xQwrULNgEbaiFhKqMDCCgQAhoMMzQwNjQ1MzgxMzA0IgyLggWjvfs4g1sMc4UqgAOZXEmpoGYRlnDs9tu6COLECjNNgalDexWPvFpq1a3A9dDM%2Bp6mRAQxxuja%2Bcob2Ox1fPgE%2Bhf24arud9Xr11cNNybleHqCWnBGsjhOo6JNP2gOraux84cXhEjGarHp4%2FvwXGVFQbmF%2B1J9QQlCa2D4LW%2Ffr8hnBsNGKVMe7k7MoS1QfKePl500wUYvhDJEZqPej54BGt%2BlPGorwFBQ%2B10n8vyiwShBxd%2BHBQFxpbuf72fRS9VAYilkCyp8%2FeohmSVh%2BeJXVWvcS5rGiIKd%2FyTOK7nL91s08EiJ0uhwZNJdbu3XdZPFXPTI%2Ban%2BHSkurfa3%2B05mSo4aP%2FGm5NPxP9xzCphiu65ugpN%2BOYxUwwErT7oTPQjI1ZiUJOXvWGhSA5WpKEzVTNPx3aYDtjB8T7qDky8A%2BjsQyvKQARdxM9buz8H1pej8KDsnHr%2BAgupNy%2F9kNk9kBdxPnj67WaVot9WdIOHcj8knf4SVIZCy%2FMESBMVkXT%2BwRLJ8XJaSFR13sl4wvY3dgQY67AG3IH44KUVXKCnh36UJ5nCpEaT162Y6dleCP2Okragprp%2BhIMQHcb3spNoLRHVcq3Zj%2B53o2s4yF6%2FO6BUe1nSZ31X890J6Wao3yFwhrbyULbRAA8Ni3R%2ForYYK0l3213NtV%2FyaIp9o02EAyG7sWOhvsD7MbofMBI2GS%2FbrmEYHjdSTrMCkZje0zG6Q5L60rWgiRVBn5Sa2ogUYk0c%2F4ecnQ8taiVzEuoQsV5CTB5ou2pQVKP1fbefNyu1B18542VLLqJW8mHZ6eoYf%2FwGK7tqJaJf1sPRr2qZ0YbVtkQCo03ZYm0fetH3mXsCYWQ%3D%3D&AWSAccessKeyId=ASIAU6UAMAS4GTPW2LXI&Expires=1614238351&Signature=6xg03%2FpXKMJDVKyXV7X%2FjeLhVb8%3D + description: • Link for + downloading + this image. + • Link will + expire after + 5 minutes unauthorized: type: object properties: From 3df89d8dfaef39d189f967463adf89aea538a86d Mon Sep 17 00:00:00 2001 From: rameshsentient <51635015+rameshsentient@users.noreply.github.com> Date: Mon, 1 Mar 2021 10:26:19 +0530 Subject: [PATCH 598/792] Update lta_traffic_images.yaml --- data/lta_traffic_images.yaml | 46 ++++++++++++++++++++++-------------- 1 file changed, 28 insertions(+), 18 deletions(-) diff --git a/data/lta_traffic_images.yaml b/data/lta_traffic_images.yaml index 427bb100f..d9782f51d 100644 --- a/data/lta_traffic_images.yaml +++ b/data/lta_traffic_images.yaml @@ -92,34 +92,44 @@ components: properties: odata.metadata: type: string - example: http://datamall2.mytransport.sg/ltaodataservice/$metadata#RoadWorks + example: http://datamall2.mytransport.sg/ltaodataservice/$metadata#FaultyTrafficLights description: url value: type: array items: type: object properties: - CameraID: + AlarmID: type: string - example: 1001 - description: A unique ID for this camera - Latitude: + example: GL703034136 + description: Technical alarm ID + NodeID: type: string - example: 1.3290499998616139 - description: Latitude map coordinates - Longitude: + example: 703034136 + description: A unique code to represent each + unique traffic light node + Type: + type: number + example: 13 + description: Type of the technical alarm + • 4 (Blackout) + • 13 (Flashing Yellow) + StartDate: type: string - example: 103.87474391991731 - description: Longitude map coordinates - ImageLink: + example: 2014-04-12 01:58:00.0 + description: YYYY-MM-DD HH:MM:SS.ms + EndDate: type: string - example: https://dm-traffic-camera-itsc.s3.amazonaws.com/2021-02-25/15-27/1001_1523_20210225152731_1c29e4.jpg?x-amz-security-token=IQoJb3JpZ2luX2VjEA8aDmFwLXNvdXRoZWFzdC0xIkYwRAIgB9vybH4h7daI43qfBeZMS%2FSX6av1yjSu73Q0kqbTD4ICIDTHpUSoXG7OU3EOtK0z0F6NGxf1c0xQwrULNgEbaiFhKqMDCCgQAhoMMzQwNjQ1MzgxMzA0IgyLggWjvfs4g1sMc4UqgAOZXEmpoGYRlnDs9tu6COLECjNNgalDexWPvFpq1a3A9dDM%2Bp6mRAQxxuja%2Bcob2Ox1fPgE%2Bhf24arud9Xr11cNNybleHqCWnBGsjhOo6JNP2gOraux84cXhEjGarHp4%2FvwXGVFQbmF%2B1J9QQlCa2D4LW%2Ffr8hnBsNGKVMe7k7MoS1QfKePl500wUYvhDJEZqPej54BGt%2BlPGorwFBQ%2B10n8vyiwShBxd%2BHBQFxpbuf72fRS9VAYilkCyp8%2FeohmSVh%2BeJXVWvcS5rGiIKd%2FyTOK7nL91s08EiJ0uhwZNJdbu3XdZPFXPTI%2Ban%2BHSkurfa3%2B05mSo4aP%2FGm5NPxP9xzCphiu65ugpN%2BOYxUwwErT7oTPQjI1ZiUJOXvWGhSA5WpKEzVTNPx3aYDtjB8T7qDky8A%2BjsQyvKQARdxM9buz8H1pej8KDsnHr%2BAgupNy%2F9kNk9kBdxPnj67WaVot9WdIOHcj8knf4SVIZCy%2FMESBMVkXT%2BwRLJ8XJaSFR13sl4wvY3dgQY67AG3IH44KUVXKCnh36UJ5nCpEaT162Y6dleCP2Okragprp%2BhIMQHcb3spNoLRHVcq3Zj%2B53o2s4yF6%2FO6BUe1nSZ31X890J6Wao3yFwhrbyULbRAA8Ni3R%2ForYYK0l3213NtV%2FyaIp9o02EAyG7sWOhvsD7MbofMBI2GS%2FbrmEYHjdSTrMCkZje0zG6Q5L60rWgiRVBn5Sa2ogUYk0c%2F4ecnQ8taiVzEuoQsV5CTB5ou2pQVKP1fbefNyu1B18542VLLqJW8mHZ6eoYf%2FwGK7tqJaJf1sPRr2qZ0YbVtkQCo03ZYm0fetH3mXsCYWQ%3D%3D&AWSAccessKeyId=ASIAU6UAMAS4GTPW2LXI&Expires=1614238351&Signature=6xg03%2FpXKMJDVKyXV7X%2FjeLhVb8%3D - description: • Link for - downloading - this image. - • Link will - expire after - 5 minutes + example: 2014-04-13 01:58:00.0 + description: YYYY-MM-DD HH:MM:SS.ms + (empty field if this is not a + scheduled maintenance) + Message: + type: string + example: (23/1)8:58 Flashing Yellow at + Bedok North Interchange/Bedok + North Street 1 Junc + description: Canning Message unauthorized: type: object properties: From fe326c4a6b5a73947d70a7cb1a032e1b921486c8 Mon Sep 17 00:00:00 2001 From: rameshsentient <51635015+rameshsentient@users.noreply.github.com> Date: Mon, 1 Mar 2021 10:30:46 +0530 Subject: [PATCH 599/792] Update lta_traffic_images.yaml --- data/lta_traffic_images.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/data/lta_traffic_images.yaml b/data/lta_traffic_images.yaml index d9782f51d..735543d07 100644 --- a/data/lta_traffic_images.yaml +++ b/data/lta_traffic_images.yaml @@ -129,7 +129,7 @@ components: example: (23/1)8:58 Flashing Yellow at Bedok North Interchange/Bedok North Street 1 Junc - description: Canning Message + description: Canning Message unauthorized: type: object properties: From de73004486d9f9a2e3b25c19fdd187b4275cfbd5 Mon Sep 17 00:00:00 2001 From: rameshsentient <51635015+rameshsentient@users.noreply.github.com> Date: Mon, 1 Mar 2021 10:32:59 +0530 Subject: [PATCH 600/792] Update lta_traffic_images.yaml --- data/lta_traffic_images.yaml | 20 ++++++++++++-------- 1 file changed, 12 insertions(+), 8 deletions(-) diff --git a/data/lta_traffic_images.yaml b/data/lta_traffic_images.yaml index 735543d07..d3070df2e 100644 --- a/data/lta_traffic_images.yaml +++ b/data/lta_traffic_images.yaml @@ -3,7 +3,7 @@ info: title: LTA Traffic Images x-subscribelink: lta_traffic_images description: |+ - Returns links to images of live traffic conditions along expressways and Woodlands & Tuas Checkpoints. Updates every 1 to 5 minutes or whenever there are updates. + Returns alerts of traffic lights that are currently faulty, or currently undergoing scheduled maintenance. Updated every 2 minutes or whenever there are updates. version: '0.1.0' servers: - url: 'https://api.sentient.io' @@ -22,13 +22,17 @@ paths: application/json: schema: $ref: '#/components/schemas/success' - example: - odata.metadata: http://datamall2.mytransport.sg/ltaodataservice/$metadata#Traffic-Imagesv2 + example: + odata.metadata: http://datamall2.mytransport.sg/ltaodataservice/$metadata#IncidentSet value: - - CameraID: 1001 - Latitude: 1.3290499998616139 - Longitude: 103.87474391991731 - ImageLink: https://dm-traffic-camera-itsc.s3.amazonaws.com/2021-02-25/15-27/1001_1523_20210225152731_1c29e4.jpg?x-amz-security-token=IQoJb3JpZ2luX2VjEA8aDmFwLXNvdXRoZWFzdC0xIkYwRAIgB9vybH4h7daI43qfBeZMS%2FSX6av1yjSu73Q0kqbTD4ICIDTHpUSoXG7OU3EOtK0z0F6NGxf1c0xQwrULNgEbaiFhKqMDCCgQAhoMMzQwNjQ1MzgxMzA0IgyLggWjvfs4g1sMc4UqgAOZXEmpoGYRlnDs9tu6COLECjNNgalDexWPvFpq1a3A9dDM%2Bp6mRAQxxuja%2Bcob2Ox1fPgE%2Bhf24arud9Xr11cNNybleHqCWnBGsjhOo6JNP2gOraux84cXhEjGarHp4%2FvwXGVFQbmF%2B1J9QQlCa2D4LW%2Ffr8hnBsNGKVMe7k7MoS1QfKePl500wUYvhDJEZqPej54BGt%2BlPGorwFBQ%2B10n8vyiwShBxd%2BHBQFxpbuf72fRS9VAYilkCyp8%2FeohmSVh%2BeJXVWvcS5rGiIKd%2FyTOK7nL91s08EiJ0uhwZNJdbu3XdZPFXPTI%2Ban%2BHSkurfa3%2B05mSo4aP%2FGm5NPxP9xzCphiu65ugpN%2BOYxUwwErT7oTPQjI1ZiUJOXvWGhSA5WpKEzVTNPx3aYDtjB8T7qDky8A%2BjsQyvKQARdxM9buz8H1pej8KDsnHr%2BAgupNy%2F9kNk9kBdxPnj67WaVot9WdIOHcj8knf4SVIZCy%2FMESBMVkXT%2BwRLJ8XJaSFR13sl4wvY3dgQY67AG3IH44KUVXKCnh36UJ5nCpEaT162Y6dleCP2Okragprp%2BhIMQHcb3spNoLRHVcq3Zj%2B53o2s4yF6%2FO6BUe1nSZ31X890J6Wao3yFwhrbyULbRAA8Ni3R%2ForYYK0l3213NtV%2FyaIp9o02EAyG7sWOhvsD7MbofMBI2GS%2FbrmEYHjdSTrMCkZje0zG6Q5L60rWgiRVBn5Sa2ogUYk0c%2F4ecnQ8taiVzEuoQsV5CTB5ou2pQVKP1fbefNyu1B18542VLLqJW8mHZ6eoYf%2FwGK7tqJaJf1sPRr2qZ0YbVtkQCo03ZYm0fetH3mXsCYWQ%3D%3D&AWSAccessKeyId=ASIAU6UAMAS4GTPW2LXI&Expires=1614238351&Signature=6xg03%2FpXKMJDVKyXV7X%2FjeLhVb8%3D + - AlarmID: GL703034136 + NodeID: 703034136 + Type: 13 + StartDate: 2014-04-12 01:58:00.0 + EndDate: 2014-04-13 01:58:00.0 + Message: (23/1)8:58 Flashing Yellow at + Bedok North Interchange/Bedok + North Street 1 Junc '401': description: Unauthorized content: @@ -129,7 +133,7 @@ components: example: (23/1)8:58 Flashing Yellow at Bedok North Interchange/Bedok North Street 1 Junc - description: Canning Message + description: Canning Message unauthorized: type: object properties: From 2f013994caaa9b8ff654c1ff716e229b96cdab23 Mon Sep 17 00:00:00 2001 From: rameshsentient <51635015+rameshsentient@users.noreply.github.com> Date: Mon, 1 Mar 2021 10:39:39 +0530 Subject: [PATCH 601/792] Update lta_traffic_images.yaml --- data/lta_traffic_images.yaml | 16 ++++++---------- 1 file changed, 6 insertions(+), 10 deletions(-) diff --git a/data/lta_traffic_images.yaml b/data/lta_traffic_images.yaml index d3070df2e..5bf245e12 100644 --- a/data/lta_traffic_images.yaml +++ b/data/lta_traffic_images.yaml @@ -3,7 +3,7 @@ info: title: LTA Traffic Images x-subscribelink: lta_traffic_images description: |+ - Returns alerts of traffic lights that are currently faulty, or currently undergoing scheduled maintenance. Updated every 2 minutes or whenever there are updates. + Returns links to images of live traffic conditions along expressways and Woodlands & Tuas Checkpoints. Updates every 1 to 5 minutes or whenever there are updates. version: '0.1.0' servers: - url: 'https://api.sentient.io' @@ -23,16 +23,12 @@ paths: schema: $ref: '#/components/schemas/success' example: - odata.metadata: http://datamall2.mytransport.sg/ltaodataservice/$metadata#IncidentSet + odata.metadata: http://datamall2.mytransport.sg/ltaodataservice/$metadata#Traffic-Imagesv2 value: - - AlarmID: GL703034136 - NodeID: 703034136 - Type: 13 - StartDate: 2014-04-12 01:58:00.0 - EndDate: 2014-04-13 01:58:00.0 - Message: (23/1)8:58 Flashing Yellow at - Bedok North Interchange/Bedok - North Street 1 Junc + - CameraID: 1001 + Latitude: 1.3290499998616139 + Longitude: 103.87474391991731 + ImageLink: https://dm-traffic-camera-itsc.s3.amazonaws.com/2021-02-25/15-27/1001_1523_20210225152731_1c29e4.jpg?x-amz-security-token=IQoJb3JpZ2luX2VjEA8aDmFwLXNvdXRoZWFzdC0xIkYwRAIgB9vybH4h7daI43qfBeZMS%2FSX6av1yjSu73Q0kqbTD4ICIDTHpUSoXG7OU3EOtK0z0F6NGxf1c0xQwrULNgEbaiFhKqMDCCgQAhoMMzQwNjQ1MzgxMzA0IgyLggWjvfs4g1sMc4UqgAOZXEmpoGYRlnDs9tu6COLECjNNgalDexWPvFpq1a3A9dDM%2Bp6mRAQxxuja%2Bcob2Ox1fPgE%2Bhf24arud9Xr11cNNybleHqCWnBGsjhOo6JNP2gOraux84cXhEjGarHp4%2FvwXGVFQbmF%2B1J9QQlCa2D4LW%2Ffr8hnBsNGKVMe7k7MoS1QfKePl500wUYvhDJEZqPej54BGt%2BlPGorwFBQ%2B10n8vyiwShBxd%2BHBQFxpbuf72fRS9VAYilkCyp8%2FeohmSVh%2BeJXVWvcS5rGiIKd%2FyTOK7nL91s08EiJ0uhwZNJdbu3XdZPFXPTI%2Ban%2BHSkurfa3%2B05mSo4aP%2FGm5NPxP9xzCphiu65ugpN%2BOYxUwwErT7oTPQjI1ZiUJOXvWGhSA5WpKEzVTNPx3aYDtjB8T7qDky8A%2BjsQyvKQARdxM9buz8H1pej8KDsnHr%2BAgupNy%2F9kNk9kBdxPnj67WaVot9WdIOHcj8knf4SVIZCy%2FMESBMVkXT%2BwRLJ8XJaSFR13sl4wvY3dgQY67AG3IH44KUVXKCnh36UJ5nCpEaT162Y6dleCP2Okragprp%2BhIMQHcb3spNoLRHVcq3Zj%2B53o2s4yF6%2FO6BUe1nSZ31X890J6Wao3yFwhrbyULbRAA8Ni3R%2ForYYK0l3213NtV%2FyaIp9o02EAyG7sWOhvsD7MbofMBI2GS%2FbrmEYHjdSTrMCkZje0zG6Q5L60rWgiRVBn5Sa2ogUYk0c%2F4ecnQ8taiVzEuoQsV5CTB5ou2pQVKP1fbefNyu1B18542VLLqJW8mHZ6eoYf%2FwGK7tqJaJf1sPRr2qZ0YbVtkQCo03ZYm0fetH3mXsCYWQ%3D%3D&AWSAccessKeyId=ASIAU6UAMAS4GTPW2LXI&Expires=1614238351&Signature=6xg03%2FpXKMJDVKyXV7X%2FjeLhVb8%3D '401': description: Unauthorized content: From baede8a556229dd57319c64ecadddf7619f7b3ad Mon Sep 17 00:00:00 2001 From: rameshsentient <51635015+rameshsentient@users.noreply.github.com> Date: Mon, 1 Mar 2021 10:42:26 +0530 Subject: [PATCH 602/792] Update lta_traffic_images.yaml --- data/lta_traffic_images.yaml | 46 ++++++++++++++---------------------- 1 file changed, 18 insertions(+), 28 deletions(-) diff --git a/data/lta_traffic_images.yaml b/data/lta_traffic_images.yaml index 5bf245e12..4703969ec 100644 --- a/data/lta_traffic_images.yaml +++ b/data/lta_traffic_images.yaml @@ -92,44 +92,34 @@ components: properties: odata.metadata: type: string - example: http://datamall2.mytransport.sg/ltaodataservice/$metadata#FaultyTrafficLights + example: http://datamall2.mytransport.sg/ltaodataservice/$metadata#Traffic-Imagesv2 description: url value: type: array items: type: object properties: - AlarmID: + CameraID: type: string - example: GL703034136 - description: Technical alarm ID - NodeID: + example: 1001 + description: A unique ID for this camera + Latitude: type: string - example: 703034136 - description: A unique code to represent each - unique traffic light node - Type: - type: number - example: 13 - description: Type of the technical alarm - • 4 (Blackout) - • 13 (Flashing Yellow) - StartDate: + example: 1.3290499998616139 + description: Latitude map coordinates + Longitude: type: string - example: 2014-04-12 01:58:00.0 - description: YYYY-MM-DD HH:MM:SS.ms - EndDate: + example: 103.87474391991731 + description: Longitude map coordinates + ImageLink: type: string - example: 2014-04-13 01:58:00.0 - description: YYYY-MM-DD HH:MM:SS.ms - (empty field if this is not a - scheduled maintenance) - Message: - type: string - example: (23/1)8:58 Flashing Yellow at - Bedok North Interchange/Bedok - North Street 1 Junc - description: Canning Message + example: https://dm-traffic-camera-itsc.s3.amazonaws.com/2021-02-25/15-27/1001_1523_20210225152731_1c29e4.jpg?x-amz-security-token=IQoJb3JpZ2luX2VjEA8aDmFwLXNvdXRoZWFzdC0xIkYwRAIgB9vybH4h7daI43qfBeZMS%2FSX6av1yjSu73Q0kqbTD4ICIDTHpUSoXG7OU3EOtK0z0F6NGxf1c0xQwrULNgEbaiFhKqMDCCgQAhoMMzQwNjQ1MzgxMzA0IgyLggWjvfs4g1sMc4UqgAOZXEmpoGYRlnDs9tu6COLECjNNgalDexWPvFpq1a3A9dDM%2Bp6mRAQxxuja%2Bcob2Ox1fPgE%2Bhf24arud9Xr11cNNybleHqCWnBGsjhOo6JNP2gOraux84cXhEjGarHp4%2FvwXGVFQbmF%2B1J9QQlCa2D4LW%2Ffr8hnBsNGKVMe7k7MoS1QfKePl500wUYvhDJEZqPej54BGt%2BlPGorwFBQ%2B10n8vyiwShBxd%2BHBQFxpbuf72fRS9VAYilkCyp8%2FeohmSVh%2BeJXVWvcS5rGiIKd%2FyTOK7nL91s08EiJ0uhwZNJdbu3XdZPFXPTI%2Ban%2BHSkurfa3%2B05mSo4aP%2FGm5NPxP9xzCphiu65ugpN%2BOYxUwwErT7oTPQjI1ZiUJOXvWGhSA5WpKEzVTNPx3aYDtjB8T7qDky8A%2BjsQyvKQARdxM9buz8H1pej8KDsnHr%2BAgupNy%2F9kNk9kBdxPnj67WaVot9WdIOHcj8knf4SVIZCy%2FMESBMVkXT%2BwRLJ8XJaSFR13sl4wvY3dgQY67AG3IH44KUVXKCnh36UJ5nCpEaT162Y6dleCP2Okragprp%2BhIMQHcb3spNoLRHVcq3Zj%2B53o2s4yF6%2FO6BUe1nSZ31X890J6Wao3yFwhrbyULbRAA8Ni3R%2ForYYK0l3213NtV%2FyaIp9o02EAyG7sWOhvsD7MbofMBI2GS%2FbrmEYHjdSTrMCkZje0zG6Q5L60rWgiRVBn5Sa2ogUYk0c%2F4ecnQ8taiVzEuoQsV5CTB5ou2pQVKP1fbefNyu1B18542VLLqJW8mHZ6eoYf%2FwGK7tqJaJf1sPRr2qZ0YbVtkQCo03ZYm0fetH3mXsCYWQ%3D%3D&AWSAccessKeyId=ASIAU6UAMAS4GTPW2LXI&Expires=1614238351&Signature=6xg03%2FpXKMJDVKyXV7X%2FjeLhVb8%3D + description: • Link for + downloading + this image. + • Link will + expire after + 5 minutes unauthorized: type: object properties: From 574ad5e523ab8f0100e28a37f21abb695a439f00 Mon Sep 17 00:00:00 2001 From: rameshsentient <51635015+rameshsentient@users.noreply.github.com> Date: Mon, 1 Mar 2021 10:45:00 +0530 Subject: [PATCH 603/792] Update lta_traffic_images.yaml --- data/lta_traffic_images.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/data/lta_traffic_images.yaml b/data/lta_traffic_images.yaml index 4703969ec..c6921bac4 100644 --- a/data/lta_traffic_images.yaml +++ b/data/lta_traffic_images.yaml @@ -113,7 +113,7 @@ components: description: Longitude map coordinates ImageLink: type: string - example: https://dm-traffic-camera-itsc.s3.amazonaws.com/2021-02-25/15-27/1001_1523_20210225152731_1c29e4.jpg?x-amz-security-token=IQoJb3JpZ2luX2VjEA8aDmFwLXNvdXRoZWFzdC0xIkYwRAIgB9vybH4h7daI43qfBeZMS%2FSX6av1yjSu73Q0kqbTD4ICIDTHpUSoXG7OU3EOtK0z0F6NGxf1c0xQwrULNgEbaiFhKqMDCCgQAhoMMzQwNjQ1MzgxMzA0IgyLggWjvfs4g1sMc4UqgAOZXEmpoGYRlnDs9tu6COLECjNNgalDexWPvFpq1a3A9dDM%2Bp6mRAQxxuja%2Bcob2Ox1fPgE%2Bhf24arud9Xr11cNNybleHqCWnBGsjhOo6JNP2gOraux84cXhEjGarHp4%2FvwXGVFQbmF%2B1J9QQlCa2D4LW%2Ffr8hnBsNGKVMe7k7MoS1QfKePl500wUYvhDJEZqPej54BGt%2BlPGorwFBQ%2B10n8vyiwShBxd%2BHBQFxpbuf72fRS9VAYilkCyp8%2FeohmSVh%2BeJXVWvcS5rGiIKd%2FyTOK7nL91s08EiJ0uhwZNJdbu3XdZPFXPTI%2Ban%2BHSkurfa3%2B05mSo4aP%2FGm5NPxP9xzCphiu65ugpN%2BOYxUwwErT7oTPQjI1ZiUJOXvWGhSA5WpKEzVTNPx3aYDtjB8T7qDky8A%2BjsQyvKQARdxM9buz8H1pej8KDsnHr%2BAgupNy%2F9kNk9kBdxPnj67WaVot9WdIOHcj8knf4SVIZCy%2FMESBMVkXT%2BwRLJ8XJaSFR13sl4wvY3dgQY67AG3IH44KUVXKCnh36UJ5nCpEaT162Y6dleCP2Okragprp%2BhIMQHcb3spNoLRHVcq3Zj%2B53o2s4yF6%2FO6BUe1nSZ31X890J6Wao3yFwhrbyULbRAA8Ni3R%2ForYYK0l3213NtV%2FyaIp9o02EAyG7sWOhvsD7MbofMBI2GS%2FbrmEYHjdSTrMCkZje0zG6Q5L60rWgiRVBn5Sa2ogUYk0c%2F4ecnQ8taiVzEuoQsV5CTB5ou2pQVKP1fbefNyu1B18542VLLqJW8mHZ6eoYf%2FwGK7tqJaJf1sPRr2qZ0YbVtkQCo03ZYm0fetH3mXsCYWQ%3D%3D&AWSAccessKeyId=ASIAU6UAMAS4GTPW2LXI&Expires=1614238351&Signature=6xg03%2FpXKMJDVKyXV7X%2FjeLhVb8%3D + example: > description: • Link for downloading this image. From fa1266de7e6bd42be76f231f0f8ba8c579fcf2cd Mon Sep 17 00:00:00 2001 From: rameshsentient <51635015+rameshsentient@users.noreply.github.com> Date: Mon, 1 Mar 2021 10:45:33 +0530 Subject: [PATCH 604/792] Update lta_traffic_images.yaml --- data/lta_traffic_images.yaml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/data/lta_traffic_images.yaml b/data/lta_traffic_images.yaml index c6921bac4..5d6682150 100644 --- a/data/lta_traffic_images.yaml +++ b/data/lta_traffic_images.yaml @@ -28,7 +28,7 @@ paths: - CameraID: 1001 Latitude: 1.3290499998616139 Longitude: 103.87474391991731 - ImageLink: https://dm-traffic-camera-itsc.s3.amazonaws.com/2021-02-25/15-27/1001_1523_20210225152731_1c29e4.jpg?x-amz-security-token=IQoJb3JpZ2luX2VjEA8aDmFwLXNvdXRoZWFzdC0xIkYwRAIgB9vybH4h7daI43qfBeZMS%2FSX6av1yjSu73Q0kqbTD4ICIDTHpUSoXG7OU3EOtK0z0F6NGxf1c0xQwrULNgEbaiFhKqMDCCgQAhoMMzQwNjQ1MzgxMzA0IgyLggWjvfs4g1sMc4UqgAOZXEmpoGYRlnDs9tu6COLECjNNgalDexWPvFpq1a3A9dDM%2Bp6mRAQxxuja%2Bcob2Ox1fPgE%2Bhf24arud9Xr11cNNybleHqCWnBGsjhOo6JNP2gOraux84cXhEjGarHp4%2FvwXGVFQbmF%2B1J9QQlCa2D4LW%2Ffr8hnBsNGKVMe7k7MoS1QfKePl500wUYvhDJEZqPej54BGt%2BlPGorwFBQ%2B10n8vyiwShBxd%2BHBQFxpbuf72fRS9VAYilkCyp8%2FeohmSVh%2BeJXVWvcS5rGiIKd%2FyTOK7nL91s08EiJ0uhwZNJdbu3XdZPFXPTI%2Ban%2BHSkurfa3%2B05mSo4aP%2FGm5NPxP9xzCphiu65ugpN%2BOYxUwwErT7oTPQjI1ZiUJOXvWGhSA5WpKEzVTNPx3aYDtjB8T7qDky8A%2BjsQyvKQARdxM9buz8H1pej8KDsnHr%2BAgupNy%2F9kNk9kBdxPnj67WaVot9WdIOHcj8knf4SVIZCy%2FMESBMVkXT%2BwRLJ8XJaSFR13sl4wvY3dgQY67AG3IH44KUVXKCnh36UJ5nCpEaT162Y6dleCP2Okragprp%2BhIMQHcb3spNoLRHVcq3Zj%2B53o2s4yF6%2FO6BUe1nSZ31X890J6Wao3yFwhrbyULbRAA8Ni3R%2ForYYK0l3213NtV%2FyaIp9o02EAyG7sWOhvsD7MbofMBI2GS%2FbrmEYHjdSTrMCkZje0zG6Q5L60rWgiRVBn5Sa2ogUYk0c%2F4ecnQ8taiVzEuoQsV5CTB5ou2pQVKP1fbefNyu1B18542VLLqJW8mHZ6eoYf%2FwGK7tqJaJf1sPRr2qZ0YbVtkQCo03ZYm0fetH3mXsCYWQ%3D%3D&AWSAccessKeyId=ASIAU6UAMAS4GTPW2LXI&Expires=1614238351&Signature=6xg03%2FpXKMJDVKyXV7X%2FjeLhVb8%3D + ImageLink: '401': description: Unauthorized content: @@ -113,7 +113,7 @@ components: description: Longitude map coordinates ImageLink: type: string - example: > + example: description: • Link for downloading this image. From d6e02d43ddcb3210ab7ac7a1450b69b1d9965e52 Mon Sep 17 00:00:00 2001 From: rameshsentient <51635015+rameshsentient@users.noreply.github.com> Date: Mon, 1 Mar 2021 11:19:38 +0530 Subject: [PATCH 605/792] Update lta_traffic_images.yaml --- data/lta_traffic_images.yaml | 60 ++++++++++++++++++++++-------------- 1 file changed, 37 insertions(+), 23 deletions(-) diff --git a/data/lta_traffic_images.yaml b/data/lta_traffic_images.yaml index 5d6682150..99059a42b 100644 --- a/data/lta_traffic_images.yaml +++ b/data/lta_traffic_images.yaml @@ -23,12 +23,16 @@ paths: schema: $ref: '#/components/schemas/success' example: - odata.metadata: http://datamall2.mytransport.sg/ltaodataservice/$metadata#Traffic-Imagesv2 + odata.metadata: http://datamall2.mytransport.sg/ltaodataservice/$metadata#IncidentSet value: - - CameraID: 1001 - Latitude: 1.3290499998616139 - Longitude: 103.87474391991731 - ImageLink: + - AlarmID: GL703034136 + NodeID: 703034136 + Type: 13 + StartDate: 2014-04-12 01:58:00.0 + EndDate: 2014-04-13 01:58:00.0 + Message: (23/1)8:58 Flashing Yellow at + Bedok North Interchange/Bedok + North Street 1 Junc '401': description: Unauthorized content: @@ -92,34 +96,44 @@ components: properties: odata.metadata: type: string - example: http://datamall2.mytransport.sg/ltaodataservice/$metadata#Traffic-Imagesv2 + example: http://datamall2.mytransport.sg/ltaodataservice/$metadata#FaultyTrafficLights description: url value: type: array items: type: object properties: - CameraID: + AlarmID: type: string - example: 1001 - description: A unique ID for this camera - Latitude: + example: GL703034136 + description: Technical alarm ID + NodeID: type: string - example: 1.3290499998616139 - description: Latitude map coordinates - Longitude: + example: 703034136 + description: A unique code to represent each + unique traffic light node + Type: + type: number + example: 13 + description: Type of the technical alarm + • 4 (Blackout) + • 13 (Flashing Yellow) + StartDate: type: string - example: 103.87474391991731 - description: Longitude map coordinates - ImageLink: + example: 2014-04-12 01:58:00.0 + description: YYYY-MM-DD HH:MM:SS.ms + EndDate: type: string - example: - description: • Link for - downloading - this image. - • Link will - expire after - 5 minutes + example: 2014-04-13 01:58:00.0 + description: YYYY-MM-DD HH:MM:SS.ms + (empty field if this is not a + scheduled maintenance) + Message: + type: string + example: (23/1)8:58 Flashing Yellow at + Bedok North Interchange/Bedok + North Street 1 Junc + description: Canning Message unauthorized: type: object properties: From beb5c2c7c66eb46f457f3e977c62fd28e5a43b72 Mon Sep 17 00:00:00 2001 From: rameshsentient <51635015+rameshsentient@users.noreply.github.com> Date: Mon, 1 Mar 2021 11:25:48 +0530 Subject: [PATCH 606/792] Update lta_traffic_images.yaml --- data/lta_traffic_images.yaml | 14 +++++--------- 1 file changed, 5 insertions(+), 9 deletions(-) diff --git a/data/lta_traffic_images.yaml b/data/lta_traffic_images.yaml index 99059a42b..32432c1eb 100644 --- a/data/lta_traffic_images.yaml +++ b/data/lta_traffic_images.yaml @@ -23,16 +23,12 @@ paths: schema: $ref: '#/components/schemas/success' example: - odata.metadata: http://datamall2.mytransport.sg/ltaodataservice/$metadata#IncidentSet + odata.metadata: http://datamall2.mytransport.sg/ltaodataservice/$metadata#Traffic-Imagesv2 value: - - AlarmID: GL703034136 - NodeID: 703034136 - Type: 13 - StartDate: 2014-04-12 01:58:00.0 - EndDate: 2014-04-13 01:58:00.0 - Message: (23/1)8:58 Flashing Yellow at - Bedok North Interchange/Bedok - North Street 1 Junc + - CameraID: 1001 + Latitude: 1.3290499998616139 + Longitude: 103.87474391991731 + ImageLink: https://dm-traffic-camera-itsc.s3.amazonaws.com/2021-02-25/15-27/1001_1523_20210225152731_1c29e4.jpg?x-amz-security-token=IQoJb3JpZ2luX2VjEA8aDmFwLXNvdXRoZWFzdC0xIkYwRAIgB9vybH4h7daI43qfBeZMS%2FSX6av1yjSu73Q0kqbTD4ICIDTHpUSoXG7OU3EOtK0z0F6NGxf1c0xQwrULNgEbaiFhKqMDCCgQAhoMMzQwNjQ1MzgxMzA0IgyLggWjvfs4g1sMc4UqgAOZXEmpoGYRlnDs9tu6COLECjNNgalDexWPvFpq1a3A9dDM%2Bp6mRAQxxuja%2Bcob2Ox1fPgE%2Bhf24arud9Xr11cNNybleHqCWnBGsjhOo6JNP2gOraux84cXhEjGarHp4%2FvwXGVFQbmF%2B1J9QQlCa2D4LW%2Ffr8hnBsNGKVMe7k7MoS1QfKePl500wUYvhDJEZqPej54BGt%2BlPGorwFBQ%2B10n8vyiwShBxd%2BHBQFxpbuf72fRS9VAYilkCyp8%2FeohmSVh%2BeJXVWvcS5rGiIKd%2FyTOK7nL91s08EiJ0uhwZNJdbu3XdZPFXPTI%2Ban%2BHSkurfa3%2B05mSo4aP%2FGm5NPxP9xzCphiu65ugpN%2BOYxUwwErT7oTPQjI1ZiUJOXvWGhSA5WpKEzVTNPx3aYDtjB8T7qDky8A%2BjsQyvKQARdxM9buz8H1pej8KDsnHr%2BAgupNy%2F9kNk9kBdxPnj67WaVot9WdIOHcj8knf4SVIZCy%2FMESBMVkXT%2BwRLJ8XJaSFR13sl4wvY3dgQY67AG3IH44KUVXKCnh36UJ5nCpEaT162Y6dleCP2Okragprp%2BhIMQHcb3spNoLRHVcq3Zj%2B53o2s4yF6%2FO6BUe1nSZ31X890J6Wao3yFwhrbyULbRAA8Ni3R%2ForYYK0l3213NtV%2FyaIp9o02EAyG7sWOhvsD7MbofMBI2GS%2FbrmEYHjdSTrMCkZje0zG6Q5L60rWgiRVBn5Sa2ogUYk0c%2F4ecnQ8taiVzEuoQsV5CTB5ou2pQVKP1fbefNyu1B18542VLLqJW8mHZ6eoYf%2FwGK7tqJaJf1sPRr2qZ0YbVtkQCo03ZYm0fetH3mXsCYWQ%3D%3D&AWSAccessKeyId=ASIAU6UAMAS4GTPW2LXI&Expires=1614238351&Signature=6xg03%2FpXKMJDVKyXV7X%2FjeLhVb8%3D '401': description: Unauthorized content: From 7a494712ca8e9c9235b6c63e6dd8f6d9f036b25e Mon Sep 17 00:00:00 2001 From: rameshsentient <51635015+rameshsentient@users.noreply.github.com> Date: Mon, 1 Mar 2021 11:26:51 +0530 Subject: [PATCH 607/792] Update lta_traffic_images.yaml --- data/lta_traffic_images.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/data/lta_traffic_images.yaml b/data/lta_traffic_images.yaml index 32432c1eb..9ff674f7a 100644 --- a/data/lta_traffic_images.yaml +++ b/data/lta_traffic_images.yaml @@ -92,7 +92,7 @@ components: properties: odata.metadata: type: string - example: http://datamall2.mytransport.sg/ltaodataservice/$metadata#FaultyTrafficLights + example: http://datamall2.mytransport.sg/ltaodataservice/$metadata#Traffic-Imagesv2 description: url value: type: array From e2e161d0f685ad22aaa3a00dd2320cc465cbfefe Mon Sep 17 00:00:00 2001 From: rameshsentient <51635015+rameshsentient@users.noreply.github.com> Date: Mon, 1 Mar 2021 11:33:14 +0530 Subject: [PATCH 608/792] Update lta_traffic_images.yaml --- data/lta_traffic_images.yaml | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/data/lta_traffic_images.yaml b/data/lta_traffic_images.yaml index 9ff674f7a..844d317df 100644 --- a/data/lta_traffic_images.yaml +++ b/data/lta_traffic_images.yaml @@ -99,10 +99,10 @@ components: items: type: object properties: - AlarmID: + CameraID: type: string - example: GL703034136 - description: Technical alarm ID + example: 1001 + description: A unique ID for this camera NodeID: type: string example: 703034136 From 14c54c488ae3a9ae7f87e8b41f3acbea889f4812 Mon Sep 17 00:00:00 2001 From: rameshsentient <51635015+rameshsentient@users.noreply.github.com> Date: Mon, 1 Mar 2021 11:37:07 +0530 Subject: [PATCH 609/792] Update lta_traffic_images.yaml --- data/lta_traffic_images.yaml | 15 ++++++--------- 1 file changed, 6 insertions(+), 9 deletions(-) diff --git a/data/lta_traffic_images.yaml b/data/lta_traffic_images.yaml index 844d317df..dd3d3c865 100644 --- a/data/lta_traffic_images.yaml +++ b/data/lta_traffic_images.yaml @@ -103,17 +103,14 @@ components: type: string example: 1001 description: A unique ID for this camera - NodeID: + Latitude: type: string - example: 703034136 - description: A unique code to represent each - unique traffic light node - Type: + example: 1.3290499998616139 + description: Latitude map coordinates + Longitude: type: number - example: 13 - description: Type of the technical alarm - • 4 (Blackout) - • 13 (Flashing Yellow) + example: 103.87474391991731 + description: Longitude map coordinates StartDate: type: string example: 2014-04-12 01:58:00.0 From 1df9fe66b34c7e751020221c826cc8886e1eb1b1 Mon Sep 17 00:00:00 2001 From: rameshsentient <51635015+rameshsentient@users.noreply.github.com> Date: Mon, 1 Mar 2021 11:43:04 +0530 Subject: [PATCH 610/792] Update lta_traffic_images.yaml --- data/lta_traffic_images.yaml | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/data/lta_traffic_images.yaml b/data/lta_traffic_images.yaml index dd3d3c865..10d9f4218 100644 --- a/data/lta_traffic_images.yaml +++ b/data/lta_traffic_images.yaml @@ -111,10 +111,12 @@ components: type: number example: 103.87474391991731 description: Longitude map coordinates - StartDate: + ImageLink: type: string - example: 2014-04-12 01:58:00.0 - description: YYYY-MM-DD HH:MM:SS.ms + example: 'https://dm-traffic-camera-itsc.s3.amazonaws.com/2021-02-25/15-27/1001_1523_20210225152731_1c29e4.jpg?x-amz-security-token=IQoJb3JpZ2luX2VjEA8aDmFwLXNvdXRoZWFzdC0xIkYwRAIgB9vybH4h7daI43qfBeZMS%2FSX6av1yjSu73Q0kqbTD4ICIDTHpUSoXG7OU3EOtK0z0F6NGxf1c0xQwrULNgEbaiFhKqMDCCgQAhoMMzQwNjQ1MzgxMzA0IgyLggWjvfs4g1sMc4UqgAOZXEmpoGYRlnDs9tu6COLECjNNgalDexWPvFpq1a3A9dDM%2Bp6mRAQxxuja%2Bcob2Ox1fPgE%2Bhf24arud9Xr11cNNybleHqCWnBGsjhOo6JNP2gOraux84cXhEjGarHp4%2FvwXGVFQbmF%2B1J9QQlCa2D4LW%2Ffr8hnBsNGKVMe7k7MoS1QfKePl500wUYvhDJEZqPej54BGt%2BlPGorwFBQ%2B10n8vyiwShBxd%2BHBQFxpbuf72fRS9VAYilkCyp8%2FeohmSVh%2BeJXVWvcS5rGiIKd%2FyTOK7nL91s08EiJ0uhwZNJdbu3XdZPFXPTI%2Ban%2BHSkurfa3%2B05mSo4aP%2FGm5NPxP9xzCphiu65ugpN%2BOYxUwwErT7oTPQjI1ZiUJOXvWGhSA5WpKEzVTNPx3aYDtjB8T7qDky8A%2BjsQyvKQARdxM9buz8H1pej8KDsnHr%2BAgupNy%2F9kNk9kBdxPnj67WaVot9WdIOHcj8knf4SVIZCy%2FMESBMVkXT%2BwRLJ8XJaSFR13sl4wvY3dgQY67AG3IH44KUVXKCnh36UJ5nCpEaT162Y6dleCP2Okragprp%2BhIMQHcb3spNoLRHVcq3Zj%2B53o2s4yF6%2FO6BUe1nSZ31X890J6Wao3yFwhrbyULbRAA8Ni3R%2ForYYK0l3213NtV%2FyaIp9o02EAyG7sWOhvsD7MbofMBI2GS%2FbrmEYHjdSTrMCkZje0zG6Q5L60rWgiRVBn5Sa2ogUYk0c%2F4ecnQ8taiVzEuoQsV5CTB5ou2pQVKP1fbefNyu1B18542VLLqJW8mHZ6eoYf%2FwGK7tqJaJf1sPRr2qZ0YbVtkQCo03ZYm0fetH3mXsCYWQ%3D%3D&AWSAccessKeyId=ASIAU6UAMAS4GTPW2LXI&Expires=1614238351&Signature=6xg03%2FpXKMJDVKyXV7X%2FjeLhVb8%3D' + description: |+ + • Link for downloading this image. + • Link will expire after 5 minutes EndDate: type: string example: 2014-04-13 01:58:00.0 From b92d266f6d2c932dd368b6481b0b8b60ff879250 Mon Sep 17 00:00:00 2001 From: rameshsentient <51635015+rameshsentient@users.noreply.github.com> Date: Mon, 1 Mar 2021 11:47:38 +0530 Subject: [PATCH 611/792] Update lta_traffic_images.yaml --- data/lta_traffic_images.yaml | 14 +------------- 1 file changed, 1 insertion(+), 13 deletions(-) diff --git a/data/lta_traffic_images.yaml b/data/lta_traffic_images.yaml index 10d9f4218..9d9d18f87 100644 --- a/data/lta_traffic_images.yaml +++ b/data/lta_traffic_images.yaml @@ -116,19 +116,7 @@ components: example: 'https://dm-traffic-camera-itsc.s3.amazonaws.com/2021-02-25/15-27/1001_1523_20210225152731_1c29e4.jpg?x-amz-security-token=IQoJb3JpZ2luX2VjEA8aDmFwLXNvdXRoZWFzdC0xIkYwRAIgB9vybH4h7daI43qfBeZMS%2FSX6av1yjSu73Q0kqbTD4ICIDTHpUSoXG7OU3EOtK0z0F6NGxf1c0xQwrULNgEbaiFhKqMDCCgQAhoMMzQwNjQ1MzgxMzA0IgyLggWjvfs4g1sMc4UqgAOZXEmpoGYRlnDs9tu6COLECjNNgalDexWPvFpq1a3A9dDM%2Bp6mRAQxxuja%2Bcob2Ox1fPgE%2Bhf24arud9Xr11cNNybleHqCWnBGsjhOo6JNP2gOraux84cXhEjGarHp4%2FvwXGVFQbmF%2B1J9QQlCa2D4LW%2Ffr8hnBsNGKVMe7k7MoS1QfKePl500wUYvhDJEZqPej54BGt%2BlPGorwFBQ%2B10n8vyiwShBxd%2BHBQFxpbuf72fRS9VAYilkCyp8%2FeohmSVh%2BeJXVWvcS5rGiIKd%2FyTOK7nL91s08EiJ0uhwZNJdbu3XdZPFXPTI%2Ban%2BHSkurfa3%2B05mSo4aP%2FGm5NPxP9xzCphiu65ugpN%2BOYxUwwErT7oTPQjI1ZiUJOXvWGhSA5WpKEzVTNPx3aYDtjB8T7qDky8A%2BjsQyvKQARdxM9buz8H1pej8KDsnHr%2BAgupNy%2F9kNk9kBdxPnj67WaVot9WdIOHcj8knf4SVIZCy%2FMESBMVkXT%2BwRLJ8XJaSFR13sl4wvY3dgQY67AG3IH44KUVXKCnh36UJ5nCpEaT162Y6dleCP2Okragprp%2BhIMQHcb3spNoLRHVcq3Zj%2B53o2s4yF6%2FO6BUe1nSZ31X890J6Wao3yFwhrbyULbRAA8Ni3R%2ForYYK0l3213NtV%2FyaIp9o02EAyG7sWOhvsD7MbofMBI2GS%2FbrmEYHjdSTrMCkZje0zG6Q5L60rWgiRVBn5Sa2ogUYk0c%2F4ecnQ8taiVzEuoQsV5CTB5ou2pQVKP1fbefNyu1B18542VLLqJW8mHZ6eoYf%2FwGK7tqJaJf1sPRr2qZ0YbVtkQCo03ZYm0fetH3mXsCYWQ%3D%3D&AWSAccessKeyId=ASIAU6UAMAS4GTPW2LXI&Expires=1614238351&Signature=6xg03%2FpXKMJDVKyXV7X%2FjeLhVb8%3D' description: |+ • Link for downloading this image. - • Link will expire after 5 minutes - EndDate: - type: string - example: 2014-04-13 01:58:00.0 - description: YYYY-MM-DD HH:MM:SS.ms - (empty field if this is not a - scheduled maintenance) - Message: - type: string - example: (23/1)8:58 Flashing Yellow at - Bedok North Interchange/Bedok - North Street 1 Junc - description: Canning Message + • Link will expire after 5 minutes unauthorized: type: object properties: From d5a3871da31d50da2e180dc094042b5627c4cdf8 Mon Sep 17 00:00:00 2001 From: rameshsentient <51635015+rameshsentient@users.noreply.github.com> Date: Mon, 1 Mar 2021 11:51:43 +0530 Subject: [PATCH 612/792] Update index.yaml --- index.yaml | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/index.yaml b/index.yaml index 25b220a50..2e5f5fe6b 100644 --- a/index.yaml +++ b/index.yaml @@ -291,7 +291,11 @@ data: lta_traffic_images: title: LTA Traffic Images versions: - 0.1.0: 'lta_traffic_images.yaml' + 0.1.0: 'lta_traffic_images.yaml' + lta_traffic_incidents: + title: LTA Traffic Incidents + versions: + 0.1.0: 'lta_traffic_incidents.yaml' realtime_weather: title: Realtime Weather versions: From 5a17dd742b361ed80bf95d302fd7a454517603a1 Mon Sep 17 00:00:00 2001 From: rameshsentient <51635015+rameshsentient@users.noreply.github.com> Date: Mon, 1 Mar 2021 12:00:31 +0530 Subject: [PATCH 613/792] Update lta_traffic_incidents.yaml --- data/lta_traffic_incidents.yaml | 67 ++++++++++++++++++--------------- 1 file changed, 36 insertions(+), 31 deletions(-) diff --git a/data/lta_traffic_incidents.yaml b/data/lta_traffic_incidents.yaml index c1edfeb19..a706982f1 100644 --- a/data/lta_traffic_incidents.yaml +++ b/data/lta_traffic_incidents.yaml @@ -3,7 +3,7 @@ info: title: LTA Traffic Incidents x-subscribelink: lta_traffic_incidents description: |+ - Returns incidents currently happening on the roads, such as Accidents, Vehicle Breakdowns, Road Blocks, Traffic Diversions etc. Updated every 2 minutes or whenever there are updates. + Returns alerts of traffic lights that are currently faulty, or currently undergoing scheduled maintenance. Updated every 2 minutes or whenever there are updates. version: '0.1.0' servers: - url: 'https://api.sentient.io' @@ -25,10 +25,14 @@ paths: example: odata.metadata: http://datamall2.mytransport.sg/ltaodataservice/$metadata#IncidentSet value: - - Type: Roadwork - Latitude: 1.3765155261589948 - Longitude: 103.72976844706339 - Message: "(25/2)13:13 Roadworks on Boon Lay Way (towards City) after Jalan Boon Lay. Avoid right lane." + - AlarmID: GL703034136 + NodeID: 703034136 + Type: 13 + StartDate: 2014-04-12 01:58:00.0 + EndDate: 2014-04-13 01:58:00.0 + Message: (23/1)8:58 Flashing Yellow at + Bedok North Interchange/Bedok + North Street 1 Junc '401': description: Unauthorized content: @@ -92,43 +96,44 @@ components: properties: odata.metadata: type: string - example: http://datamall2.mytransport.sg/ltaodataservice/$metadata#IncidentSet + example: http://datamall2.mytransport.sg/ltaodataservice/$metadata#FaultyTrafficLights description: url value: type: array items: type: object properties: - Type: + AlarmID: + type: string + example: GL703034136 + description: Technical alarm ID + NodeID: type: string - example: Roadwork - description: - Incident Types - - • Accident - • Road Works - • Vehicle Breakdown - • Weather - • Obstacle - • Road Block - • Heavy Traffic - • Misc. - • Diversion - • Unattended Vehicle - Latitude: + example: 703034136 + description: A unique code to represent each + unique traffic light node + Type: + type: number + example: 13 + description: Type of the technical alarm + • 4 (Blackout) + • 13 (Flashing Yellow) + StartDate: type: string - example: 1.3415018509600185 - description: Latitude map coordinates for the - start point of this road incident - Longitude: + example: 2014-04-12 01:58:00.0 + description: YYYY-MM-DD HH:MM:SS.ms + EndDate: type: string - example: 103.71215415465709 - description: Longitude map coordinates for - the start point of this incident + example: 2014-04-13 01:58:00.0 + description: YYYY-MM-DD HH:MM:SS.ms + (empty field if this is not a + scheduled maintenance) Message: type: string - example: (25/2)13:13 Roadworks on Boon Lay Way (towards City) after Jalan Boon Lay. Avoid right lane. - description: Description message for this incident - + example: (23/1)8:58 Flashing Yellow at + Bedok North Interchange/Bedok + North Street 1 Junc + description: Canning Message unauthorized: type: object properties: From c11feda41d74e4ff8c1b0c72eebde41b3d0fe4b0 Mon Sep 17 00:00:00 2001 From: rameshsentient <51635015+rameshsentient@users.noreply.github.com> Date: Mon, 1 Mar 2021 12:12:53 +0530 Subject: [PATCH 614/792] Update lta_traffic_incidents.yaml --- data/lta_traffic_incidents.yaml | 12 ++++-------- 1 file changed, 4 insertions(+), 8 deletions(-) diff --git a/data/lta_traffic_incidents.yaml b/data/lta_traffic_incidents.yaml index a706982f1..f814628ed 100644 --- a/data/lta_traffic_incidents.yaml +++ b/data/lta_traffic_incidents.yaml @@ -25,14 +25,10 @@ paths: example: odata.metadata: http://datamall2.mytransport.sg/ltaodataservice/$metadata#IncidentSet value: - - AlarmID: GL703034136 - NodeID: 703034136 - Type: 13 - StartDate: 2014-04-12 01:58:00.0 - EndDate: 2014-04-13 01:58:00.0 - Message: (23/1)8:58 Flashing Yellow at - Bedok North Interchange/Bedok - North Street 1 Junc + - Type: Roadwork + Latitude: 1.3765155261589948 + Longitude: 103.72976844706339 + Message: "(25/2)13:13 Roadworks on Boon Lay Way (towards City) after Jalan Boon Lay. Avoid right lane." '401': description: Unauthorized content: From a6ecdd095b73008c909d3104d9a6bf77752f48ea Mon Sep 17 00:00:00 2001 From: rameshsentient <51635015+rameshsentient@users.noreply.github.com> Date: Mon, 1 Mar 2021 12:32:13 +0530 Subject: [PATCH 615/792] Update lta_traffic_incidents.yaml --- data/lta_traffic_incidents.yaml | 48 +++++++++++++++------------------ 1 file changed, 22 insertions(+), 26 deletions(-) diff --git a/data/lta_traffic_incidents.yaml b/data/lta_traffic_incidents.yaml index f814628ed..7306c81f3 100644 --- a/data/lta_traffic_incidents.yaml +++ b/data/lta_traffic_incidents.yaml @@ -92,44 +92,40 @@ components: properties: odata.metadata: type: string - example: http://datamall2.mytransport.sg/ltaodataservice/$metadata#FaultyTrafficLights + example: http://datamall2.mytransport.sg/ltaodataservice/$metadata#IncidentSet description: url value: type: array items: type: object properties: - AlarmID: + Type: type: string example: GL703034136 - description: Technical alarm ID - NodeID: - type: string - example: 703034136 - description: A unique code to represent each - unique traffic light node - Type: - type: number - example: 13 - description: Type of the technical alarm - • 4 (Blackout) - • 13 (Flashing Yellow) - StartDate: + description: |+ + Incident Types - + • Accident + • Road Works + • Vehicle Breakdown + • Weather + • Obstacle + • Road Block + • Heavy Traffic + • Misc. + • Diversion + • Unattended Vehicle + Latitude: type: string - example: 2014-04-12 01:58:00.0 - description: YYYY-MM-DD HH:MM:SS.ms - EndDate: + example: 1.3415018509600185 + description: Latitude map coordinates for the start point of this road incident + Longitude: type: string - example: 2014-04-13 01:58:00.0 - description: YYYY-MM-DD HH:MM:SS.ms - (empty field if this is not a - scheduled maintenance) + example: 103.71215415465709 + description: Longitude map coordinates for the start point of this incident Message: type: string - example: (23/1)8:58 Flashing Yellow at - Bedok North Interchange/Bedok - North Street 1 Junc - description: Canning Message + example: (25/2)13:13 Roadworks on Boon Lay Way (towards City) after Jalan Boon Lay. Avoid right lane. + description: Description message for this incident unauthorized: type: object properties: From 6a39adee700737e7b2873397f5b5188c66cd6dea Mon Sep 17 00:00:00 2001 From: rameshsentient <51635015+rameshsentient@users.noreply.github.com> Date: Mon, 1 Mar 2021 12:47:12 +0530 Subject: [PATCH 616/792] Update vms.yaml --- data/vms.yaml | 42 ++++++++++++++++++++++++++++-------------- 1 file changed, 28 insertions(+), 14 deletions(-) diff --git a/data/vms.yaml b/data/vms.yaml index 80fe5d34e..5d4b869a9 100644 --- a/data/vms.yaml +++ b/data/vms.yaml @@ -1,6 +1,7 @@ openapi: 3.0.1 info: title: VMS + x-subscribelink: vms description: |+ Returns traffic advisories (via variable message services) concerning current traffic conditions that are displayed on EMAS signboards @@ -94,31 +95,44 @@ components: properties: odata.metadata: type: string - example: http://datamall2.mytransport.sg/ltaodataservice/$metadata#RoadWorks + example: http://datamall2.mytransport.sg/ltaodataservice/$metadata#FaultyTrafficLights description: url value: type: array items: type: object properties: - EquipmentID: + AlarmID: type: string - example: AVMS_01_00501 - description: EMAS equipment ID - Latitude: + example: GL703034136 + description: Technical alarm ID + NodeID: type: string - example: 1.3290499998616139 - description: Latitude map coordinates of - electronic signboard. - Longitude: + example: 703034136 + description: A unique code to represent each + unique traffic light node + Type: + type: number + example: 13 + description: Type of the technical alarm + • 4 (Blackout) + • 13 (Flashing Yellow) + StartDate: type: string - example: 103.87474391991731 - description: Longitude map coordinates of - electronic signboard. + example: 2014-04-12 01:58:00.0 + description: YYYY-MM-DD HH:MM:SS.ms + EndDate: + type: string + example: 2014-04-13 01:58:00.0 + description: YYYY-MM-DD HH:MM:SS.ms + (empty field if this is not a + scheduled maintenance) Message: type: string - example: ROAD|WORKS ON|BENDEMEER - description: VEH BREAKDOWN SH,AFTU.THOMSON + example: (23/1)8:58 Flashing Yellow at + Bedok North Interchange/Bedok + North Street 1 Junc + description: Canning Message unauthorized: type: object properties: From 9dde4cd3981600c0653cc5425adf790c91b62a1d Mon Sep 17 00:00:00 2001 From: rameshsentient <51635015+rameshsentient@users.noreply.github.com> Date: Mon, 1 Mar 2021 12:48:21 +0530 Subject: [PATCH 617/792] Update index.yaml --- index.yaml | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/index.yaml b/index.yaml index 2e5f5fe6b..30f6fcc55 100644 --- a/index.yaml +++ b/index.yaml @@ -295,7 +295,11 @@ data: lta_traffic_incidents: title: LTA Traffic Incidents versions: - 0.1.0: 'lta_traffic_incidents.yaml' + 0.1.0: 'lta_traffic_incidents.yaml' + vms: + title: VMS + versions: + 0.1.0: 'vms.yaml' realtime_weather: title: Realtime Weather versions: From e9608591bf162545b6193afeacdb7636e37227ff Mon Sep 17 00:00:00 2001 From: rameshsentient <51635015+rameshsentient@users.noreply.github.com> Date: Mon, 1 Mar 2021 13:01:48 +0530 Subject: [PATCH 618/792] Update vms.yaml --- data/vms.yaml | 37 +++++++++++-------------------------- 1 file changed, 11 insertions(+), 26 deletions(-) diff --git a/data/vms.yaml b/data/vms.yaml index 5d4b869a9..0961a65c1 100644 --- a/data/vms.yaml +++ b/data/vms.yaml @@ -102,37 +102,22 @@ components: items: type: object properties: - AlarmID: + EquipmentID: type: string - example: GL703034136 - description: Technical alarm ID - NodeID: + example: AVMS_01_00501 + description: EMAS equipment ID + Latitude: type: string - example: 703034136 - description: A unique code to represent each - unique traffic light node - Type: - type: number - example: 13 - description: Type of the technical alarm - • 4 (Blackout) - • 13 (Flashing Yellow) - StartDate: + example: 1.3290499998616139 + description: Latitude map coordinates of electronic signboard. + Longitude: type: string - example: 2014-04-12 01:58:00.0 - description: YYYY-MM-DD HH:MM:SS.ms - EndDate: - type: string - example: 2014-04-13 01:58:00.0 - description: YYYY-MM-DD HH:MM:SS.ms - (empty field if this is not a - scheduled maintenance) + example: 103.87474391991731 + description: Longitude map coordinates of electronic signboard. Message: type: string - example: (23/1)8:58 Flashing Yellow at - Bedok North Interchange/Bedok - North Street 1 Junc - description: Canning Message + example: ROAD|WORKS ON|BENDEMEER + description: VEH BREAKDOWN SH,AFTU.THOMSON unauthorized: type: object properties: From fac954a40852892b995c007f5ef4fdf8005ca41e Mon Sep 17 00:00:00 2001 From: rameshsentient <51635015+rameshsentient@users.noreply.github.com> Date: Mon, 1 Mar 2021 13:03:50 +0530 Subject: [PATCH 619/792] Update vms.yaml --- data/vms.yaml | 6 ++---- 1 file changed, 2 insertions(+), 4 deletions(-) diff --git a/data/vms.yaml b/data/vms.yaml index 0961a65c1..3dd8aebaa 100644 --- a/data/vms.yaml +++ b/data/vms.yaml @@ -3,10 +3,8 @@ info: title: VMS x-subscribelink: vms description: |+ - Returns traffic advisories (via variable message services) concerning - current traffic conditions that are displayed on EMAS signboards - along expressways and arterial roads. - 2 minutes – whenever there are updates + Returns traffic advisories (via variable message services) concerning current traffic conditions that are displayed on EMAS signboards + along expressways and arterial roads.2 minutes – whenever there are updates version: '0.1.0' servers: - url: 'https://api.sentient.io' From a97af7114377a6de998c314e05d1cdbab16de9c4 Mon Sep 17 00:00:00 2001 From: rameshsentient <51635015+rameshsentient@users.noreply.github.com> Date: Mon, 1 Mar 2021 13:05:42 +0530 Subject: [PATCH 620/792] Update lta_faulty_traffic_lights.yaml --- data/lta_faulty_traffic_lights.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/data/lta_faulty_traffic_lights.yaml b/data/lta_faulty_traffic_lights.yaml index bad5a5843..48454d8fb 100644 --- a/data/lta_faulty_traffic_lights.yaml +++ b/data/lta_faulty_traffic_lights.yaml @@ -23,7 +23,7 @@ paths: schema: $ref: '#/components/schemas/success' example: - odata.metadata: http://datamall2.mytransport.sg/ltaodataservice/$metadata#IncidentSet + odata.metadata: http://datamall2.mytransport.sg/ltaodataservice/$metadata#FaultyTrafficLights value: - AlarmID: GL703034136 NodeID: 703034136 From 83a7ab6d09a0898bc73cfad1eed3a81b75270fa4 Mon Sep 17 00:00:00 2001 From: rameshsentient <51635015+rameshsentient@users.noreply.github.com> Date: Mon, 1 Mar 2021 13:06:26 +0530 Subject: [PATCH 621/792] Update lta_faulty_traffic_lights.yaml --- data/lta_faulty_traffic_lights.yaml | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/data/lta_faulty_traffic_lights.yaml b/data/lta_faulty_traffic_lights.yaml index 48454d8fb..6415654c8 100644 --- a/data/lta_faulty_traffic_lights.yaml +++ b/data/lta_faulty_traffic_lights.yaml @@ -30,9 +30,7 @@ paths: Type: 13 StartDate: 2014-04-12 01:58:00.0 EndDate: 2014-04-13 01:58:00.0 - Message: (23/1)8:58 Flashing Yellow at - Bedok North Interchange/Bedok - North Street 1 Junc + Message: (23/1)8:58 Flashing Yellow at Bedok North Interchange/Bedok North Street 1 Junc '401': description: Unauthorized content: From e14b77f2f692b18055e8ecda822bf518a160e72d Mon Sep 17 00:00:00 2001 From: rameshsentient <51635015+rameshsentient@users.noreply.github.com> Date: Mon, 1 Mar 2021 13:12:25 +0530 Subject: [PATCH 622/792] Update lta_road_works.yaml --- data/lta_road_works.yaml | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/data/lta_road_works.yaml b/data/lta_road_works.yaml index 557aa6f4a..c9dc63bab 100644 --- a/data/lta_road_works.yaml +++ b/data/lta_road_works.yaml @@ -2,8 +2,7 @@ openapi: 3.0.1 info: title: Road Works description: |+ - Returns all road works being / to be carried out. - 24 hours – whenever there are updates + Returns all road works being / to be carried out.24 hours – whenever there are updates version: '0.1.0' servers: - url: 'https://api.sentient.io' From 04cb84a43fb28e08c1e5a961373ec62cd85183f6 Mon Sep 17 00:00:00 2001 From: rameshsentient <51635015+rameshsentient@users.noreply.github.com> Date: Mon, 1 Mar 2021 13:17:32 +0530 Subject: [PATCH 623/792] Update lta_traffic_incidents.yaml --- data/lta_traffic_incidents.yaml | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/data/lta_traffic_incidents.yaml b/data/lta_traffic_incidents.yaml index 7306c81f3..b2d853a39 100644 --- a/data/lta_traffic_incidents.yaml +++ b/data/lta_traffic_incidents.yaml @@ -3,7 +3,8 @@ info: title: LTA Traffic Incidents x-subscribelink: lta_traffic_incidents description: |+ - Returns alerts of traffic lights that are currently faulty, or currently undergoing scheduled maintenance. Updated every 2 minutes or whenever there are updates. + Returns incidents currently happening on the roads, such as Accidents, Vehicle Breakdowns, Road Blocks, Traffic Diversions etc. + Updated every 2 minutes or whenever there are updates. version: '0.1.0' servers: - url: 'https://api.sentient.io' From 14e102c34b52d5406a1fa841a05bd0386e7eb72d Mon Sep 17 00:00:00 2001 From: rameshsentient <51635015+rameshsentient@users.noreply.github.com> Date: Mon, 1 Mar 2021 13:18:11 +0530 Subject: [PATCH 624/792] Update vms.yaml --- data/vms.yaml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/data/vms.yaml b/data/vms.yaml index 3dd8aebaa..e16da40c4 100644 --- a/data/vms.yaml +++ b/data/vms.yaml @@ -3,8 +3,8 @@ info: title: VMS x-subscribelink: vms description: |+ - Returns traffic advisories (via variable message services) concerning current traffic conditions that are displayed on EMAS signboards - along expressways and arterial roads.2 minutes – whenever there are updates + Returns traffic advisories (via variable message services) concerning current traffic conditions that are displayed on + EMAS signboards along expressways and arterial roads.2 minutes – whenever there are updates version: '0.1.0' servers: - url: 'https://api.sentient.io' From 2615a827543b2ae70a74035fcbc8042742c2ed42 Mon Sep 17 00:00:00 2001 From: rameshsentient <51635015+rameshsentient@users.noreply.github.com> Date: Mon, 1 Mar 2021 13:22:19 +0530 Subject: [PATCH 625/792] Update vms.yaml --- data/vms.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/data/vms.yaml b/data/vms.yaml index e16da40c4..2a750f8c6 100644 --- a/data/vms.yaml +++ b/data/vms.yaml @@ -93,7 +93,7 @@ components: properties: odata.metadata: type: string - example: http://datamall2.mytransport.sg/ltaodataservice/$metadata#FaultyTrafficLights + example: http://datamall2.mytransport.sg/ltaodataservice/$metadata#VMS description: url value: type: array From 4b09e83d40c5f6fecde46b9d96a7917a974e8c5b Mon Sep 17 00:00:00 2001 From: rameshsentient <51635015+rameshsentient@users.noreply.github.com> Date: Mon, 1 Mar 2021 17:41:12 +0530 Subject: [PATCH 626/792] Update and rename vms.yaml to lta_vms.yaml --- data/{vms.yaml => lta_vms.yaml} | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) rename data/{vms.yaml => lta_vms.yaml} (99%) diff --git a/data/vms.yaml b/data/lta_vms.yaml similarity index 99% rename from data/vms.yaml rename to data/lta_vms.yaml index 2a750f8c6..c32952716 100644 --- a/data/vms.yaml +++ b/data/lta_vms.yaml @@ -1,7 +1,7 @@ openapi: 3.0.1 info: - title: VMS - x-subscribelink: vms + title: LTA VMS + x-subscribelink: lta_vms description: |+ Returns traffic advisories (via variable message services) concerning current traffic conditions that are displayed on EMAS signboards along expressways and arterial roads.2 minutes – whenever there are updates From 1741a767ebf8d738e10a08ce50cb6a62f6c24f37 Mon Sep 17 00:00:00 2001 From: rameshsentient <51635015+rameshsentient@users.noreply.github.com> Date: Mon, 1 Mar 2021 17:46:16 +0530 Subject: [PATCH 627/792] Update index.yaml --- index.yaml | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/index.yaml b/index.yaml index 30f6fcc55..4ee193ab4 100644 --- a/index.yaml +++ b/index.yaml @@ -296,10 +296,10 @@ data: title: LTA Traffic Incidents versions: 0.1.0: 'lta_traffic_incidents.yaml' - vms: - title: VMS + lta_vms: + title: LTA VMS versions: - 0.1.0: 'vms.yaml' + 0.1.0: 'lta_vms.yaml' realtime_weather: title: Realtime Weather versions: From 3e4ded6577f715917c938839bedab5a0bd544d5a Mon Sep 17 00:00:00 2001 From: rameshsentient <51635015+rameshsentient@users.noreply.github.com> Date: Mon, 1 Mar 2021 17:50:29 +0530 Subject: [PATCH 628/792] Update lta_faulty_traffic_lights.yaml --- data/lta_faulty_traffic_lights.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/data/lta_faulty_traffic_lights.yaml b/data/lta_faulty_traffic_lights.yaml index 6415654c8..cef7f2973 100644 --- a/data/lta_faulty_traffic_lights.yaml +++ b/data/lta_faulty_traffic_lights.yaml @@ -1,7 +1,7 @@ openapi: 3.0.1 info: title: LTA Faulty Traffic Lights - x-subscribelink: lta_faulty_traffic_lights + x-subscribelink: ltafaultytrafficlights description: |+ Returns alerts of traffic lights that are currently faulty, or currently undergoing scheduled maintenance. Updated every 2 minutes or whenever there are updates. version: '0.1.0' From 1b3d86423d123f45e3a9253a3914a16d720044a4 Mon Sep 17 00:00:00 2001 From: rameshsentient <51635015+rameshsentient@users.noreply.github.com> Date: Mon, 1 Mar 2021 17:51:31 +0530 Subject: [PATCH 629/792] Update lta_traffic_images.yaml --- data/lta_traffic_images.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/data/lta_traffic_images.yaml b/data/lta_traffic_images.yaml index 9d9d18f87..5e0cc7762 100644 --- a/data/lta_traffic_images.yaml +++ b/data/lta_traffic_images.yaml @@ -1,7 +1,7 @@ openapi: 3.0.1 info: title: LTA Traffic Images - x-subscribelink: lta_traffic_images + x-subscribelink: ltatrafficimages description: |+ Returns links to images of live traffic conditions along expressways and Woodlands & Tuas Checkpoints. Updates every 1 to 5 minutes or whenever there are updates. version: '0.1.0' From 2e81e1f2ad6205701491e66b2ae2a91bb29e36ed Mon Sep 17 00:00:00 2001 From: rameshsentient <51635015+rameshsentient@users.noreply.github.com> Date: Mon, 1 Mar 2021 17:55:07 +0530 Subject: [PATCH 630/792] Update lta_traffic_incidents.yaml --- data/lta_traffic_incidents.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/data/lta_traffic_incidents.yaml b/data/lta_traffic_incidents.yaml index b2d853a39..9163ee908 100644 --- a/data/lta_traffic_incidents.yaml +++ b/data/lta_traffic_incidents.yaml @@ -1,7 +1,7 @@ openapi: 3.0.1 info: title: LTA Traffic Incidents - x-subscribelink: lta_traffic_incidents + x-subscribelink: ltatrafficincidents description: |+ Returns incidents currently happening on the roads, such as Accidents, Vehicle Breakdowns, Road Blocks, Traffic Diversions etc. Updated every 2 minutes or whenever there are updates. From 6d4c999ac8bc3127f36b7042761fae68563bc84c Mon Sep 17 00:00:00 2001 From: rameshsentient <51635015+rameshsentient@users.noreply.github.com> Date: Mon, 1 Mar 2021 17:55:45 +0530 Subject: [PATCH 631/792] Update lta_vms.yaml --- data/lta_vms.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/data/lta_vms.yaml b/data/lta_vms.yaml index c32952716..4a61ed07d 100644 --- a/data/lta_vms.yaml +++ b/data/lta_vms.yaml @@ -1,7 +1,7 @@ openapi: 3.0.1 info: title: LTA VMS - x-subscribelink: lta_vms + x-subscribelink: ltavms description: |+ Returns traffic advisories (via variable message services) concerning current traffic conditions that are displayed on EMAS signboards along expressways and arterial roads.2 minutes – whenever there are updates From 96625044852a39e7f4c6c27e2dae0c288c949be5 Mon Sep 17 00:00:00 2001 From: rameshsentient <51635015+rameshsentient@users.noreply.github.com> Date: Mon, 1 Mar 2021 17:58:08 +0530 Subject: [PATCH 632/792] Update lta_road_works.yaml --- data/lta_road_works.yaml | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/data/lta_road_works.yaml b/data/lta_road_works.yaml index c9dc63bab..52417001d 100644 --- a/data/lta_road_works.yaml +++ b/data/lta_road_works.yaml @@ -1,6 +1,7 @@ openapi: 3.0.1 info: - title: Road Works + title: LTA Road Works + x-subscribelink: ltaroadworks description: |+ Returns all road works being / to be carried out.24 hours – whenever there are updates version: '0.1.0' From 9e493863763c15ff3e62e89d2aa43b4962e484b7 Mon Sep 17 00:00:00 2001 From: rameshsentient <51635015+rameshsentient@users.noreply.github.com> Date: Mon, 1 Mar 2021 17:59:15 +0530 Subject: [PATCH 633/792] Update realtime_weather.yaml --- data/realtime_weather.yaml | 1 + 1 file changed, 1 insertion(+) diff --git a/data/realtime_weather.yaml b/data/realtime_weather.yaml index 3d19b057c..9d58439ed 100644 --- a/data/realtime_weather.yaml +++ b/data/realtime_weather.yaml @@ -1,6 +1,7 @@ openapi: 3.0.1 info: title: Realtime Weather + x-subscribelink: realtime_weather description: |+ Current weather or realtime weather API method allows a user to get up to date current weather information. The data is returned as a Current Object. From 4a78c01729de0541fc11834785beb04d8b79ba9d Mon Sep 17 00:00:00 2001 From: rameshsentient <51635015+rameshsentient@users.noreply.github.com> Date: Mon, 1 Mar 2021 18:04:13 +0530 Subject: [PATCH 634/792] Update lta_road_works.yaml --- data/lta_road_works.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/data/lta_road_works.yaml b/data/lta_road_works.yaml index 52417001d..ff3b997c6 100644 --- a/data/lta_road_works.yaml +++ b/data/lta_road_works.yaml @@ -3,7 +3,7 @@ info: title: LTA Road Works x-subscribelink: ltaroadworks description: |+ - Returns all road works being / to be carried out.24 hours – whenever there are updates + Returns all road works being / to be carried out. Updated every 24 hours or whenever there are updates. version: '0.1.0' servers: - url: 'https://api.sentient.io' From 3819c2dc42c9f099b76b8c3810992665c1782fd1 Mon Sep 17 00:00:00 2001 From: divya Date: Tue, 2 Mar 2021 10:17:34 +0800 Subject: [PATCH 635/792] Landmark jp and sg date and changelog updated --- computer_vision/landmark_detection_jp_v1.0.yaml | 6 +++--- computer_vision/landmark_detection_sg_v1.0.yaml | 6 +++--- 2 files changed, 6 insertions(+), 6 deletions(-) diff --git a/computer_vision/landmark_detection_jp_v1.0.yaml b/computer_vision/landmark_detection_jp_v1.0.yaml index 2075b149b..5c3aceda4 100644 --- a/computer_vision/landmark_detection_jp_v1.0.yaml +++ b/computer_vision/landmark_detection_jp_v1.0.yaml @@ -16,7 +16,7 @@ servers: - url: 'https://dev-apis.sentient.io' tags: - name: "v1.0.0" - description: "Published Date - Dec 31, 2020" + description: "Published Date - Mar 05, 2021" paths: /microservices/cv/landmarkjp/v1/getpredictions: post: @@ -229,8 +229,8 @@ components: items: oneOf: - type: string - example: Published Date - Dec 31, 2020 - description: Standardizing Output JSON + example: Published Date - Mar 05, 2021 + description: Standardizing Output JSON & Model improvement v0.1.0: type: array items: diff --git a/computer_vision/landmark_detection_sg_v1.0.yaml b/computer_vision/landmark_detection_sg_v1.0.yaml index ee912e6b0..c54dbf579 100644 --- a/computer_vision/landmark_detection_sg_v1.0.yaml +++ b/computer_vision/landmark_detection_sg_v1.0.yaml @@ -16,7 +16,7 @@ servers: - url: 'https://dev-apis.sentient.io' tags: - name: "v1.0.0" - description: "Published Date - Dec 31, 2020" + description: "Published Date - Mar 05, 2021" paths: /microservices/cv/landmarksg/v1/getpredictions: post: @@ -231,8 +231,8 @@ components: items: oneOf: - type: string - example: Published Date - Dec 31, 2020 - description: Standardizing Output JSON + example: Published Date - Mar 05, 2021 + description: Standardizing Output JSON & Model improvement v0.1.0: type: array items: From 12a70aac821270f93948d00b5e2c291457fa740c Mon Sep 17 00:00:00 2001 From: divya Date: Tue, 2 Mar 2021 15:00:08 +0800 Subject: [PATCH 636/792] Landmark jp and sg changelog with detailed info --- computer_vision/landmark_detection_jp_v1.0.yaml | 6 +++++- computer_vision/landmark_detection_sg_v1.0.yaml | 6 +++++- 2 files changed, 10 insertions(+), 2 deletions(-) diff --git a/computer_vision/landmark_detection_jp_v1.0.yaml b/computer_vision/landmark_detection_jp_v1.0.yaml index 5c3aceda4..c36234546 100644 --- a/computer_vision/landmark_detection_jp_v1.0.yaml +++ b/computer_vision/landmark_detection_jp_v1.0.yaml @@ -230,7 +230,11 @@ components: oneOf: - type: string example: Published Date - Mar 05, 2021 - description: Standardizing Output JSON & Model improvement + description: |+ + 1. Standardizing Output JSON + 2. Overall model accuracy improvements. + 3. Better accuracy in detecting non-landmarks. + 4. Fix bug in the confidence score computation. v0.1.0: type: array items: diff --git a/computer_vision/landmark_detection_sg_v1.0.yaml b/computer_vision/landmark_detection_sg_v1.0.yaml index c54dbf579..a643e0531 100644 --- a/computer_vision/landmark_detection_sg_v1.0.yaml +++ b/computer_vision/landmark_detection_sg_v1.0.yaml @@ -232,7 +232,11 @@ components: oneOf: - type: string example: Published Date - Mar 05, 2021 - description: Standardizing Output JSON & Model improvement + description: |+ + 1. Standardizing Output JSON + 2. Overall model accuracy improvements. + 3. Better accuracy in detecting non-landmarks. + 4. Fix bug in the confidence score computation. v0.1.0: type: array items: From 82669c2a6d41f9a28c7250a2ddc87bd3bdd51a04 Mon Sep 17 00:00:00 2001 From: divya Date: Tue, 2 Mar 2021 15:39:13 +0800 Subject: [PATCH 637/792] removed fullstop in changelog for landmarkjp and sg --- computer_vision/landmark_detection_jp_v1.0.yaml | 6 +++--- computer_vision/landmark_detection_sg_v1.0.yaml | 6 +++--- 2 files changed, 6 insertions(+), 6 deletions(-) diff --git a/computer_vision/landmark_detection_jp_v1.0.yaml b/computer_vision/landmark_detection_jp_v1.0.yaml index c36234546..95ee3d9ed 100644 --- a/computer_vision/landmark_detection_jp_v1.0.yaml +++ b/computer_vision/landmark_detection_jp_v1.0.yaml @@ -232,9 +232,9 @@ components: example: Published Date - Mar 05, 2021 description: |+ 1. Standardizing Output JSON - 2. Overall model accuracy improvements. - 3. Better accuracy in detecting non-landmarks. - 4. Fix bug in the confidence score computation. + 2. Overall model accuracy improvements + 3. Better accuracy in detecting non-landmarks + 4. Fix bug in the confidence score computation v0.1.0: type: array items: diff --git a/computer_vision/landmark_detection_sg_v1.0.yaml b/computer_vision/landmark_detection_sg_v1.0.yaml index a643e0531..e4c43bb92 100644 --- a/computer_vision/landmark_detection_sg_v1.0.yaml +++ b/computer_vision/landmark_detection_sg_v1.0.yaml @@ -234,9 +234,9 @@ components: example: Published Date - Mar 05, 2021 description: |+ 1. Standardizing Output JSON - 2. Overall model accuracy improvements. - 3. Better accuracy in detecting non-landmarks. - 4. Fix bug in the confidence score computation. + 2. Overall model accuracy improvements + 3. Better accuracy in detecting non-landmarks + 4. Fix bug in the confidence score computation v0.1.0: type: array items: From 44178b53f1651f64be87d6b7fcf169a9b2efe8a8 Mon Sep 17 00:00:00 2001 From: rameshsentient <51635015+rameshsentient@users.noreply.github.com> Date: Tue, 2 Mar 2021 18:09:53 +0530 Subject: [PATCH 638/792] Update face_recognition_politicians_sg.yaml --- computer_vision/face_recognition_politicians_sg.yaml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/computer_vision/face_recognition_politicians_sg.yaml b/computer_vision/face_recognition_politicians_sg.yaml index 9ed562873..e41bc3768 100644 --- a/computer_vision/face_recognition_politicians_sg.yaml +++ b/computer_vision/face_recognition_politicians_sg.yaml @@ -63,13 +63,13 @@ paths: schema: $ref: '#/components/schemas/inputfieldmissing' '413': - description: Input Limit Exceeded + description: Payload Too Large content: application/json: schema: $ref: '#/components/schemas/inputlimitexceeded' '415': - description: Invalid Input + description: Unsupported Media Type content: application/json: schema: From ac71f47cd60dc2ea1f6782a8affe5005e1c51712 Mon Sep 17 00:00:00 2001 From: rameshsentient <51635015+rameshsentient@users.noreply.github.com> Date: Tue, 2 Mar 2021 18:10:01 +0530 Subject: [PATCH 639/792] Update face_recognition_v1.0.yaml --- computer_vision/face_recognition_v1.0.yaml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/computer_vision/face_recognition_v1.0.yaml b/computer_vision/face_recognition_v1.0.yaml index 0438601cb..4ccae7585 100644 --- a/computer_vision/face_recognition_v1.0.yaml +++ b/computer_vision/face_recognition_v1.0.yaml @@ -116,13 +116,13 @@ paths: schema: $ref: '#/components/schemas/inputfieldmissing' '413': - description: Input Limit Exceeded + description: Payload Too Large content: application/json: schema: $ref: '#/components/schemas/inputlimitexceeded' '415': - description: Invalid Input + description: Unsupported Media Type content: application/json: schema: From f34221c7a8e6b210d81454d86905a51519668ba2 Mon Sep 17 00:00:00 2001 From: rameshsentient <51635015+rameshsentient@users.noreply.github.com> Date: Tue, 2 Mar 2021 18:11:14 +0530 Subject: [PATCH 640/792] Update named-entity_recognition_thai.yaml --- nlp/named-entity_recognition_thai.yaml | 7 ------- 1 file changed, 7 deletions(-) diff --git a/nlp/named-entity_recognition_thai.yaml b/nlp/named-entity_recognition_thai.yaml index 23790913b..6f8816d9d 100644 --- a/nlp/named-entity_recognition_thai.yaml +++ b/nlp/named-entity_recognition_thai.yaml @@ -202,13 +202,6 @@ components: versions: type: object properties: - v1.0.0: - type: array - items: - oneOf: - - type: string - example: Published Date - Aug 28,2020 - description: Updated version release v1.0 v0.1.0: type: array items: From 9deed09dd5b48704fa896f934642784e9334809c Mon Sep 17 00:00:00 2001 From: rameshsentient <51635015+rameshsentient@users.noreply.github.com> Date: Tue, 2 Mar 2021 18:11:52 +0530 Subject: [PATCH 641/792] Update face_recognition_v1.0.yaml --- computer_vision/face_recognition_v1.0.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/computer_vision/face_recognition_v1.0.yaml b/computer_vision/face_recognition_v1.0.yaml index 4ccae7585..9a47fab9c 100644 --- a/computer_vision/face_recognition_v1.0.yaml +++ b/computer_vision/face_recognition_v1.0.yaml @@ -75,7 +75,7 @@ paths: - v1.0.1 responses: '200': - description: success response + description: Ok content: application/json: schema: From e4c9f2e36ed59f505716f23bc01a9408286ec4a5 Mon Sep 17 00:00:00 2001 From: rameshsentient <51635015+rameshsentient@users.noreply.github.com> Date: Tue, 2 Mar 2021 18:12:19 +0530 Subject: [PATCH 642/792] Update face_recognition_politicians_sg.yaml --- computer_vision/face_recognition_politicians_sg.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/computer_vision/face_recognition_politicians_sg.yaml b/computer_vision/face_recognition_politicians_sg.yaml index e41bc3768..b30c9408c 100644 --- a/computer_vision/face_recognition_politicians_sg.yaml +++ b/computer_vision/face_recognition_politicians_sg.yaml @@ -25,7 +25,7 @@ paths: - v0.1.0 responses: '200': - description: success response + description: Ok content: application/json: schema: From 0b293f022e9b03fa6c9dc13431d87493c9c75d9d Mon Sep 17 00:00:00 2001 From: rameshsentient <51635015+rameshsentient@users.noreply.github.com> Date: Tue, 2 Mar 2021 18:14:22 +0530 Subject: [PATCH 643/792] Update landmark_detection_sg_v1.0.yaml --- computer_vision/landmark_detection_sg_v1.0.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/computer_vision/landmark_detection_sg_v1.0.yaml b/computer_vision/landmark_detection_sg_v1.0.yaml index e4c43bb92..125b76136 100644 --- a/computer_vision/landmark_detection_sg_v1.0.yaml +++ b/computer_vision/landmark_detection_sg_v1.0.yaml @@ -13,7 +13,7 @@ info: version: '1.0.0' x-subscribelink: landmark_detection_sg servers: - - url: 'https://dev-apis.sentient.io' + - url: 'https://apis.sentient.io' tags: - name: "v1.0.0" description: "Published Date - Mar 05, 2021" From 1c7defcf53259019c43b0b8b66fcd6d5fd13872d Mon Sep 17 00:00:00 2001 From: rameshsentient <51635015+rameshsentient@users.noreply.github.com> Date: Tue, 2 Mar 2021 18:14:29 +0530 Subject: [PATCH 644/792] Update landmark_detection_jp_v1.0.yaml --- computer_vision/landmark_detection_jp_v1.0.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/computer_vision/landmark_detection_jp_v1.0.yaml b/computer_vision/landmark_detection_jp_v1.0.yaml index 95ee3d9ed..6b1ed05b1 100644 --- a/computer_vision/landmark_detection_jp_v1.0.yaml +++ b/computer_vision/landmark_detection_jp_v1.0.yaml @@ -13,7 +13,7 @@ info: version: '1.0.0' x-subscribelink: landmark_detection_jp servers: - - url: 'https://dev-apis.sentient.io' + - url: 'https://apis.sentient.io' tags: - name: "v1.0.0" description: "Published Date - Mar 05, 2021" From 1027b0bd170a390c60ef4dd9a825a89d6380f170 Mon Sep 17 00:00:00 2001 From: Mohamed Luqman <57977684+mohamedSent@users.noreply.github.com> Date: Thu, 4 Mar 2021 09:31:47 +0530 Subject: [PATCH 645/792] Update lidar_trajectory_data.yaml --- data/lidar_trajectory_data.yaml | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/data/lidar_trajectory_data.yaml b/data/lidar_trajectory_data.yaml index 4026706c3..2b292c091 100644 --- a/data/lidar_trajectory_data.yaml +++ b/data/lidar_trajectory_data.yaml @@ -127,7 +127,7 @@ paths: * filter default: false example: |+ - {"filter":[{"match":{"_id": "57464093"}},{"match":{"dataclass": "SD"}},{"match":{"detecttime": "2020-7-7T18:28:45.365Z"}}]} + {"filter":[{"match":{"_id": "64406c95#64291"}},{"match":{"dataclass": "SD"}},{"match":{"detecttime": "2020-7-7T18:28:45.365Z"}}]} responses: '200': description: success response @@ -142,15 +142,15 @@ paths: hits: - _index: index_ihi_pointcloud _type: dir_doc - _id: 57364055 + _id: 64406c95#64291 _score: 1.0 _source: - 1x: 79 - 1y: 3927 - 2x: 79 - 2y: 4515 - createddate: '2021-02-18T16:19:09.689Z' - lastupdated: '2021-02-18T16:19:09.689Z' + 1x: 682 + 1y: 6210 + 2x: 782 + 2y: 6210 + createddate: '2021-03-04T03:29:14.930Z' + lastupdated: '2021-03-04T03:29:14.930Z' dataclass: "SD" datalen: 612 datanumlow: 15 From 41f67ae152768ceb4e3ba12a68e5242e0c7657fc Mon Sep 17 00:00:00 2001 From: Mohamed Luqman <57977684+mohamedSent@users.noreply.github.com> Date: Thu, 4 Mar 2021 10:54:23 +0530 Subject: [PATCH 646/792] Update lidar_trajectory_data.yaml --- data/lidar_trajectory_data.yaml | 29 +++++++++++++++++------------ 1 file changed, 17 insertions(+), 12 deletions(-) diff --git a/data/lidar_trajectory_data.yaml b/data/lidar_trajectory_data.yaml index 2b292c091..6010db02e 100644 --- a/data/lidar_trajectory_data.yaml +++ b/data/lidar_trajectory_data.yaml @@ -152,23 +152,28 @@ paths: createddate: '2021-03-04T03:29:14.930Z' lastupdated: '2021-03-04T03:29:14.930Z' dataclass: "SD" - datalen: 612 - datanumlow: 15 + datalen: 936 + datanumlow: 24 datanumup: 0 - detecttime: '2020-7-7T18:28:45.365Z' - height: 261 - identify: 11 + detecttime: '2020-7-7T18:28:48.671Z' + height: 47 + identify: 12 jamlane: 0 - length: 588 + length: 100 originid: "0x145D" - sendtime: '2020-7-7T18:38:35.653Z' - seqno: 573 + sendtime: '2020-7-7T18:28:48.792Z' + seqno: 64406 situation: "0x02" - targetid: 64055 + targetid: c95#64291 targetidx: "0x1451" - width: 250 - xspeed: -8 - yspeed: -60 + width: 100 + xspeed: 12 + yspeed: 14 + xcoord: "357844.6167091789" + ycoord: "148684.80620664736" + location: + lat: 1.3448589781787064 + lon: 103.72224233670825 message: Successfully Processed status: Success '401': From 756151648dd0cc296c7b722aec747dd398588faa Mon Sep 17 00:00:00 2001 From: Mohamed Luqman <57977684+mohamedSent@users.noreply.github.com> Date: Thu, 4 Mar 2021 11:01:54 +0530 Subject: [PATCH 647/792] Updated data --- data/lidar_trajectory_data.yaml | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/data/lidar_trajectory_data.yaml b/data/lidar_trajectory_data.yaml index 6010db02e..3c3abf969 100644 --- a/data/lidar_trajectory_data.yaml +++ b/data/lidar_trajectory_data.yaml @@ -142,7 +142,7 @@ paths: hits: - _index: index_ihi_pointcloud _type: dir_doc - _id: 64406c95#64291 + _id: "64406c95#64291" _score: 1.0 _source: 1x: 682 @@ -268,7 +268,7 @@ components: _id: type: string description: Document ID - example: "57364055" + example: "64406c95#64291" _score: type: number description: The document score for the search request @@ -281,19 +281,19 @@ components: 1x: type: number description: X direction central top position of target - example: 79 + example: 682 1y: type: number description: Y direction central top position of target - example: 3927 + example: 6210 2x: type: number description: X direction central tail position of target - example: 79 + example: 782 2y: type: number description: Y direction central tail position of target - example: 4515 + example: 6210 dataclass: type: string description: Type of Data From a5e6b93408291196808b3b23437d097f4072fd0a Mon Sep 17 00:00:00 2001 From: Mohamed Luqman <57977684+mohamedSent@users.noreply.github.com> Date: Thu, 4 Mar 2021 12:33:36 +0530 Subject: [PATCH 648/792] updated docs data --- data/lidar_trajectory_data.yaml | 52 +++++++++++++++++++++++---------- 1 file changed, 37 insertions(+), 15 deletions(-) diff --git a/data/lidar_trajectory_data.yaml b/data/lidar_trajectory_data.yaml index 3c3abf969..7b4bacc13 100644 --- a/data/lidar_trajectory_data.yaml +++ b/data/lidar_trajectory_data.yaml @@ -301,11 +301,11 @@ components: datalen: type: number description: Lenght of the information - example: 612 + example: 936 datanumlow: type: number description: Lower data number - example: 15 + example: 24 datanumup: type: number description: Upper data number @@ -313,15 +313,15 @@ components: detecttime: type: string description: Target detected time - example: "2020-7-7T18:28:45.365Z" + example: "2020-7-7T18:28:48.671Z" height: type: number description: Height of target - example: 261 + example: 47 identify: type: number description: Target vehicle type - example: 11 + example: 12 jamlane: type: number description: Jam lane number @@ -329,7 +329,7 @@ components: length: type: number description: Length of target - example: 588 + example: 100 originid: type: string description: Origin Id @@ -337,27 +337,27 @@ components: sendtime: type: string description: Target send time - example: "2020-7-7T18:38:35.653Z" + example: "2020-7-7T18:28:48.792Z" createddate: type: string description: Record first release date on sentient - example: "2021-02-18T16:19:09.689Z" + example: "2021-03-04T03:29:14.930Z" lastupdated: type: string description: Record last updated date on sentient - example: "2021-02-18T16:19:09.689Z" + example: "2021-03-04T03:29:14.930Z" seqno: type: number description: Sequence number of target - example: 573 + example: 64406 situation: type: string description: Situation of target example: "0x02" targetid: - type: number + type: string description: Target Id - example: 64055 + example: "c95#64291" targetidx: type: string description: Target Idx @@ -365,15 +365,37 @@ components: width: type: number description: Width of target - example: 250 + example: 100 xspeed: type: number description: xspeed of target - example: -8 + example: 12 yspeed: type: number description: yspeed of target - example: -60 + example: 14 + xcoord: + type: string + description: SVY21 X coordinates (Note, SVY21 is a localised plane coordinate system used specifically by Singapore. For global GPS lat/long coordinates, refer to "location" object) + example: "357844.6167091789" + ycoord: + type: string + description: SVY21 Y coordinates (Note, SVY21 is a localised plane coordinate system used specifically by Singapore. For global GPS lat/long coordinates, refer to "location" object) + example: "148684.80620664736" + location: + type: object + description: WGS84 (World Geodetic System) lat/long coordinates. This is the standard coordinate system used Global Positioning System (GPS). + example: {"lat":1.3448589781787064,"lon":103.72224233670825} + properties: + lat: + type: string + description: WGS84 (GPS) latitude + example: "1.3448589781787064" + lon: + type: string + description: WGS84 (GPS) longitude + example: "103.72224233670825" + message: type: string example: Successfully Processed From 2a2f0753da67a33f4335458524633d1c2f2bb2a0 Mon Sep 17 00:00:00 2001 From: Mohamed Luqman <57977684+mohamedSent@users.noreply.github.com> Date: Thu, 4 Mar 2021 12:34:26 +0530 Subject: [PATCH 649/792] Update lidar_trajectory_data.yaml --- data/lidar_trajectory_data.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/data/lidar_trajectory_data.yaml b/data/lidar_trajectory_data.yaml index 7b4bacc13..0bad45532 100644 --- a/data/lidar_trajectory_data.yaml +++ b/data/lidar_trajectory_data.yaml @@ -164,7 +164,7 @@ paths: sendtime: '2020-7-7T18:28:48.792Z' seqno: 64406 situation: "0x02" - targetid: c95#64291 + targetid: "c95#64291" targetidx: "0x1451" width: 100 xspeed: 12 From 6a13b092a19da8577fa5c6d492a5ec8d45e8008c Mon Sep 17 00:00:00 2001 From: Mohamed Luqman <57977684+mohamedSent@users.noreply.github.com> Date: Thu, 4 Mar 2021 16:54:36 +0530 Subject: [PATCH 650/792] Update lidar_trajectory_data.yaml --- data/lidar_trajectory_data.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/data/lidar_trajectory_data.yaml b/data/lidar_trajectory_data.yaml index 0bad45532..eb6f9d105 100644 --- a/data/lidar_trajectory_data.yaml +++ b/data/lidar_trajectory_data.yaml @@ -127,7 +127,7 @@ paths: * filter default: false example: |+ - {"filter":[{"match":{"_id": "64406c95#64291"}},{"match":{"dataclass": "SD"}},{"match":{"detecttime": "2020-7-7T18:28:45.365Z"}}]} + {"filter":[{"match":{"_id": "64406c95#64291"}},{"match":{"dataclass": "SD"}},{"match":{"detecttime": "2020-7-7T18:28:48.671Z"}}]} responses: '200': description: success response From 289b02aa5939ba4024d9cf1842740a92a5e6262a Mon Sep 17 00:00:00 2001 From: Mohamed Luqman <57977684+mohamedSent@users.noreply.github.com> Date: Thu, 4 Mar 2021 18:06:54 +0530 Subject: [PATCH 651/792] Update lidar_trajectory_data.yaml --- data/lidar_trajectory_data.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/data/lidar_trajectory_data.yaml b/data/lidar_trajectory_data.yaml index eb6f9d105..17edc3ccc 100644 --- a/data/lidar_trajectory_data.yaml +++ b/data/lidar_trajectory_data.yaml @@ -28,7 +28,7 @@ info: > {"should":[{"match_phrase":{"seqno":39736}}]} * **filter** - All of the stated conditions that must match. However, results are not scored unlike the other filter types which returns results based on how well the conditions are met. - > {"filter":[{"match":{"targetid":9405}}]} + > {"filter":[{"match":{"targetid":"c95#10920"}}]} For a more detailed guide on filter types, [refer to this](https://www.elastic.co/guide/en/elasticsearch/reference/6.8/query-dsl-bool-query.html). From 2ad97dd898e04f70ba29b2c231205ef795677703 Mon Sep 17 00:00:00 2001 From: rameshsentient <51635015+rameshsentient@users.noreply.github.com> Date: Fri, 5 Mar 2021 15:36:34 +0530 Subject: [PATCH 652/792] Update automatic_speech_recognition_eng_sg_v1.0.yaml --- voice/automatic_speech_recognition_eng_sg_v1.0.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/voice/automatic_speech_recognition_eng_sg_v1.0.yaml b/voice/automatic_speech_recognition_eng_sg_v1.0.yaml index 13b23116f..8cfe881ab 100644 --- a/voice/automatic_speech_recognition_eng_sg_v1.0.yaml +++ b/voice/automatic_speech_recognition_eng_sg_v1.0.yaml @@ -13,7 +13,7 @@ info: - Combine this with the Text-to-Speech API to deliver voice-enabled experiences in IoT (Internet of Things) applications, such as implementing voice commands. x-subscribelink: automatic_speech_recognition_eng_sg servers: - - url: 'https://apis.sentient.io' + - url: 'https://dev-apis.sentient.io' tags: - name: "v1.1.0" description: "Published Date - Jan 22, 2021" From ee9f10efb38f16637f1308525e3d098a67dc3766 Mon Sep 17 00:00:00 2001 From: rameshsentient <51635015+rameshsentient@users.noreply.github.com> Date: Mon, 8 Mar 2021 10:27:42 +0530 Subject: [PATCH 653/792] Update amenities_hardcourts_hdb_sg.yaml --- data/amenities_hardcourts_hdb_sg.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/data/amenities_hardcourts_hdb_sg.yaml b/data/amenities_hardcourts_hdb_sg.yaml index 1cdf3f702..6149a2b04 100644 --- a/data/amenities_hardcourts_hdb_sg.yaml +++ b/data/amenities_hardcourts_hdb_sg.yaml @@ -48,7 +48,7 @@ paths: - v0.1.0 responses: '200': - description: success response + description: Ok content: application/json: schema: From 5bd17ef82d687838499267b737b1511f33d02761 Mon Sep 17 00:00:00 2001 From: rameshsentient <51635015+rameshsentient@users.noreply.github.com> Date: Mon, 8 Mar 2021 10:29:44 +0530 Subject: [PATCH 654/792] Update amenities_lamp_posts_hdb_sg.yaml --- data/amenities_lamp_posts_hdb_sg.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/data/amenities_lamp_posts_hdb_sg.yaml b/data/amenities_lamp_posts_hdb_sg.yaml index 849848ff1..a05f7c6b9 100644 --- a/data/amenities_lamp_posts_hdb_sg.yaml +++ b/data/amenities_lamp_posts_hdb_sg.yaml @@ -50,7 +50,7 @@ paths: - v0.1.0 responses: '200': - description: success response + description: Ok content: application/json: schema: From c127dd5b6ad03a4366b0da47bfcd4eb4d4458289 Mon Sep 17 00:00:00 2001 From: rameshsentient <51635015+rameshsentient@users.noreply.github.com> Date: Mon, 8 Mar 2021 10:30:05 +0530 Subject: [PATCH 655/792] Update amenities_shelters_hdb_sg.yaml --- data/amenities_shelters_hdb_sg.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/data/amenities_shelters_hdb_sg.yaml b/data/amenities_shelters_hdb_sg.yaml index af0241150..11cd958ff 100644 --- a/data/amenities_shelters_hdb_sg.yaml +++ b/data/amenities_shelters_hdb_sg.yaml @@ -53,7 +53,7 @@ paths: - v0.1.0 responses: '200': - description: success response + description: Ok content: application/json: schema: From 2fb93a8edfb636f85a372a0ce54ed1f701dcc952 Mon Sep 17 00:00:00 2001 From: rameshsentient <51635015+rameshsentient@users.noreply.github.com> Date: Mon, 8 Mar 2021 10:33:33 +0530 Subject: [PATCH 656/792] Update building_addresses_hdb_sg.yaml --- data/building_addresses_hdb_sg.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/data/building_addresses_hdb_sg.yaml b/data/building_addresses_hdb_sg.yaml index 4e37835c1..d5feebe5f 100644 --- a/data/building_addresses_hdb_sg.yaml +++ b/data/building_addresses_hdb_sg.yaml @@ -142,7 +142,7 @@ paths: {"must":[{"range":{"block":{"gte":100}}}],"should":[{"range":{"block":{"lte":200}}}],"filter":[{"match_phrase":{"street":"ang mo kio"}}],"must_not":[{"match":{"street":"avenue 3"}}]} responses: '200': - description: success response + description: Ok content: application/json: schema: From 6f87d5332a1a9b553c78dcf770d52b38a31a1be4 Mon Sep 17 00:00:00 2001 From: rameshsentient <51635015+rameshsentient@users.noreply.github.com> Date: Mon, 8 Mar 2021 10:34:09 +0530 Subject: [PATCH 657/792] Update carpark_hdb_sg.yaml --- data/carpark_hdb_sg.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/data/carpark_hdb_sg.yaml b/data/carpark_hdb_sg.yaml index c4ae243db..168c0ffb7 100644 --- a/data/carpark_hdb_sg.yaml +++ b/data/carpark_hdb_sg.yaml @@ -174,7 +174,7 @@ paths: {"must":[{"match":{"mc":0}}],"filter":[{"match":{"street":"bishan"}}],"should":[{"match_phrase":{"street":"ang mo kio"}}],"must_not":[{"match":{"postalcode":"570251"}}]} responses: '200': - description: success response + description: Ok content: application/json: schema: From 5f64f08c466b320668107fe0ee5b68ff537375d6 Mon Sep 17 00:00:00 2001 From: rameshsentient <51635015+rameshsentient@users.noreply.github.com> Date: Mon, 8 Mar 2021 10:34:36 +0530 Subject: [PATCH 658/792] Update commercial_directories_hdb_sg.yaml --- data/commercial_directories_hdb_sg.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/data/commercial_directories_hdb_sg.yaml b/data/commercial_directories_hdb_sg.yaml index 1f7db3a55..e51741fd4 100644 --- a/data/commercial_directories_hdb_sg.yaml +++ b/data/commercial_directories_hdb_sg.yaml @@ -162,7 +162,7 @@ paths: responses: '200': - description: success response + description: Ok content: application/json: schema: From 2b75b8903e39c7cba400abea5917389f667d988a Mon Sep 17 00:00:00 2001 From: rameshsentient <51635015+rameshsentient@users.noreply.github.com> Date: Mon, 8 Mar 2021 10:35:00 +0530 Subject: [PATCH 659/792] Update d&b_basic_individual_search_sg.yaml --- data/d&b_basic_individual_search_sg.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/data/d&b_basic_individual_search_sg.yaml b/data/d&b_basic_individual_search_sg.yaml index 28c6ca708..ab22c3fad 100644 --- a/data/d&b_basic_individual_search_sg.yaml +++ b/data/d&b_basic_individual_search_sg.yaml @@ -28,7 +28,7 @@ paths: $ref: '#/components/schemas/REQUEST' responses: '200': - description: success response + description: Ok content: application/xml: schema: From 0315894415bbe674aeaca8947816e871a82537ec Mon Sep 17 00:00:00 2001 From: rameshsentient <51635015+rameshsentient@users.noreply.github.com> Date: Mon, 8 Mar 2021 10:39:49 +0530 Subject: [PATCH 660/792] Update d&b_brief_financial_information_sg.yaml --- data/d&b_brief_financial_information_sg.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/data/d&b_brief_financial_information_sg.yaml b/data/d&b_brief_financial_information_sg.yaml index 4981e4adc..a1ef22f9a 100644 --- a/data/d&b_brief_financial_information_sg.yaml +++ b/data/d&b_brief_financial_information_sg.yaml @@ -27,7 +27,7 @@ paths: $ref: '#/components/schemas/REQUEST' responses: '200': - description: success response + description: Ok content: application/xml: schema: From 4d67b3a51bd01a10dfe1a28641e9c8a82b2f6587 Mon Sep 17 00:00:00 2001 From: rameshsentient <51635015+rameshsentient@users.noreply.github.com> Date: Mon, 8 Mar 2021 10:43:51 +0530 Subject: [PATCH 661/792] Update d&b_business_check_plus_sg.yaml --- data/d&b_business_check_plus_sg.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/data/d&b_business_check_plus_sg.yaml b/data/d&b_business_check_plus_sg.yaml index 29b63ee86..5c4e5977b 100644 --- a/data/d&b_business_check_plus_sg.yaml +++ b/data/d&b_business_check_plus_sg.yaml @@ -27,7 +27,7 @@ paths: $ref: '#/components/schemas/REQUEST' responses: '200': - description: success response + description: Ok content: application/xml: schema: From 63b1eb56c2a392137e9675089c4c9416e80ee4e5 Mon Sep 17 00:00:00 2001 From: rameshsentient <51635015+rameshsentient@users.noreply.github.com> Date: Mon, 8 Mar 2021 11:17:47 +0530 Subject: [PATCH 662/792] Update d&b_business_check_sg.yaml --- data/d&b_business_check_sg.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/data/d&b_business_check_sg.yaml b/data/d&b_business_check_sg.yaml index b656d1800..2a2690550 100644 --- a/data/d&b_business_check_sg.yaml +++ b/data/d&b_business_check_sg.yaml @@ -34,7 +34,7 @@ paths: $ref: '#/components/schemas/REQUEST' responses: '200': - description: success response + description: Ok content: application/xml: schema: From ed6b14ddad25b1f2b4bf36c369c9f5fc9399bef3 Mon Sep 17 00:00:00 2001 From: rameshsentient <51635015+rameshsentient@users.noreply.github.com> Date: Mon, 8 Mar 2021 11:18:13 +0530 Subject: [PATCH 663/792] Update demographics_classification.yaml --- data/demographics_classification.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/data/demographics_classification.yaml b/data/demographics_classification.yaml index f55e83701..cfaee0eb1 100644 --- a/data/demographics_classification.yaml +++ b/data/demographics_classification.yaml @@ -21,7 +21,7 @@ paths: - v0.1.0 responses: '200': - description: success response + description: Ok content: application/json: schema: From a4cee7b96e533eded1c0585448ea6f6094f03417 Mon Sep 17 00:00:00 2001 From: rameshsentient <51635015+rameshsentient@users.noreply.github.com> Date: Mon, 8 Mar 2021 11:35:23 +0530 Subject: [PATCH 664/792] Delete demographics_classification.yaml --- data/demographics_classification.yaml | 293 -------------------------- 1 file changed, 293 deletions(-) delete mode 100644 data/demographics_classification.yaml diff --git a/data/demographics_classification.yaml b/data/demographics_classification.yaml deleted file mode 100644 index cfaee0eb1..000000000 --- a/data/demographics_classification.yaml +++ /dev/null @@ -1,293 +0,0 @@ -openapi: 3.0.1 -info: - title: Demographics Classification - description: |+ - This Computer Vision microservice detects for faces from an input image and predicts the demographics of each face (age, gender and race). The image is given as an input encoded using base64. The microservice will a face detector and subsequently models to predict age, gender and race. The results will then be returned back to the user as a JSON output together with bounding box coordinates for each face.Races include: Asian, Indian, White, Black, Middle Eastern and Latino Hispanic - The size of your image file should **not exceed 5 MB**, and the image dimension should be **at least 416x416 pixels**. - x-additionalinfo: |+ - Suggested Use Cases: - - This microservice can be used as a solution to help businesses better understand and connect with their customers, engage new prospects and increase revenue. For example, it can be used to improve visitor experience and optimize operations in retail, leisure, and other sectors by identifying the type of demogrpahic that frequents a certain place the most. It can also be used to create intelligent prospect lists that ensure one is always maximizing their marketing investment. - version: v0.1.0 - x-subscribelink: demographics_classification -servers: - - url: 'https://apis.sentient.io' -tags: -- name: "v0.1.0" - description: "Published Date - Dec 09, 2020" -paths: - /microservices/cv/democlass/v0/getpredictions: - post: - tags: - - v0.1.0 - responses: - '200': - description: Ok - content: - application/json: - schema: - $ref: '#/components/schemas/success' - example: - results: - persons: - - age: 33.21062944528088 - bbox: - bottom: 459 - left: 82 - right: 393 - top: 0 - gender: Man - race: white - - message: Successfully Processed - status: Success - '401': - description: Unauthorized - content: - application/json: - schema: - $ref: '#/components/schemas/unauthorized' - '402': - description: Payment Required - content: - application/json: - schema: - $ref: '#/components/schemas/paymentrequired' - '403': - description: Forbidden - content: - application/json: - schema: - $ref: '#/components/schemas/forbidden' - '404': - description: Not Found - content: - application/json: - schema: - $ref: '#/components/schemas/notfound' - '419': - description: Input Field Missing - content: - application/json: - schema: - $ref: '#/components/schemas/inputfieldmissing' - '413': - description: Payload Too Large - content: - application/json: - schema: - $ref: '#/components/schemas/inputlimitexceeded' - '415': - description: Unsupported Media Type - content: - application/json: - schema: - $ref: '#/components/schemas/invalidinput' - '500': - description: Internal Server error - content: - application/json: - schema: - $ref: '#/components/schemas/servererror' - '504': - description: Gateway Timeout - content: - application/json: - schema: - $ref: '#/components/schemas/gatewaytimeout' - security: - - APIAuthorizer: [] - - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/input' - required: true - - -components: - schemas: - success: - type: object - properties: - results: - type: object - description: The result of the API call. - example: { "" } - properties: - persons: - description: Demographic details of the detected person - example: - age: 33.21062944528088 - bbox: - bottom: 459 - left: 82 - right: 393 - top: 0 - gender: Man - race: white - items: - properties: - description: Demographic details of the detected person - example: ' ' - properties: - age: - description: Age of the detected person in the input image - example: 33.21062944528088 - type: float - bbox: - description: Bounding box of the detected person in the input image - example: ' ' - properties: - bottom: - description: Bottom coordinate of the box - example: 459 - type: integer - left: - description: Left coordinate of the box - example: 82 - type: integer - right: - description: Right coordinate of the box - example: 393 - type: integer - top: - description: Top coordinate of the box - example: 0 - type: integer - type: object - gender: - description: Gender of the detected person in the input image - example: Man - type: string - race: - description: Race of the detected person in the input image - example: white - type: string - type: object - type: object - type: array - - message: - type: string - example: Successfully Processed - description: Detail description on the API status - status: - type: string - example: Success - description: The status of the API call success/failure - - unauthorized: - type: object - properties: - message: - type: string - example: Missing Authentication Token - status: - type: string - example: Failure - forbidden: - type: object - properties: - message: - type: string - example: Access Denied Unauthorized User - status: - type: string - example: Failure - paymentrequired: - type: object - properties: - message: - type: string - example: Insufficient Credits Kindly Top Up - status: - type: string - example: Failure - notfound: - type: object - properties: - message: - type: string - example: Invalid Request - status: - type: string - example: Failure - servererror: - type: object - properties: - message: - type: string - example: Internal Server error - status: - type: string - example: Failure - gatewaytimeout: - type: object - properties: - message: - type: string - example: Request Timeout - status: - type: string - example: Failure - inputfieldmissing: - type: object - properties: - message: - type: string - example: Input Field Missing - status: - type: string - example: Failure - inputlimitexceeded: - type: object - properties: - message: - type: string - example: Input Limit Exceeded - status: - type: string - example: Failure - invalidinput: - type: object - properties: - message: - type: string - example: Invalid Input - status: - type: string - example: Failure - versions: - type: object - properties: - v0.1.0: - type: array - items: - oneOf: - - type: string - example: Published Date - Dec 09, 2020 - description: Initial version release - input: - type: object - required: - - - image_base64 - - properties: - image_base64: - x-name: image_base64 - type: string - default: True - example: /9j/4AAQSkZJRgABAQEASABIAAD/2wBDAAMCAgMCAgMDAwMEAwMEBQgFBQQEBQoHBwYIDAoMDAsKCwsNDhIQDQ4RDgsLEBYQERMUFRUVDA8XGBYUG... - description: |+ - Input image file in base64 format. - - - securitySchemes: - APIAuthorizer: - type: apiKey - name: x-api-key - in: header - x-amazon-apigateway-authtype: custom - description: Authentication is done using the x-api-key in the request header From 027c5ce9c46f26712212f0766961050315d15fd6 Mon Sep 17 00:00:00 2001 From: rameshsentient <51635015+rameshsentient@users.noreply.github.com> Date: Mon, 8 Mar 2021 11:40:08 +0530 Subject: [PATCH 665/792] Update demographics_hdb_sg.yaml --- data/demographics_hdb_sg.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/data/demographics_hdb_sg.yaml b/data/demographics_hdb_sg.yaml index 633459393..3cbc97636 100644 --- a/data/demographics_hdb_sg.yaml +++ b/data/demographics_hdb_sg.yaml @@ -131,7 +131,7 @@ paths: {"filter":[{"match":{"age_group_id":7}},{"match":{"gender":"male"}},{"match":{"postalcode":520423}}]} responses: '200': - description: success response + description: Ok content: application/json: schema: From 37b7adf057daea1df3533ed7d52affe5d7028732 Mon Sep 17 00:00:00 2001 From: rameshsentient <51635015+rameshsentient@users.noreply.github.com> Date: Mon, 8 Mar 2021 11:40:36 +0530 Subject: [PATCH 666/792] Update directory_of_singapore_startups.yaml --- data/directory_of_singapore_startups.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/data/directory_of_singapore_startups.yaml b/data/directory_of_singapore_startups.yaml index 79eabcca0..98936901e 100644 --- a/data/directory_of_singapore_startups.yaml +++ b/data/directory_of_singapore_startups.yaml @@ -129,7 +129,7 @@ paths: {"must":[{"match":{"name":"technology"}}],"filter":[{"exists":{"field":"company.e27"}}],"should":[{"match":{"status.e27":"active"}}],"must_not":[{"match":{"yearestablished.e27":"2016"}}]} responses: '200': - description: success response + description: Ok content: application/json: schema: From 2c455716b8e751d2d8399ac45b0e8cffeed72ef8 Mon Sep 17 00:00:00 2001 From: rameshsentient <51635015+rameshsentient@users.noreply.github.com> Date: Mon, 8 Mar 2021 11:41:09 +0530 Subject: [PATCH 667/792] Update fitness_stations_and_playgrounds_hdb_sg.yaml --- data/fitness_stations_and_playgrounds_hdb_sg.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/data/fitness_stations_and_playgrounds_hdb_sg.yaml b/data/fitness_stations_and_playgrounds_hdb_sg.yaml index d8b96e000..a08e62c8a 100644 --- a/data/fitness_stations_and_playgrounds_hdb_sg.yaml +++ b/data/fitness_stations_and_playgrounds_hdb_sg.yaml @@ -49,7 +49,7 @@ paths: - v0.1.0 responses: '200': - description: success response + description: Ok content: application/json: schema: From 9006f03844b7dbf12557645b1ae632d0254d1279 Mon Sep 17 00:00:00 2001 From: rameshsentient <51635015+rameshsentient@users.noreply.github.com> Date: Mon, 8 Mar 2021 11:41:35 +0530 Subject: [PATCH 668/792] Update flat_ownership_hdb_sg.yaml --- data/flat_ownership_hdb_sg.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/data/flat_ownership_hdb_sg.yaml b/data/flat_ownership_hdb_sg.yaml index 717738521..93f764f9e 100644 --- a/data/flat_ownership_hdb_sg.yaml +++ b/data/flat_ownership_hdb_sg.yaml @@ -137,7 +137,7 @@ paths: {"must":[{"match_phrase":{"street":"serangoon+central"}}],"filter":[{"match":{"postalcode":"550209"}}],"should":[{"range":{"no_of_units":{"gte":10}}}],"must_not":[{"match":{"len_of_ownership_id":"5"}}]} responses: '200': - description: success response + description: Ok content: application/json: schema: From 5c650db2014748cbc00bbe296a8065994f400f71 Mon Sep 17 00:00:00 2001 From: rameshsentient <51635015+rameshsentient@users.noreply.github.com> Date: Mon, 8 Mar 2021 11:41:57 +0530 Subject: [PATCH 669/792] Update lidar_trajectory_data.yaml --- data/lidar_trajectory_data.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/data/lidar_trajectory_data.yaml b/data/lidar_trajectory_data.yaml index 17edc3ccc..f3de0846d 100644 --- a/data/lidar_trajectory_data.yaml +++ b/data/lidar_trajectory_data.yaml @@ -130,7 +130,7 @@ paths: {"filter":[{"match":{"_id": "64406c95#64291"}},{"match":{"dataclass": "SD"}},{"match":{"detecttime": "2020-7-7T18:28:48.671Z"}}]} responses: '200': - description: success response + description: Ok content: application/json: schema: From e677436fc5fa9c719f6edea0a6f8ae26146d3946 Mon Sep 17 00:00:00 2001 From: rameshsentient <51635015+rameshsentient@users.noreply.github.com> Date: Mon, 8 Mar 2021 11:43:51 +0530 Subject: [PATCH 670/792] Update residential_sales_and_rental_hdb_sg.yaml --- data/residential_sales_and_rental_hdb_sg.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/data/residential_sales_and_rental_hdb_sg.yaml b/data/residential_sales_and_rental_hdb_sg.yaml index 2894d1aa0..f7e106a1d 100644 --- a/data/residential_sales_and_rental_hdb_sg.yaml +++ b/data/residential_sales_and_rental_hdb_sg.yaml @@ -138,7 +138,7 @@ paths: {"must":[{"match_phrase":{"street":"serangoon+central"}}],"filter":[{"range":{"year_completed":{"gte":1}}}],"should":[{"match":{"postalcode":"650633"}}],"must_not":[{"match":{"postalcode":"650634"}}]} responses: '200': - description: success response + description: Ok content: application/json: schema: From 6103b03087e7d045c0ed481011e1aa8eae2d4a3f Mon Sep 17 00:00:00 2001 From: rameshsentient <51635015+rameshsentient@users.noreply.github.com> Date: Mon, 8 Mar 2021 11:44:14 +0530 Subject: [PATCH 671/792] Update season_parking_availability_hdb_sg.yaml --- data/season_parking_availability_hdb_sg.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/data/season_parking_availability_hdb_sg.yaml b/data/season_parking_availability_hdb_sg.yaml index 80a6e7876..3bf6f3f0c 100644 --- a/data/season_parking_availability_hdb_sg.yaml +++ b/data/season_parking_availability_hdb_sg.yaml @@ -130,7 +130,7 @@ paths: {"must":[{"match_phrase":{"street":"serangoon north avenue 4"}}],"filter":[{"match":{"vehicle_type":"Y"}}],"should":[{"match":{"car_park_group":"G18"}}],"must_not":[{"match":{"postalcode":"550409"}}]} responses: '200': - description: success response + description: Ok content: application/json: schema: From 620b8d1ecb692f4c087c22e5c18412600df61c00 Mon Sep 17 00:00:00 2001 From: rameshsentient <51635015+rameshsentient@users.noreply.github.com> Date: Mon, 8 Mar 2021 11:58:38 +0530 Subject: [PATCH 672/792] Update urls_retrieval.yaml --- utility/urls_retrieval.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/utility/urls_retrieval.yaml b/utility/urls_retrieval.yaml index f6234ac63..2effeaad9 100644 --- a/utility/urls_retrieval.yaml +++ b/utility/urls_retrieval.yaml @@ -22,7 +22,7 @@ paths: - v0.2.1 responses: '200': - description: success response + description: Ok content: application/json: schema: From 7c1cf41919b6b0515a464be3922734e2ded3d9ce Mon Sep 17 00:00:00 2001 From: rameshsentient <51635015+rameshsentient@users.noreply.github.com> Date: Mon, 8 Mar 2021 12:47:00 +0530 Subject: [PATCH 673/792] Update inverse_text_normalisation_eng.yaml --- nlp/inverse_text_normalisation_eng.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/nlp/inverse_text_normalisation_eng.yaml b/nlp/inverse_text_normalisation_eng.yaml index 46d57cad2..6450b75e6 100644 --- a/nlp/inverse_text_normalisation_eng.yaml +++ b/nlp/inverse_text_normalisation_eng.yaml @@ -24,7 +24,7 @@ paths: - v0.1.0 responses: '200': - description: success response + description: Ok content: application/json: schema: From 8ec545a108fc8da24b98390b5fae5db28205731a Mon Sep 17 00:00:00 2001 From: rameshsentient <51635015+rameshsentient@users.noreply.github.com> Date: Mon, 8 Mar 2021 12:49:12 +0530 Subject: [PATCH 674/792] Update inverse_text_normalisation_eng.yaml --- nlp/inverse_text_normalisation_eng.yaml | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/nlp/inverse_text_normalisation_eng.yaml b/nlp/inverse_text_normalisation_eng.yaml index 6450b75e6..e9ab0f23e 100644 --- a/nlp/inverse_text_normalisation_eng.yaml +++ b/nlp/inverse_text_normalisation_eng.yaml @@ -72,13 +72,13 @@ paths: schema: $ref: '#/components/schemas/inputfieldmissing' '413': - description: Input Limit Exceeded + description: Payload Too Large content: application/json: schema: - $ref: '#/components/schemas/inputlimitexceeded' + $ref: '#/components/schemas/inputlimitexceeded' '415': - description: Invalid Input + description: Unsupported Media Type content: application/json: schema: From 2c4e8655eaf59409a5fe94ea02844fa48a3b3118 Mon Sep 17 00:00:00 2001 From: rameshsentient <51635015+rameshsentient@users.noreply.github.com> Date: Mon, 8 Mar 2021 14:07:55 +0530 Subject: [PATCH 675/792] Update index.yaml --- index.yaml | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/index.yaml b/index.yaml index 4ee193ab4..9da3af04f 100644 --- a/index.yaml +++ b/index.yaml @@ -57,18 +57,18 @@ voice: voice_activity_detection_eng: title: Voice Activity Detection ENG versions: - 1.1.0: 'voice_activity_detection_eng_v1.0.yaml' + 1.0.0: 'voice_activity_detection_eng_v1.0.yaml' 0.1.0: 'voice_activity_detection_eng.yaml' nlp: inverse_text_normalisation_eng: title: Inverse Text Normalisation ENG versions: - 1.1.0: 'inverse_text_normalisation_eng_v1.0.yaml' + 1.0.0: 'inverse_text_normalisation_eng_v1.0.yaml' 0.1.0: 'inverse_text_normalisation_eng.yaml' named-entity_recognition_eng: title: Named-Entity Recognition ENG versions: - 1.1.0: 'named-entity_recognition_eng_v1.0.yaml' + 1.0.0: 'named-entity_recognition_eng_v1.0.yaml' 0.1.0: 'named-entity_recognition_eng.yaml' spacy_ner: title: spaCy NER From 4d4f8808cdd583f5eda39109e601520c0152cb03 Mon Sep 17 00:00:00 2001 From: Mohamed Luqman <57977684+mohamedSent@users.noreply.github.com> Date: Tue, 9 Mar 2021 10:29:09 +0530 Subject: [PATCH 676/792] updated data --- data/d&b_basic_individual_search_sg.yaml | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/data/d&b_basic_individual_search_sg.yaml b/data/d&b_basic_individual_search_sg.yaml index ab22c3fad..a44286ba8 100644 --- a/data/d&b_basic_individual_search_sg.yaml +++ b/data/d&b_basic_individual_search_sg.yaml @@ -11,15 +11,15 @@ info: version: '0.1.0' x-subscribelink: d&b_basic_individual_search_sg servers: - - url: 'https://api.sentient.io' + - url: 'https://dev-apis.sentient.io' tags: - name: "v0.1.0" description: "Published Date - Aug 15, 2019" paths: - /dnb/prod/sbis: + /microservices/data/sbis/v0/getdata: post: tags: - - v0.1.0 + - v0 summary: Adds a new user requestBody: content: From c4e5e7168075bd9fc7e5b7da891a0c8b8fd3fb85 Mon Sep 17 00:00:00 2001 From: Mohamed Luqman <57977684+mohamedSent@users.noreply.github.com> Date: Tue, 9 Mar 2021 10:36:01 +0530 Subject: [PATCH 677/792] Update d&b_basic_individual_search_sg.yaml --- data/d&b_basic_individual_search_sg.yaml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/data/d&b_basic_individual_search_sg.yaml b/data/d&b_basic_individual_search_sg.yaml index a44286ba8..d651d38ef 100644 --- a/data/d&b_basic_individual_search_sg.yaml +++ b/data/d&b_basic_individual_search_sg.yaml @@ -23,14 +23,14 @@ paths: summary: Adds a new user requestBody: content: - application/xml: + application/json: schema: $ref: '#/components/schemas/REQUEST' responses: '200': description: Ok content: - application/xml: + application/json: schema: $ref: '#/components/schemas/success' example: |+ From 2fe58daf163f93c4b35333157717478d26614b13 Mon Sep 17 00:00:00 2001 From: Mohamed Luqman <57977684+mohamedSent@users.noreply.github.com> Date: Tue, 9 Mar 2021 10:48:58 +0530 Subject: [PATCH 678/792] updated apiendpoints --- data/d&b_brief_financial_information_sg.yaml | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/data/d&b_brief_financial_information_sg.yaml b/data/d&b_brief_financial_information_sg.yaml index a1ef22f9a..1a446842d 100644 --- a/data/d&b_brief_financial_information_sg.yaml +++ b/data/d&b_brief_financial_information_sg.yaml @@ -10,15 +10,15 @@ info: version: '0.1.0' x-subscribelink: d&b_brief_financial_information_sg servers: - - url: 'https://api.sentient.io' + - url: 'https://dev-apis.sentient.io' tags: - name: "v0.1.0" description: "Published Date - Aug 15, 2019" paths: - /dnb/prod/sbfe: + /microservices/data/sbfe/v0/getdata: post: tags: - - v0.1.0 + - v0 summary: Adds a new user requestBody: content: From 1356dfea966329c0c8bfe7a27f7eaa95a63c4659 Mon Sep 17 00:00:00 2001 From: Mohamed Luqman <57977684+mohamedSent@users.noreply.github.com> Date: Tue, 9 Mar 2021 10:51:41 +0530 Subject: [PATCH 679/792] updated apiendpoints --- data/d&b_business_check_plus_sg.yaml | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/data/d&b_business_check_plus_sg.yaml b/data/d&b_business_check_plus_sg.yaml index 5c4e5977b..d94713cd9 100644 --- a/data/d&b_business_check_plus_sg.yaml +++ b/data/d&b_business_check_plus_sg.yaml @@ -10,15 +10,15 @@ info: version: '0.1.0' x-subscribelink: d&b_business_check_plus_sg servers: - - url: 'https://api.sentient.io' + - url: 'https://dev-apis.sentient.io' tags: - name: "v0.1.0" description: "Published Date - Aug 15, 2019" paths: - /dnb/prod/sbcp: + /microservices/data/sbcp/v0/getdata: post: tags: - - v0.1.0 + - v0 summary: Adds a new user requestBody: content: From c08c36556737082d0bcaa36766da11dd4f87dcc7 Mon Sep 17 00:00:00 2001 From: rameshsentient <51635015+rameshsentient@users.noreply.github.com> Date: Thu, 11 Mar 2021 11:48:27 +0530 Subject: [PATCH 680/792] Update automatic_speech_recognition_eng_sg_v1.0.yaml --- voice/automatic_speech_recognition_eng_sg_v1.0.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/voice/automatic_speech_recognition_eng_sg_v1.0.yaml b/voice/automatic_speech_recognition_eng_sg_v1.0.yaml index 8cfe881ab..13b23116f 100644 --- a/voice/automatic_speech_recognition_eng_sg_v1.0.yaml +++ b/voice/automatic_speech_recognition_eng_sg_v1.0.yaml @@ -13,7 +13,7 @@ info: - Combine this with the Text-to-Speech API to deliver voice-enabled experiences in IoT (Internet of Things) applications, such as implementing voice commands. x-subscribelink: automatic_speech_recognition_eng_sg servers: - - url: 'https://dev-apis.sentient.io' + - url: 'https://apis.sentient.io' tags: - name: "v1.1.0" description: "Published Date - Jan 22, 2021" From 9936b305e2e70393e3d99bb57180c79c543cd6fb Mon Sep 17 00:00:00 2001 From: rameshsentient <51635015+rameshsentient@users.noreply.github.com> Date: Thu, 11 Mar 2021 17:41:31 +0530 Subject: [PATCH 681/792] Create automatic_speech_recognition_chi_sg_V1.0.yaml --- ...omatic_speech_recognition_chi_sg_V1.0.yaml | 262 ++++++++++++++++++ 1 file changed, 262 insertions(+) create mode 100644 voice/automatic_speech_recognition_chi_sg_V1.0.yaml diff --git a/voice/automatic_speech_recognition_chi_sg_V1.0.yaml b/voice/automatic_speech_recognition_chi_sg_V1.0.yaml new file mode 100644 index 000000000..2bf0e0cdb --- /dev/null +++ b/voice/automatic_speech_recognition_chi_sg_V1.0.yaml @@ -0,0 +1,262 @@ +openapi: 3.0.1 +info: + title: Automatic Speech Recognition CHI (SG) + description: |+ + This Voice microservice takes in the input audio file (in WAV format at 16kHz) and transcribes Mandarin speech content within the input file into text. + + This microservice works best when the audio file consists of mostly speech with no long pauses in between. + The length of your audio should be **upto 20 seconds**. + x-additionalinfo: |+ + Suggested Use Cases: + - Extraction of text from voice ( from sound files), especially with Singaporean accented Mandarin. + + - Extraction of text from video, especially with Singaporean accented Mandarin. + + - Improve customer service - empower a customer service system by adding IVR (interactive voice response) and agent conversations to call centers. Perform analytics on conversation data to gain more insights into the calls and customers. + + - Enable voice control services - e.g. implement voice commands such as “turn the volume up,” and voice search such as saying “what is the temperature in Paris?” + + - Transcribe multimedia content - transcribe audio and video to include captions and improve audience reach and experience. For example, this microservice can be used for indexing or subtitling video and/or multispeaker content; similar to video captioning on YouTube. + version: '1.0.0' + x-subscribelink: automatic_speech_recognition_chi_sg +servers: + - url: 'https://dev-apis.sentient.io' +tags: +- name: "v1.0.0" + description: "Published Date - Mar 30, 2021" +paths: + /microservices/voice/asrsch/v1/getpredictions: + post: + tags: + - v1.0.0 + responses: + '200': + description: Ok + content: + application/json: + schema: + $ref: '#/components/schemas/success' + example: + message: Successfully Processed + status: Success + results: + output: " 和 许诺 的 含着 那 主力 候补 含住 探测 好的 海里 的 非礼\n" + '401': + description: Unauthorized + content: + application/json: + schema: + $ref: '#/components/schemas/unauthorized' + '402': + description: Payment Required + content: + application/json: + schema: + $ref: '#/components/schemas/paymentrequired' + '403': + description: Forbidden + content: + application/json: + schema: + $ref: '#/components/schemas/forbidden' + '404': + description: Not Found + content: + application/json: + schema: + $ref: '#/components/schemas/notfound' + '419': + description: Input Field Missing + content: + application/json: + schema: + $ref: '#/components/schemas/inputfieldmissing' + '413': + description: Payload Too Large + content: + application/json: + schema: + $ref: '#/components/schemas/inputlimitexceeded' + '415': + description: Unsupported Media Type + content: + application/json: + schema: + $ref: '#/components/schemas/invalidinput' + '500': + description: Internal Server Error + content: + application/json: + schema: + $ref: '#/components/schemas/servererror' + '504': + description: Gateway Timeout + content: + application/json: + schema: + $ref: '#/components/schemas/gatewaytimeout' + security: + - APIAuthorizer: [] + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/input' + required: true +components: + schemas: + success: + type: object + properties: + results: + type: object + description: output object + properties: + output: + type: string + example: 各位同学朋友老师教授大家好我叫墓园 + description: converted text + status: + type: string + example: Success + description: The status of the API call success/failure + message: + type: string + example: Successfully Processed + description: Status Message + unauthorized: + type: object + properties: + message: + type: string + example: Missing Authentication Token + status: + type: string + example: Failure + forbidden: + type: object + properties: + message: + type: string + example: Access Denied Unauthorized User + status: + type: string + example: Failure + paymentrequired: + type: object + properties: + message: + type: string + example: Insufficient Credits Kindly Top Up + status: + type: string + example: Failure + notfound: + type: object + properties: + message: + type: string + example: Invalid Request URL + status: + type: string + example: Failure + servererror: + type: object + properties: + message: + type: string + example: Internal Server Error + status: + type: string + example: Failure + gatewaytimeout: + type: object + properties: + message: + type: string + example: Request Timeout + status: + type: string + example: Failure + inputfieldmissing: + type: object + properties: + message: + type: string + example: Input Field Missing + status: + type: string + example: Failure + inputlimitexceeded: + type: object + properties: + message: + type: string + example: Input Limit Exceeded + status: + type: string + example: Failure + invalidinput: + type: object + properties: + message: + type: string + example: Invalid Input + status: + type: string + example: Failure + input: + type: object + required: + - audio + properties: + wav_base64: + x-name: audio + type: string + default: true + example: UklGRkbiBABXQVZFZm10IBAAAAABA... + description: |+ + Input audio file in base64 format. + + Input file needs to be prefixed by the data type and encoding. + + + language: + x-name: language + type: string + default: true + example: 1 + description: |+ + Language setting: + 1 Mandarin + versions: + type: object + properties: + v1.0.0: + type: array + items: + oneOf: + - type: string + example: Published Date - Mar 30, 2021 + description: Standardizing Input and Output Updated. + v0.1.1: + type: array + items: + oneOf: + - type: string + example: Published Date - Sep 28,2018 + description: Patch update on bug fixes + v0.1.0: + type: array + items: + oneOf: + - type: string + example: Published Date - Jun 21,2018 + description: Initial version release + securitySchemes: + APIAuthorizer: + type: apiKey + name: x-api-key + in: header + x-amazon-apigateway-authtype: custom + description: Authentication is done using the x-api-key in the request header From cd684427a2c7344d59e879b186991e203800ddc9 Mon Sep 17 00:00:00 2001 From: rameshsentient <51635015+rameshsentient@users.noreply.github.com> Date: Thu, 11 Mar 2021 17:43:00 +0530 Subject: [PATCH 682/792] Update index.yaml --- index.yaml | 1 + 1 file changed, 1 insertion(+) diff --git a/index.yaml b/index.yaml index 9da3af04f..ec31243ef 100644 --- a/index.yaml +++ b/index.yaml @@ -32,6 +32,7 @@ voice: automatic_speech_recognition_chi_sg: title: Automatic Speech Recognition CHI (SG) versions: + 1.0.0: 'automatic_speech_recognition_chi_sg_V1.0.yaml' 0.1.0: 'automatic_speech_recognition_chi_sg.yaml' online_automatic_speech_recognition_eng_sg: title: Online Automatic Speech Recognition ENG (SG) From 19870297196a06a5a1329a23b4ab8e94b0446fe8 Mon Sep 17 00:00:00 2001 From: rameshsentient <51635015+rameshsentient@users.noreply.github.com> Date: Thu, 11 Mar 2021 17:44:04 +0530 Subject: [PATCH 683/792] Update automatic_speech_recognition_chi_sg_V1.0.yaml --- voice/automatic_speech_recognition_chi_sg_V1.0.yaml | 12 ++---------- 1 file changed, 2 insertions(+), 10 deletions(-) diff --git a/voice/automatic_speech_recognition_chi_sg_V1.0.yaml b/voice/automatic_speech_recognition_chi_sg_V1.0.yaml index 2bf0e0cdb..de68d5b7f 100644 --- a/voice/automatic_speech_recognition_chi_sg_V1.0.yaml +++ b/voice/automatic_speech_recognition_chi_sg_V1.0.yaml @@ -208,10 +208,10 @@ components: input: type: object required: - - audio + - wav_base64 properties: wav_base64: - x-name: audio + x-name: wav_base64 type: string default: true example: UklGRkbiBABXQVZFZm10IBAAAAABA... @@ -221,14 +221,6 @@ components: Input file needs to be prefixed by the data type and encoding. - language: - x-name: language - type: string - default: true - example: 1 - description: |+ - Language setting: - 1 Mandarin versions: type: object properties: From 4ea67cd034b389d13ca001e2645b69cbd34766e4 Mon Sep 17 00:00:00 2001 From: Mohamed Luqman <57977684+mohamedSent@users.noreply.github.com> Date: Fri, 12 Mar 2021 12:49:55 +0530 Subject: [PATCH 684/792] updated path --- data/d&b_business_check_sg.yaml | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/data/d&b_business_check_sg.yaml b/data/d&b_business_check_sg.yaml index 2a2690550..6baadf757 100644 --- a/data/d&b_business_check_sg.yaml +++ b/data/d&b_business_check_sg.yaml @@ -17,26 +17,26 @@ info: version: '0.1.0' x-subscribelink: d&b_business_check_sg servers: - - url: 'https://api.sentient.io' + - url: 'https://dev-apis.sentient.io' tags: - name: "v0.1.0" description: "Published Date - Aug 15, 2019" paths: - /dnb/prod/sbc: + /microservices/data/sbc/v0/getdata: post: tags: - - v0.1.0 + - v0 summary: Adds a new user requestBody: content: - application/xml: + application/json: schema: $ref: '#/components/schemas/REQUEST' responses: '200': description: Ok content: - application/xml: + application/json: schema: $ref: '#/components/schemas/success' example: |+ From b51fa9e958b9845085ab6b8a9c9886bf0f1518a9 Mon Sep 17 00:00:00 2001 From: Mohamed Luqman <57977684+mohamedSent@users.noreply.github.com> Date: Fri, 12 Mar 2021 15:07:49 +0530 Subject: [PATCH 685/792] updated response --- data/d&b_business_check_sg.yaml | 56 ++++++++++++++++++++++++++++++--- 1 file changed, 51 insertions(+), 5 deletions(-) diff --git a/data/d&b_business_check_sg.yaml b/data/d&b_business_check_sg.yaml index 6baadf757..b8092e93c 100644 --- a/data/d&b_business_check_sg.yaml +++ b/data/d&b_business_check_sg.yaml @@ -40,11 +40,57 @@ paths: schema: $ref: '#/components/schemas/success' example: |+ - string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string 0
string
- - string string string string string string string string string string string string string
string
- - string string string string string string string string string string string string string string string + results: + REPORT: + LIST_BIZ_BRANCH: + @className: "String" + LIST_Ddrptcount: + @className: "String" + Ddrptcount: "Array" + Rcapr: + #text: 0 + @type: "Integer" + Rcaug: + #text: 0 + @type: "Integer" + Rcdec: + #text: 0 + @type: "Integer" + Rcfeb: + #text: 0 + @type: "Integer" + Rcjan: + #text: 0 + @type: "Integer" + Rcjul: + #text: 0 + @type: "Integer" + Rcjun: + #text: 0 + @type: "Integer" + Rcmar: + #text: 0 + @type: "Integer" + Rcmay: + #text: 0 + @type: "Integer" + Rcnov: + #text: 0 + @type: "Integer" + Rcoct: + #text: 0 + @type: "Integer" + Rcsecflag: + #text: 0 + @type: "Integer" + Rcsep: + #text: 0 + @type: "Integer" + Rcyear: + #text: "2020" + @type: "String" + message: Successfully Processed + status: Success '401': description: Unauthorized content: From 587fbf5f80126c4ba932f3fb6969b0459fc27ab2 Mon Sep 17 00:00:00 2001 From: Mohamed Luqman <57977684+mohamedSent@users.noreply.github.com> Date: Fri, 12 Mar 2021 15:10:45 +0530 Subject: [PATCH 686/792] updated response2 --- data/d&b_business_check_sg.yaml | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/data/d&b_business_check_sg.yaml b/data/d&b_business_check_sg.yaml index b8092e93c..4dc08598d 100644 --- a/data/d&b_business_check_sg.yaml +++ b/data/d&b_business_check_sg.yaml @@ -42,12 +42,12 @@ paths: example: |+ results: REPORT: - LIST_BIZ_BRANCH: - @className: "String" - LIST_Ddrptcount: - @className: "String" - Ddrptcount: "Array" - Rcapr: + LIST_BIZ_BRANCH: + @className: "String" + LIST_Ddrptcount: + @className: "String" + Ddrptcount: "Array" + Rcapr: #text: 0 @type: "Integer" Rcaug: @@ -90,7 +90,7 @@ paths: #text: "2020" @type: "String" message: Successfully Processed - status: Success + status: Success '401': description: Unauthorized content: From 18cdda6bbc24cd548b56d8c39679a18a697a93b4 Mon Sep 17 00:00:00 2001 From: Mohamed Luqman <57977684+mohamedSent@users.noreply.github.com> Date: Fri, 12 Mar 2021 15:20:00 +0530 Subject: [PATCH 687/792] Update d&b_business_check_sg.yaml --- data/d&b_business_check_sg.yaml | 61 +++------------------------------ 1 file changed, 5 insertions(+), 56 deletions(-) diff --git a/data/d&b_business_check_sg.yaml b/data/d&b_business_check_sg.yaml index 4dc08598d..2ad44dc82 100644 --- a/data/d&b_business_check_sg.yaml +++ b/data/d&b_business_check_sg.yaml @@ -6,13 +6,9 @@ info: x-additionalinfo: |+ Suggested Use Cases: - For software solutions that require general background checks of a company. This microservice can provide a high level of scrutiny of potential business associates, and throw light on the risks that cannot be detected by geopolitical analysis or batch screening levels. - - For example, this microservice can be used to check if a Singapore-registered company meets regulations, such as if the company complies with anti-money laundering, anti-bribery, and corruption regulations by looking at registered activities, shareholders details, and more. - - It can also be used to simplify the due diligence process, by identify risk issues using a range of reports that meet different compliance requirements. - - - It can also be used to protect your business – safeguard against reputational risk by avoiding those involved in financial crime. - + - It can also be used to protect your business – safeguard against reputational risk by avoiding those involved in financial crime. - It can also be used for finance-related domains such as vehicle leasing, loans, enterprise credit terms and so on. Updated daily. version: '0.1.0' x-subscribelink: d&b_business_check_sg @@ -40,57 +36,10 @@ paths: schema: $ref: '#/components/schemas/success' example: |+ - results: - REPORT: - LIST_BIZ_BRANCH: - @className: "String" - LIST_Ddrptcount: - @className: "String" - Ddrptcount: "Array" - Rcapr: - #text: 0 - @type: "Integer" - Rcaug: - #text: 0 - @type: "Integer" - Rcdec: - #text: 0 - @type: "Integer" - Rcfeb: - #text: 0 - @type: "Integer" - Rcjan: - #text: 0 - @type: "Integer" - Rcjul: - #text: 0 - @type: "Integer" - Rcjun: - #text: 0 - @type: "Integer" - Rcmar: - #text: 0 - @type: "Integer" - Rcmay: - #text: 0 - @type: "Integer" - Rcnov: - #text: 0 - @type: "Integer" - Rcoct: - #text: 0 - @type: "Integer" - Rcsecflag: - #text: 0 - @type: "Integer" - Rcsep: - #text: 0 - @type: "Integer" - Rcyear: - #text: "2020" - @type: "String" - message: Successfully Processed - status: Success + string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string 0
string
+ string string string string string string string string string string string string string
string
+ + string string string string string string string string string string string string string string string '401': description: Unauthorized content: From 2bf824fa04171d20738e40bbfa455e551889a82f Mon Sep 17 00:00:00 2001 From: Mohamed Luqman <57977684+mohamedSent@users.noreply.github.com> Date: Fri, 12 Mar 2021 16:14:23 +0530 Subject: [PATCH 688/792] Update d&b_business_check_sg.yaml --- data/d&b_business_check_sg.yaml | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/data/d&b_business_check_sg.yaml b/data/d&b_business_check_sg.yaml index 2ad44dc82..20d65d092 100644 --- a/data/d&b_business_check_sg.yaml +++ b/data/d&b_business_check_sg.yaml @@ -27,7 +27,9 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/REQUEST' + $ref: '#/components/schemas/REQUEST' + example: |+ + {"total_items" : 10,"subject_idno":197803191, "subject_name":"GPSe"} responses: '200': description: Ok From 0dd2e46c4b07d6c7014479f10e61e34ada2e7116 Mon Sep 17 00:00:00 2001 From: Mohamed Luqman <57977684+mohamedSent@users.noreply.github.com> Date: Fri, 12 Mar 2021 16:23:45 +0530 Subject: [PATCH 689/792] Update d&b_business_check_sg.yaml --- data/d&b_business_check_sg.yaml | 6 ++---- 1 file changed, 2 insertions(+), 4 deletions(-) diff --git a/data/d&b_business_check_sg.yaml b/data/d&b_business_check_sg.yaml index 20d65d092..608e40184 100644 --- a/data/d&b_business_check_sg.yaml +++ b/data/d&b_business_check_sg.yaml @@ -38,10 +38,8 @@ paths: schema: $ref: '#/components/schemas/success' example: |+ - string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string 0
string
- string string string string string string string string string string string string string
string
- - string string string string string string string string string string string string string string string + string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string 0
string
+ string string string string string string string string string string string string string
string
string string string string string string string string string string string string string string string '401': description: Unauthorized content: From 7830f22a7ed7289928c294dea766527130dfd069 Mon Sep 17 00:00:00 2001 From: Mohamed Luqman <57977684+mohamedSent@users.noreply.github.com> Date: Fri, 12 Mar 2021 16:26:25 +0530 Subject: [PATCH 690/792] Update d&b_business_check_sg.yaml --- data/d&b_business_check_sg.yaml | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/data/d&b_business_check_sg.yaml b/data/d&b_business_check_sg.yaml index 608e40184..95cf83971 100644 --- a/data/d&b_business_check_sg.yaml +++ b/data/d&b_business_check_sg.yaml @@ -38,8 +38,7 @@ paths: schema: $ref: '#/components/schemas/success' example: |+ - string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string 0
string
- string string string string string string string string string string string string string
string
string string string string string string string string string string string string string string string + string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string 0
string
string string string string string string string string string string string string string
string
string string string string string string string string string string string string string string string '401': description: Unauthorized content: From c6a1a604cc1178ed9a25f7fc54b914310521a69d Mon Sep 17 00:00:00 2001 From: Mohamed Luqman <57977684+mohamedSent@users.noreply.github.com> Date: Fri, 12 Mar 2021 16:40:41 +0530 Subject: [PATCH 691/792] Update d&b_business_check_sg.yaml --- data/d&b_business_check_sg.yaml | 52 ++++++++++++++++++++++++++++++++- 1 file changed, 51 insertions(+), 1 deletion(-) diff --git a/data/d&b_business_check_sg.yaml b/data/d&b_business_check_sg.yaml index 95cf83971..4c8ee2976 100644 --- a/data/d&b_business_check_sg.yaml +++ b/data/d&b_business_check_sg.yaml @@ -38,7 +38,57 @@ paths: schema: $ref: '#/components/schemas/success' example: |+ - string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string 0
string
string string string string string string string string string string string string string
string
string string string string string string string string string string string string string string string + message: Successfully Processed + status: Success + results: + REPORT: + LIST_BIZ_BRANCH: + "@className": String + LIST_Ddrptcount: + "@className": String + Ddrptcount: + - Rcapr: + "#text": '0' + "@type": Integer + Rcaug: + "#text": '0' + "@type": Integer + Rcdec: + "#text": '0' + "@type": Integer + Rcfeb: + "#text": '0' + "@type": Integer + Rcjan: + "#text": '0' + "@type": Integer + Rcjul: + "#text": '6' + "@type": Integer + Rcjun: + "#text": '0' + "@type": Integer + Rcmar: + "#text": '0' + "@type": Integer + Rcmay: + "#text": '0' + "@type": Integer + Rcnov: + "#text": '0' + "@type": Integer + Rcoct: + "#text": '0' + "@type": Integer + Rcsecflag: + "#text": '0' + "@type": Integer + Rcsep: + "#text": '0' + "@type": Integer + Rcyear: + "#text": '2020' + "@type": String '401': description: Unauthorized content: From af8cf19979a96084bb9b6b1a1f45ba8c3b9d7145 Mon Sep 17 00:00:00 2001 From: rameshsentient <51635015+rameshsentient@users.noreply.github.com> Date: Fri, 12 Mar 2021 17:02:31 +0530 Subject: [PATCH 692/792] Update index.yaml --- index.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/index.yaml b/index.yaml index ec31243ef..d19c95c88 100644 --- a/index.yaml +++ b/index.yaml @@ -33,7 +33,7 @@ voice: title: Automatic Speech Recognition CHI (SG) versions: 1.0.0: 'automatic_speech_recognition_chi_sg_V1.0.yaml' - 0.1.0: 'automatic_speech_recognition_chi_sg.yaml' + 0.1.1: 'automatic_speech_recognition_chi_sg.yaml' online_automatic_speech_recognition_eng_sg: title: Online Automatic Speech Recognition ENG (SG) versions: From 0b9a318e906aba113d33b114064e4a716ea94d60 Mon Sep 17 00:00:00 2001 From: Mohamed Luqman <57977684+mohamedSent@users.noreply.github.com> Date: Mon, 15 Mar 2021 10:00:39 +0530 Subject: [PATCH 693/792] Update d&b_business_check_sg.yaml --- data/d&b_business_check_sg.yaml | 28 +++++++++++----------------- 1 file changed, 11 insertions(+), 17 deletions(-) diff --git a/data/d&b_business_check_sg.yaml b/data/d&b_business_check_sg.yaml index 4c8ee2976..12cd8f70f 100644 --- a/data/d&b_business_check_sg.yaml +++ b/data/d&b_business_check_sg.yaml @@ -1152,28 +1152,22 @@ components: REQUEST: type: object properties: - TOT_ITEMS: + total_items: type: number example: 1 description: Number of subjects being enquired relating to the Run default: false - ENQUIRY: - type: object - example: |+ - 197601887ETRANSTAR TRAVEL PTE LTD - description: Contains information of each request details + properties: + subject_idno: + type: string + example: 199707714C + description: "Subject’s ID Number (individual) or Registration Number (company/business) as captured in DDP" default: true - properties: - SUBJECT_IDNO: - type: string - example: 199707714C - description: "Subject’s ID Number (individual) or Registration Number (company/business) as captured in DDP" - default: true - SUBJECT_NAME: - type: string - example: GPS INDUSTRIES PTE LTD - description: Subjects Name as captured in DDP - default: false + subject_name: + type: string + example: GPS INDUSTRIES PTE LTD + description: Subjects Name as captured in DDP + default: false versions: type: object properties: From 1a9eab8f4aa7d76838ef1750553320ea19b39e0d Mon Sep 17 00:00:00 2001 From: Mohamed Luqman <57977684+mohamedSent@users.noreply.github.com> Date: Mon, 15 Mar 2021 10:01:09 +0530 Subject: [PATCH 694/792] Update d&b_business_check_sg.yaml --- data/d&b_business_check_sg.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/data/d&b_business_check_sg.yaml b/data/d&b_business_check_sg.yaml index 12cd8f70f..6a94bc15d 100644 --- a/data/d&b_business_check_sg.yaml +++ b/data/d&b_business_check_sg.yaml @@ -29,7 +29,7 @@ paths: schema: $ref: '#/components/schemas/REQUEST' example: |+ - {"total_items" : 10,"subject_idno":197803191, "subject_name":"GPSe"} + {"total_items" : 10,"subject_idno":"199707714C", "subject_name":"GPS INDUSTRIES PTE LTD"} responses: '200': description: Ok From e8c1570fe511d2faff08336c584b5b1c22c30b3c Mon Sep 17 00:00:00 2001 From: Mohamed Luqman <57977684+mohamedSent@users.noreply.github.com> Date: Mon, 15 Mar 2021 10:16:30 +0530 Subject: [PATCH 695/792] Update d&b_business_check_sg.yaml --- data/d&b_business_check_sg.yaml | 83 ++++++++++++++++++--------------- 1 file changed, 46 insertions(+), 37 deletions(-) diff --git a/data/d&b_business_check_sg.yaml b/data/d&b_business_check_sg.yaml index 6a94bc15d..f565afedc 100644 --- a/data/d&b_business_check_sg.yaml +++ b/data/d&b_business_check_sg.yaml @@ -43,52 +43,52 @@ paths: results: REPORT: LIST_BIZ_BRANCH: - "@className": String + @className: String LIST_Ddrptcount: - "@className": String + @className: String Ddrptcount: - Rcapr: - "#text": '0' - "@type": Integer + #text: 0 + @type: Integer Rcaug: - "#text": '0' - "@type": Integer + #text: 0 + @type: Integer Rcdec: - "#text": '0' - "@type": Integer + #text: 0 + @type: Integer Rcfeb: - "#text": '0' - "@type": Integer + #text: 0 + @type: Integer Rcjan: - "#text": '0' - "@type": Integer + #text: 0 + @type: Integer Rcjul: - "#text": '6' - "@type": Integer + #text: 6 + @type: Integer Rcjun: - "#text": '0' - "@type": Integer + #text: 0 + @type: Integer Rcmar: - "#text": '0' - "@type": Integer + #text: 0 + @type: Integer Rcmay: - "#text": '0' - "@type": Integer + #text: 0 + @type: Integer Rcnov: - "#text": '0' - "@type": Integer + #text: 0 + @type: Integer Rcoct: - "#text": '0' - "@type": Integer + #text: 0 + @type: Integer Rcsecflag: - "#text": '0' - "@type": Integer + #text: 0 + @type: Integer Rcsep: - "#text": '0' - "@type": Integer + #text: 0 + @type: Integer Rcyear: - "#text": '2020' - "@type": String + #text: '2020' + @type: String '401': description: Unauthorized content: @@ -172,13 +172,22 @@ components: META_INFO: type: object example: |+ - - - - - - - + META_INFO: + CLASS: + #text: "class com.technodex.ddp.xmlbean.MetaBean" + @type: String + CREATION_DATE: + #text: "Tue Sep 24 20:25:56 SGT 2019" + @type: Date + SERVICE: + #text: "BC" + @type: String + SYSTEM_ID: + #text: "DDP" + @type: String + USER_ID: + #text: "B2BSENTIENT" + @type: String description: |+ Meta Information details with following children: SERVICE From 9838d952f10fa320fd22a8b443b9bcc885615304 Mon Sep 17 00:00:00 2001 From: Mohamed Luqman <57977684+mohamedSent@users.noreply.github.com> Date: Mon, 15 Mar 2021 11:33:53 +0530 Subject: [PATCH 696/792] Update d&b_business_check_sg.yaml --- data/d&b_business_check_sg.yaml | 121 +++++++++++++++++++++----------- 1 file changed, 80 insertions(+), 41 deletions(-) diff --git a/data/d&b_business_check_sg.yaml b/data/d&b_business_check_sg.yaml index f565afedc..1a927d988 100644 --- a/data/d&b_business_check_sg.yaml +++ b/data/d&b_business_check_sg.yaml @@ -29,7 +29,7 @@ paths: schema: $ref: '#/components/schemas/REQUEST' example: |+ - {"total_items" : 10,"subject_idno":"199707714C", "subject_name":"GPS INDUSTRIES PTE LTD"} + {"total_items" : 1,"subject_idno":"199707714C", "subject_name":"GPS INDUSTRIES PTE LTD"} responses: '200': description: Ok @@ -186,7 +186,7 @@ components: #text: "DDP" @type: String USER_ID: - #text: "B2BSENTIENT" + #text: "AAA" @type: String description: |+ Meta Information details with following children: @@ -205,9 +205,9 @@ components: description: System ID example: "DDP" CREATION_DATE: - type: datetime + type: string description: Report request date - example: "Wed Apr 08 11:37:51 MYT 2009" + example: "Tue Sep 24 20:25:56 SGT 2019" USER_ID : type: string description: Valid user id in DDP system. It is for (For internal use) @@ -219,32 +219,61 @@ components: REGISTRY_DETAIL : type: object example: |+ - - - - - - - - - - - - - - - - - - - - - - - - - + REGISTRY_DETAIL: + ADDRESS1: + #text: "48 SERANGOON ROAD , 01 - 28" + @type: String + ADDRESS2: + #text: "LITTLE INDIA ARCADE" + @type: String + ADDRESS3: + #text: "217959" + @type: String + ADDRESS4: + #text: "SINGAPORE" + @type: String + AddressStr: + #text: "48 SERANGOON ROAD , 01 - 28
LITTLE INDIA ARCADE
217959
SINGAPORE" + @type: String + CHANGE_ADDR_DATE: + #text: "15/02/1995" + @type: String + COMP_STATUS: + #text: "CANCELLED" + @type: String + COMP_TYPE: + #text: "SOLE PROPRIETOR" + @type: String + COMP_TYPE_CODE: + #text: "SP" + @type: String + EXPIRY_DATE: { + #text: "28/09/2003" + @type: String + NAME_EFFECT_DATE: + #text: "28/09/1974" + @type: String + REG_ACTIVITY1: + #text: "47112 - MINI-MARTS, CONVENIENCE STORES AND PROVISION SHOPS" + @type: String + REG_ACTIVITY2: + #text: "-" + @type: String + REG_ACTIVITY_DESC1: + #text: "-" + @type: String + REG_ACTIVITY_DESC2: + #text: "-" + @type: String + REG_DATE: + #text: "28/09/1974" + @type: String + RENEWAL_DATE: + #text: "25/08/2000" + @type: String + STATUS_EFFECT_DATE: + #text: "30/06/2005" + @type: String description: |+ Registry Details with following children: RENEWAL_DATE @@ -274,7 +303,7 @@ components: RENEWAL_DATE: type: string description: Renewal Date - example: "23/12/2008" + example: "25/08/2000" ADDRESS1: type: string description: Address Line 1 @@ -369,14 +398,25 @@ components: REQ_SEARCH_INFO : type: object example: |+ - - - - - - - - + REQ_SEARCH_INFO: + COMP_NAME: + #text": "MENNAPPAN COMPANY" + @type": String + REG_NO: + #text: "00007400D" + @type: String + REQ_DATE: + #text: "Tue Sep 24 20:25:56 SGT 2019" + @type: Date + REQ_DATE_STR: + #text: "24/09/2019 20:25:56" + @type: String + REQ_NAME: + #text: "-" + @type: String + REQ_REG_NO: + #text: "00007400D" + @type: String description: |+ Request criteria & search record with following children: COMP_NAME @@ -1166,10 +1206,9 @@ components: example: 1 description: Number of subjects being enquired relating to the Run default: false - properties: subject_idno: type: string - example: 199707714C + example: "199707714C" description: "Subject’s ID Number (individual) or Registration Number (company/business) as captured in DDP" default: true subject_name: From f1e24ed2d322909264b983f2804b615cfb163aea Mon Sep 17 00:00:00 2001 From: Mohamed Luqman <57977684+mohamedSent@users.noreply.github.com> Date: Mon, 15 Mar 2021 11:49:26 +0530 Subject: [PATCH 697/792] Update d&b_business_check_sg.yaml --- data/d&b_business_check_sg.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/data/d&b_business_check_sg.yaml b/data/d&b_business_check_sg.yaml index 1a927d988..4509c0298 100644 --- a/data/d&b_business_check_sg.yaml +++ b/data/d&b_business_check_sg.yaml @@ -37,7 +37,7 @@ paths: application/json: schema: $ref: '#/components/schemas/success' - example: |+ + example: message: Successfully Processed status: Success results: From 639ee16caa8cf288d1a380aa24761bbe59e16893 Mon Sep 17 00:00:00 2001 From: Mohamed Luqman <57977684+mohamedSent@users.noreply.github.com> Date: Mon, 15 Mar 2021 11:51:44 +0530 Subject: [PATCH 698/792] Update d&b_business_check_sg.yaml --- data/d&b_business_check_sg.yaml | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/data/d&b_business_check_sg.yaml b/data/d&b_business_check_sg.yaml index 4509c0298..ee38e1894 100644 --- a/data/d&b_business_check_sg.yaml +++ b/data/d&b_business_check_sg.yaml @@ -43,12 +43,12 @@ paths: results: REPORT: LIST_BIZ_BRANCH: - @className: String + "@className": String LIST_Ddrptcount: - @className: String + "@className": String Ddrptcount: - Rcapr: - #text: 0 + "#text": 0 @type: Integer Rcaug: #text: 0 From f700a7ecaff56673b45e85a0ed6ec2a14ee94582 Mon Sep 17 00:00:00 2001 From: Mohamed Luqman <57977684+mohamedSent@users.noreply.github.com> Date: Mon, 15 Mar 2021 11:55:53 +0530 Subject: [PATCH 699/792] Update d&b_business_check_sg.yaml --- data/d&b_business_check_sg.yaml | 54 ++++++++++++++++----------------- 1 file changed, 27 insertions(+), 27 deletions(-) diff --git a/data/d&b_business_check_sg.yaml b/data/d&b_business_check_sg.yaml index ee38e1894..5ba4fa2c3 100644 --- a/data/d&b_business_check_sg.yaml +++ b/data/d&b_business_check_sg.yaml @@ -49,46 +49,46 @@ paths: Ddrptcount: - Rcapr: "#text": 0 - @type: Integer + "@type": Integer Rcaug: - #text: 0 - @type: Integer + "#text": 0 + "@type": Integer Rcdec: - #text: 0 - @type: Integer + "#text": 0 + "@type": Integer Rcfeb: - #text: 0 - @type: Integer + "#text": 0 + "@type": Integer Rcjan: - #text: 0 - @type: Integer + "#text": 0 + "@type": Integer Rcjul: - #text: 6 - @type: Integer + "#text": 6 + "@type": Integer Rcjun: - #text: 0 - @type: Integer + "#text": 0 + "@type": Integer Rcmar: - #text: 0 - @type: Integer + "#text": 0 + "@type": Integer Rcmay: - #text: 0 - @type: Integer + "#text": 0 + "@type": Integer Rcnov: - #text: 0 - @type: Integer + "#text": 0 + "@type": Integer Rcoct: - #text: 0 - @type: Integer + "#text": 0 + "@type": Integer Rcsecflag: - #text: 0 - @type: Integer + "#text": 0 + "@type": Integer Rcsep: - #text: 0 - @type: Integer + "#text": 0 + "@type": Integer Rcyear: - #text: '2020' - @type: String + "#text": '2020' + "@type": String '401': description: Unauthorized content: From 00d4423d53a242ab49e5e22937ee4998fe0aa608 Mon Sep 17 00:00:00 2001 From: Mohamed Luqman <57977684+mohamedSent@users.noreply.github.com> Date: Mon, 15 Mar 2021 12:02:35 +0530 Subject: [PATCH 700/792] Update d&b_business_check_sg.yaml --- data/d&b_business_check_sg.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/data/d&b_business_check_sg.yaml b/data/d&b_business_check_sg.yaml index 5ba4fa2c3..2d2d8ce5e 100644 --- a/data/d&b_business_check_sg.yaml +++ b/data/d&b_business_check_sg.yaml @@ -46,7 +46,7 @@ paths: "@className": String LIST_Ddrptcount: "@className": String - Ddrptcount: + "Ddrptcount": - Rcapr: "#text": 0 "@type": Integer From eb113f742e69377e75db70d6ec6be98d266b38df Mon Sep 17 00:00:00 2001 From: Mohamed Luqman <57977684+mohamedSent@users.noreply.github.com> Date: Mon, 15 Mar 2021 12:19:58 +0530 Subject: [PATCH 701/792] Update d&b_business_check_sg.yaml --- data/d&b_business_check_sg.yaml | 1900 +++++++++++++++---------------- 1 file changed, 950 insertions(+), 950 deletions(-) diff --git a/data/d&b_business_check_sg.yaml b/data/d&b_business_check_sg.yaml index 2d2d8ce5e..b7b557c5b 100644 --- a/data/d&b_business_check_sg.yaml +++ b/data/d&b_business_check_sg.yaml @@ -150,973 +150,973 @@ components: success: type: object properties: - REPORT: - type: object - example: - description: |+ - Report details with following children: - [META_INFO] - [REGISTRY_DETAIL] - [REQ_SEARCH_INFO] - [EMPLOYEE_SIZE] - [LIST_BIZ_BRANCH] - [LIST_REG_CHARGES] - [LIST_LIQUIDATOR] - [LIST_SHARE_INTEREST_COMP] - [LIST_NAME_CHANGE] - [LIST_SHAREHOLDER] - [LIST_CAPITAL] - [LIST_OFFICER_OWNER] - [LIST_SALES_REVENUE_AMOUNT] - properties: - META_INFO: - type: object - example: |+ - META_INFO: - CLASS: - #text: "class com.technodex.ddp.xmlbean.MetaBean" - @type: String - CREATION_DATE: - #text: "Tue Sep 24 20:25:56 SGT 2019" - @type: Date - SERVICE: - #text: "BC" - @type: String - SYSTEM_ID: - #text: "DDP" - @type: String - USER_ID: - #text: "AAA" - @type: String - description: |+ - Meta Information details with following children: - SERVICE - SYSTEM_ID - CREATION_DATE - USER_ID - CLASS - properties: - SERVICE: - type: string - description: Report requested - example: "BC" - SYSTEM_ID : - type: string - description: System ID - example: "DDP" - CREATION_DATE: - type: string - description: Report request date - example: "Tue Sep 24 20:25:56 SGT 2019" - USER_ID : - type: string - description: Valid user id in DDP system. It is for (For internal use) - example: "N/A" - CLASS: - type: string - description: Class location for metabean. It is for (For internal use) - example: "N/A" - REGISTRY_DETAIL : - type: object - example: |+ - REGISTRY_DETAIL: - ADDRESS1: - #text: "48 SERANGOON ROAD , 01 - 28" - @type: String - ADDRESS2: - #text: "LITTLE INDIA ARCADE" - @type: String - ADDRESS3: - #text: "217959" - @type: String - ADDRESS4: - #text: "SINGAPORE" - @type: String - AddressStr: - #text: "48 SERANGOON ROAD , 01 - 28
LITTLE INDIA ARCADE
217959
SINGAPORE" - @type: String - CHANGE_ADDR_DATE: - #text: "15/02/1995" - @type: String - COMP_STATUS: - #text: "CANCELLED" - @type: String - COMP_TYPE: - #text: "SOLE PROPRIETOR" - @type: String - COMP_TYPE_CODE: - #text: "SP" - @type: String - EXPIRY_DATE: { - #text: "28/09/2003" - @type: String - NAME_EFFECT_DATE: - #text: "28/09/1974" - @type: String - REG_ACTIVITY1: - #text: "47112 - MINI-MARTS, CONVENIENCE STORES AND PROVISION SHOPS" - @type: String - REG_ACTIVITY2: - #text: "-" - @type: String - REG_ACTIVITY_DESC1: - #text: "-" - @type: String - REG_ACTIVITY_DESC2: - #text: "-" + results: + type: object + example: {} + description: |+ + Report details with following children: + [META_INFO] + [REGISTRY_DETAIL] + [REQ_SEARCH_INFO] + [EMPLOYEE_SIZE] + [LIST_BIZ_BRANCH] + [LIST_REG_CHARGES] + [LIST_LIQUIDATOR] + [LIST_SHARE_INTEREST_COMP] + [LIST_NAME_CHANGE] + [LIST_SHAREHOLDER] + [LIST_CAPITAL] + [LIST_OFFICER_OWNER] + [LIST_SALES_REVENUE_AMOUNT] + properties: + META_INFO: + type: object + example: |+ + META_INFO: + CLASS: + #text: "class com.technodex.ddp.xmlbean.MetaBean" @type: String - REG_DATE: - #text: "28/09/1974" - @type: String - RENEWAL_DATE: - #text: "25/08/2000" - @type: String - STATUS_EFFECT_DATE: - #text: "30/06/2005" - @type: String - description: |+ - Registry Details with following children: - RENEWAL_DATE - ADDRESS1 - ADDRESS2 - ADDRESS3 - ADDRESS4 - COMP_TYPE_CODE - REG_DATE - REG_ACTIVITY1 - REG_ACTIVITY2 - ACC_DATE - STATUS_EFFECT_DATE - NAME_EFFECT_DATE - EXPIRY_DATE - COMP_TYPE - CHANGE_ADDR_DATE - COMP_STATUS - REG_ACTIVITY_DESC1 - REG_ACTIVITY_DESC2 - AUDITOR - AUDITOR_APPMT_DATE - LAST_AR_DATE - LAST_AGM_DATE - COUNTRY_INCORP - properties: - RENEWAL_DATE: - type: string - description: Renewal Date - example: "25/08/2000" - ADDRESS1: - type: string - description: Address Line 1 - example: "1 HARBOURFRONT AVENUE , 18 - 01" - ADDRESS2: - type: string - description: Address Line 2 - example: "KEPPEL BAY TOWER" - ADDRESS3: - type: string - description: Address Line 3 - example: "098632" - ADDRESS4: - type: string - description: Address Line 4 - example: "SINGAPORE" - COMP_TYPE_CODE: - type: string - example: CP - description: |+ - Report Code. Available values are: - 1. CP Corporate - 2. SP Sole Proprietor - REG_DATE: - type: string - description: Registration Date - example: "14/10/1974" - REG_ACTIVITY1: - type: string - description: Registered Activities 1 - example: "OTHER INVESTMENT HOLDING COMPANIES" - REG_ACTIVITY2: - type: string - description: Registered Activities 2 - example: "SHIP MANAGEMENT SERVICES" - ACC_DATE: - type: string - description: Account Date - example: "31/12/2007" - STATUS_EFFECT_DATE: - type: string - description: Status Effective Date - example: "14/10/1974" - NAME_EFFECT_DATE: - type: string - description: Name Effective Date - example: "14/10/1974" - EXPIRY_DATE: - type: string - description: Expiry Date - example: "25/10/2009" - COMP_TYPE: - type: string - description: Company Type - example: "LIMITED PRIVATE COMPANY" - CHANGE_ADDR_DATE: - type: string - description: Change Address Date - example: "09/05/2003" - COMP_STATUS: - type: string - description: Company Status - example: "Live Company" - REG_ACTIVITY_DESC1: - type: string - description: Registered Activities Description - example: - REG_ACTIVITY_DESC2: - type: string - description: Registered Activities Description - example: - AUDITOR: - type: string - description: Auditor Name - example: - AUDITOR_APPMT_DATE: - type: string - description: Auditor Appointment Date - example: "13/06/1990" - LAST_AR_DATE: - type: string - description: Date of Last AR - example: "30/06/2008" - LAST_AGM_DATE: - type: string - description: Date of Last AGM - example: "11/06/2008" - COUNTRY_INCORP: - type: string - description: Country Incorporated - example: "SINGAPORE" - REQ_SEARCH_INFO : - type: object - example: |+ - REQ_SEARCH_INFO: - COMP_NAME: - #text": "MENNAPPAN COMPANY" - @type": String - REG_NO: - #text: "00007400D" - @type: String - REQ_DATE: + CREATION_DATE: #text: "Tue Sep 24 20:25:56 SGT 2019" @type: Date - REQ_DATE_STR: - #text: "24/09/2019 20:25:56" + SERVICE: + #text: "BC" @type: String - REQ_NAME: - #text: "-" + SYSTEM_ID: + #text: "DDP" @type: String - REQ_REG_NO: - #text: "00007400D" + USER_ID: + #text: "AAA" @type: String - description: |+ - Request criteria & search record with following children: - COMP_NAME - REG_NO - REQ_DATE - REQ_REG_NO - REQ_NAME - REQ_DATE_STR + description: |+ + Meta Information details with following children: + SERVICE + SYSTEM_ID + CREATION_DATE + USER_ID + CLASS + properties: + SERVICE: + type: string + description: Report requested + example: "BC" + SYSTEM_ID : + type: string + description: System ID + example: "DDP" + CREATION_DATE: + type: string + description: Report request date + example: "Tue Sep 24 20:25:56 SGT 2019" + USER_ID : + type: string + description: Valid user id in DDP system. It is for (For internal use) + example: "N/A" + CLASS: + type: string + description: Class location for metabean. It is for (For internal use) + example: "N/A" + REGISTRY_DETAIL : + type: object + example: |+ + REGISTRY_DETAIL: + ADDRESS1: + #text: "48 SERANGOON ROAD , 01 - 28" + @type: String + ADDRESS2: + #text: "LITTLE INDIA ARCADE" + @type: String + ADDRESS3: + #text: "217959" + @type: String + ADDRESS4: + #text: "SINGAPORE" + @type: String + AddressStr: + #text: "48 SERANGOON ROAD , 01 - 28
LITTLE INDIA ARCADE
217959
SINGAPORE" + @type: String + CHANGE_ADDR_DATE: + #text: "15/02/1995" + @type: String + COMP_STATUS: + #text: "CANCELLED" + @type: String + COMP_TYPE: + #text: "SOLE PROPRIETOR" + @type: String + COMP_TYPE_CODE: + #text: "SP" + @type: String + EXPIRY_DATE: { + #text: "28/09/2003" + @type: String + NAME_EFFECT_DATE: + #text: "28/09/1974" + @type: String + REG_ACTIVITY1: + #text: "47112 - MINI-MARTS, CONVENIENCE STORES AND PROVISION SHOPS" + @type: String + REG_ACTIVITY2: + #text: "-" + @type: String + REG_ACTIVITY_DESC1: + #text: "-" + @type: String + REG_ACTIVITY_DESC2: + #text: "-" + @type: String + REG_DATE: + #text: "28/09/1974" + @type: String + RENEWAL_DATE: + #text: "25/08/2000" + @type: String + STATUS_EFFECT_DATE: + #text: "30/06/2005" + @type: String + description: |+ + Registry Details with following children: + RENEWAL_DATE + ADDRESS1 + ADDRESS2 + ADDRESS3 + ADDRESS4 + COMP_TYPE_CODE + REG_DATE + REG_ACTIVITY1 + REG_ACTIVITY2 + ACC_DATE + STATUS_EFFECT_DATE + NAME_EFFECT_DATE + EXPIRY_DATE + COMP_TYPE + CHANGE_ADDR_DATE + COMP_STATUS + REG_ACTIVITY_DESC1 + REG_ACTIVITY_DESC2 + AUDITOR + AUDITOR_APPMT_DATE + LAST_AR_DATE + LAST_AGM_DATE + COUNTRY_INCORP + properties: + RENEWAL_DATE: + type: string + description: Renewal Date + example: "25/08/2000" + ADDRESS1: + type: string + description: Address Line 1 + example: "1 HARBOURFRONT AVENUE , 18 - 01" + ADDRESS2: + type: string + description: Address Line 2 + example: "KEPPEL BAY TOWER" + ADDRESS3: + type: string + description: Address Line 3 + example: "098632" + ADDRESS4: + type: string + description: Address Line 4 + example: "SINGAPORE" + COMP_TYPE_CODE: + type: string + example: CP + description: |+ + Report Code. Available values are: + 1. CP Corporate + 2. SP Sole Proprietor + REG_DATE: + type: string + description: Registration Date + example: "14/10/1974" + REG_ACTIVITY1: + type: string + description: Registered Activities 1 + example: "OTHER INVESTMENT HOLDING COMPANIES" + REG_ACTIVITY2: + type: string + description: Registered Activities 2 + example: "SHIP MANAGEMENT SERVICES" + ACC_DATE: + type: string + description: Account Date + example: "31/12/2007" + STATUS_EFFECT_DATE: + type: string + description: Status Effective Date + example: "14/10/1974" + NAME_EFFECT_DATE: + type: string + description: Name Effective Date + example: "14/10/1974" + EXPIRY_DATE: + type: string + description: Expiry Date + example: "25/10/2009" + COMP_TYPE: + type: string + description: Company Type + example: "LIMITED PRIVATE COMPANY" + CHANGE_ADDR_DATE: + type: string + description: Change Address Date + example: "09/05/2003" + COMP_STATUS: + type: string + description: Company Status + example: "Live Company" + REG_ACTIVITY_DESC1: + type: string + description: Registered Activities Description + example: + REG_ACTIVITY_DESC2: + type: string + description: Registered Activities Description + example: + AUDITOR: + type: string + description: Auditor Name + example: + AUDITOR_APPMT_DATE: + type: string + description: Auditor Appointment Date + example: "13/06/1990" + LAST_AR_DATE: + type: string + description: Date of Last AR + example: "30/06/2008" + LAST_AGM_DATE: + type: string + description: Date of Last AGM + example: "11/06/2008" + COUNTRY_INCORP: + type: string + description: Country Incorporated + example: "SINGAPORE" + REQ_SEARCH_INFO : + type: object + example: |+ + REQ_SEARCH_INFO: + COMP_NAME: + #text": "MENNAPPAN COMPANY" + @type": String + REG_NO: + #text: "00007400D" + @type: String + REQ_DATE: + #text: "Tue Sep 24 20:25:56 SGT 2019" + @type: Date + REQ_DATE_STR: + #text: "24/09/2019 20:25:56" + @type: String + REQ_NAME: + #text: "-" + @type: String + REQ_REG_NO: + #text: "00007400D" + @type: String + description: |+ + Request criteria & search record with following children: + COMP_NAME + REG_NO + REQ_DATE + REQ_REG_NO + REQ_NAME + REQ_DATE_STR + properties: + COMP_NAME: + type: string + description: Company Name + example: "KAPAL MANAGEMENT (PRIVATE) LIMITED" + REG_NO: + type: string + description: Subject’s ID Number (individual) or Registration Number (company/business) + example: "197401835M" + REQ_DATE: + type: string + description: Report Requested Date + example: "2009-04-08 11:36:03.611" + REQ_REG_NO: + type: string + description: Request Registration Number + example: "197401835M" + REQ_NAME: + type: string + description: Request Name + example: "KAPAL MANAGEMENT (PRIVATE) LIMITED" + REQ_DATE_STR: + type: string + description: Request Date String + example: "08/04/2009 11:36:03" + EMPLOYEE_SIZE : + type: object + description: |+ + Employee Size details with following children: + ELEMENTS + AMOUNT + example: |+ + + + 300 + + properties: + ELEMENTS: + type: string + description: Description + example: "Employee Size" + AMOUNT: + type: string + description: Number of employee + example: "300" + LIST_BIZ_BRANCH : + type: array + description: |+ + List of Business Branches with following children: + [BIZ_BRANCH] + example: |+ + + + + + + + properties: + BIZ_BRANCH : + type: object + description: |+ + Business Branches with following children: + ADDR_BUILDING + ADDR_POSTCODE + ADDR_ADDRESS1 + example: |+ + + + + + + properties: + ADDR_BUILDING: + type: string + description: Building Name + example: + ADDR_POSTCODE: + type: string + description: Postcode + example: 289848 + ADDR_ADDRESS1: + type: string + description: Address + example: 251A ARCADIA ROAD + LIST_REG_CHARGES: + type: array + description: |+ + List of Registered Charges with following children: + [REG_CHARGES] + example: |+ + + + + + + + + + + + items: properties: - COMP_NAME: - type: string - description: Company Name - example: "KAPAL MANAGEMENT (PRIVATE) LIMITED" - REG_NO: - type: string - description: Subject’s ID Number (individual) or Registration Number (company/business) - example: "197401835M" - REQ_DATE: - type: string - description: Report Requested Date - example: "2009-04-08 11:36:03.611" - REQ_REG_NO: - type: string - description: Request Registration Number - example: "197401835M" - REQ_NAME: - type: string - description: Request Name - example: "KAPAL MANAGEMENT (PRIVATE) LIMITED" - REQ_DATE_STR: - type: string - description: Request Date String - example: "08/04/2009 11:36:03" - EMPLOYEE_SIZE : - type: object - description: |+ - Employee Size details with following children: - ELEMENTS - AMOUNT - example: |+ - - - 300 - + REG_CHARGES : + type: object + description: |+ + Registered Charges details with following children: + CHARGE_NO + CHARGE_DATE + CHARGEE_COMP + CURRENCY + AMT_SECURED + STATUS_SATISFACTION + example: |+ + + + + + + + + + properties: + CHARGE_NO : + type: string + description: Charge No. + example: 8205117 + CHARGE_DATE: + type: string + description: Charge Date + example: 26/11/1982 + CHARGEE_COMP: + type: string + description: Charges Company + example: UNITED OVERSEAS BANK LIMITED + CURRENCY: + type: string + description: Currency + example: + AMT_SECURED: + type: string + description: Amount Secured + example: 0.00 + STATUS_SATISFACTION: + type: string + description: Status of Satisfaction + example: + LIST_LIQUIDATOR: + type: array + description: |+ + List of Liquidator / Receiver / Judicial Manager with following children: + [LIQUIDATOR] + example: |+ + + + ABUTHAHIR ABDUL GAFOOR S1676216D + Liquidator + EL TICI FINANCIAL ADVISORY SERVICES PTE. LTD. 1 RAFFLES PLACE #20-01 + OUB CENTRE SINGAPORE 048616 30/03/2009 + + + items: properties: - ELEMENTS: - type: string - description: Description - example: "Employee Size" - AMOUNT: - type: string - description: Number of employee - example: "300" - LIST_BIZ_BRANCH : - type: array - description: |+ - List of Business Branches with following children: - [BIZ_BRANCH] - example: |+ - - - - - - + LIQUIDATOR : + type: object + description: |+ + Liquidator details with following children: + LIQ_POSITION + LIQ_ID + LIQ_NAME + LIQ_COMP + LIQ_ADDRESS1 + LIQ_ADDRESS2 + LIQ_ADDRESS3 + LIQ_ADDRESS4 + LIQ_APPOINTMENT_DATE + example: |+ + + ABUTHAHIR ABDUL GAFOOR + S1676216D + Liquidator + EL TICI FINANCIAL ADVISORY SERVICES PTE. LTD. + 1 RAFFLES PLACE + #20-01 + OUB CENTRE + SINGAPORE 048616 + 30/03/2009 + + properties: + LIQ_POSITION: + type: string + description: Liquidator / Receiver / Judicial Manager Position + example: Liquidator + LIQ_ID: + type: string + description: Liquidator / Receiver / Judicial Manager ID + example: S1676216D + LIQ_NAME : + type: string + description: Liquidator / Receiver / Judicial Manager Name + example: ABUTHAHIR ABDUL GAFOOR + LIQ_COMP: + type: string + description: Liquidator / Receiver / Judicial Manager Company Name + example: EL TICI FINANCIAL ADVISORY SERVICES PTE. LTD. + LIQ_ADDRESS1: + type: string + description: Liquidator / Receiver / Judicial Manager Address 1 + example: 1 RAFFLES PLACE + LIQ_ADDRESS2: + type: string + description: Liquidator / Receiver / Judicial Manager Address 2 + example: #20-01 + LIQ_ADDRESS3: + type: string + description: Liquidator / Receiver / Judicial Manager Address 3 + example: OUB CENTRE + LIQ_ADDRESS4: + type: string + description: Liquidator / Receiver / Judicial Manager Address 4 + example: SINGAPORE 048616 + LIQ_APPOINTMENT_DATE: + type: string + description: Liquidator / Receiver / Judicial Manager Appointment Date + example: 30/03/2009 + LIST_SHARE_INTEREST_COMP : + type: array + description: |+ + List of Share Interest In Companies with following children: + [SHARE_INTEREST_COMP] + example: |+ + + + + + + + + + items: properties: - BIZ_BRANCH : + SHARE_INTEREST_COMP : type: object description: |+ - Business Branches with following children: - ADDR_BUILDING - ADDR_POSTCODE - ADDR_ADDRESS1 + Share Interest In Companies details with following children: + COMP_NAME + SHARE_OWNED_UNIT + SHARE_OWNED_PERCENT + STATUS example: |+ - - - - - + + + + + + properties: - ADDR_BUILDING: + COMP_NAME : type: string - description: Building Name - example: - ADDR_POSTCODE: + description: Company Name + example: ORCHID (HOLDINGS) PTE. LTD. + SHARE_OWNED_UNIT : + type: string + description: Shares Owned Unit + example: 500000 + SHARE_OWNED_PERCENT : + type: string + description: Shares Owned Value (%) + example: 100.00 + STATUS : + type: string + description: Status + example: DISSOLVED - MEMBERS' VOLUNTARY WINDING UP + LIST_NAME_CHANGE : + type: array + description: |+ + List of Change of Company/Business Name(s) with following children: + [NAME_CHANGE] + example: |+ + + + + + + + items: + properties: + NAME_CHANGE : + type: object + description: |+ + Change of Company/Business Name(s) with following children: + PREV_NAME + EFFECT_DATE + example: |+ + + + + + properties: + PREV_NAME : + type: string + description: Previous Name + example: HUA XI EATING HOUSE + EFFECT_DATE : + type: string + description: Effective Date + example: 25/10/1997 00:00:00 + LIST_SHAREHOLDER : + type: array + description: |+ + List of Shareholders with following children: + [SHAREHOLDER] + example: |+ + + +
+ + + + + + + + + + items: + properties: + SHAREHOLDER : + type: object + description: |+ + Shareholders details with following children: + ADDRESS + COMP_ID + NO_OF_SHARE + CURRENCY + SHAREHOLDER_TYPE + SHARE_TYPE + SHAREHOLDER_NAME + CHANGE_ADDR_DATE + ADDR_TYPE + NATIONALITY + example: |+ + +
+ + + + + + + + + + + properties: + ADDRESS : + type: string + description: Address + example: 1 HARBOURFRONT AVENUE , 18 – 01; KEPPEL BAY TOWER; 098632, SINGAPORE + COMP_ID : + type: string + description: Company/ Identity No. + example: 198200406H + NO_OF_SHARE : + type: string + description: No. of Shares + example: 657 + CURRENCY : + type: string + description: Currency + example: UNITED STATES OF AMERICA, DOLLARS + SHAREHOLDER_TYPE : + type: string + description: Indicator for Shareholder type + example: 2 + SHARE_TYPE : + type: string + description: Share Type + example: Preference + SHAREHOLDER_NAME : + type: string + description: Shareholder Name + example: KEPPEL COMMUNICATIONS PTE LTD + CHANGE_ADDR_DATE : + type: string + description: Change Address Date + example: 09/05/2003 + ADDR_TYPE : + type: string + description: Address Type, indicates if it is Singapore or foreign address. + example: + NATIONALITY : + type: string + description: Nationality + example: SINGAPORE + LIST_CAPITAL : + type: array + description: |+ + List of Capital details with following children: + [CAPITAL] + example: |+ + + + + + + + + + + items: + properties: + CAPITAL : + type: object + description: |+ + Capital details with following children: + CAPITAL_CATEGORY + CAPITAL_TYPE + CURRENCY + CAPITAL_AMT + NO_OF_SHARES + example: |+ + + + + + + + + properties: + CAPITAL_CATEGORY : + type: string + description: Capital Category + example: Issued + CAPITAL_TYPE : type: string - description: Postcode - example: 289848 - ADDR_ADDRESS1: + description: Capital Type + example: Ordinary + CURRENCY : + type: string + description: Currency + example: SINGAPORE, DOLLARS + CAPITAL_AMT : + type: string + description: Capital Amount + example: 100,000.00 + NO_OF_SHARES : + type: string + description: Nos. of Shares + example: 100,000 + LIST_OFFICER_OWNER : + type: array + description: |+ + List of Officer(s) / Owner(s) with following children: + [OFFICER_OWNER] + example: |+ + + +
+ + + + + + + + items: + properties: + OFFICER_OWNER : + type: object + description: |+ + Officer(s) / Owner(s) details with following children: + ADDRESS + IDENTITY_ID + PA_REG_NO + POSITION + ADDR_TYPE + CESSATION_DATE + OFFICER_NAME + CHANGE_ADDR_DATE + APPMT_DATE + NATIONALITY + example: |+ + +
+ + + + + + + + + + properties: + ADDRESS : type: string description: Address - example: 251A ARCADIA ROAD - LIST_REG_CHARGES: - type: array - description: |+ - List of Registered Charges with following children: - [REG_CHARGES] - example: |+ - - - - - - - - - - - items: - properties: - REG_CHARGES : - type: object - description: |+ - Registered Charges details with following children: - CHARGE_NO - CHARGE_DATE - CHARGEE_COMP - CURRENCY - AMT_SECURED - STATUS_SATISFACTION - example: |+ - - - - - - - - - properties: - CHARGE_NO : - type: string - description: Charge No. - example: 8205117 - CHARGE_DATE: - type: string - description: Charge Date - example: 26/11/1982 - CHARGEE_COMP: - type: string - description: Charges Company - example: UNITED OVERSEAS BANK LIMITED - CURRENCY: - type: string - description: Currency - example: - AMT_SECURED: - type: string - description: Amount Secured - example: 0.00 - STATUS_SATISFACTION: - type: string - description: Status of Satisfaction - example: - LIST_LIQUIDATOR: - type: array - description: |+ - List of Liquidator / Receiver / Judicial Manager with following children: - [LIQUIDATOR] - example: |+ - - - ABUTHAHIR ABDUL GAFOOR S1676216D - Liquidator - EL TICI FINANCIAL ADVISORY SERVICES PTE. LTD. 1 RAFFLES PLACE #20-01 - OUB CENTRE SINGAPORE 048616 30/03/2009 - - - items: - properties: - LIQUIDATOR : - type: object - description: |+ - Liquidator details with following children: - LIQ_POSITION - LIQ_ID - LIQ_NAME - LIQ_COMP - LIQ_ADDRESS1 - LIQ_ADDRESS2 - LIQ_ADDRESS3 - LIQ_ADDRESS4 - LIQ_APPOINTMENT_DATE - example: |+ - - ABUTHAHIR ABDUL GAFOOR - S1676216D - Liquidator - EL TICI FINANCIAL ADVISORY SERVICES PTE. LTD. - 1 RAFFLES PLACE - #20-01 - OUB CENTRE - SINGAPORE 048616 - 30/03/2009 - - properties: - LIQ_POSITION: - type: string - description: Liquidator / Receiver / Judicial Manager Position - example: Liquidator - LIQ_ID: - type: string - description: Liquidator / Receiver / Judicial Manager ID - example: S1676216D - LIQ_NAME : - type: string - description: Liquidator / Receiver / Judicial Manager Name - example: ABUTHAHIR ABDUL GAFOOR - LIQ_COMP: - type: string - description: Liquidator / Receiver / Judicial Manager Company Name - example: EL TICI FINANCIAL ADVISORY SERVICES PTE. LTD. - LIQ_ADDRESS1: - type: string - description: Liquidator / Receiver / Judicial Manager Address 1 - example: 1 RAFFLES PLACE - LIQ_ADDRESS2: - type: string - description: Liquidator / Receiver / Judicial Manager Address 2 - example: #20-01 - LIQ_ADDRESS3: - type: string - description: Liquidator / Receiver / Judicial Manager Address 3 - example: OUB CENTRE - LIQ_ADDRESS4: - type: string - description: Liquidator / Receiver / Judicial Manager Address 4 - example: SINGAPORE 048616 - LIQ_APPOINTMENT_DATE: - type: string - description: Liquidator / Receiver / Judicial Manager Appointment Date - example: 30/03/2009 - LIST_SHARE_INTEREST_COMP : - type: array - description: |+ - List of Share Interest In Companies with following children: - [SHARE_INTEREST_COMP] - example: |+ - - - - - - - - - items: - properties: - SHARE_INTEREST_COMP : - type: object - description: |+ - Share Interest In Companies details with following children: - COMP_NAME - SHARE_OWNED_UNIT - SHARE_OWNED_PERCENT - STATUS - example: |+ - - - - - - - properties: - COMP_NAME : - type: string - description: Company Name - example: ORCHID (HOLDINGS) PTE. LTD. - SHARE_OWNED_UNIT : - type: string - description: Shares Owned Unit - example: 500000 - SHARE_OWNED_PERCENT : - type: string - description: Shares Owned Value (%) - example: 100.00 - STATUS : - type: string - description: Status - example: DISSOLVED - MEMBERS' VOLUNTARY WINDING UP - LIST_NAME_CHANGE : - type: array - description: |+ - List of Change of Company/Business Name(s) with following children: - [NAME_CHANGE] - example: |+ - - - - - - - items: - properties: - NAME_CHANGE : - type: object - description: |+ - Change of Company/Business Name(s) with following children: - PREV_NAME - EFFECT_DATE - example: |+ - - - - - properties: - PREV_NAME : - type: string - description: Previous Name - example: HUA XI EATING HOUSE - EFFECT_DATE : - type: string - description: Effective Date - example: 25/10/1997 00:00:00 - LIST_SHAREHOLDER : - type: array - description: |+ - List of Shareholders with following children: - [SHAREHOLDER] - example: |+ - - -
- - - - - - - - - - items: - properties: - SHAREHOLDER : - type: object - description: |+ - Shareholders details with following children: - ADDRESS - COMP_ID - NO_OF_SHARE - CURRENCY - SHAREHOLDER_TYPE - SHARE_TYPE - SHAREHOLDER_NAME - CHANGE_ADDR_DATE - ADDR_TYPE - NATIONALITY - example: |+ - -
- - - - - - - - - - - properties: - ADDRESS : - type: string - description: Address - example: 1 HARBOURFRONT AVENUE , 18 – 01; KEPPEL BAY TOWER; 098632, SINGAPORE - COMP_ID : - type: string - description: Company/ Identity No. - example: 198200406H - NO_OF_SHARE : - type: string - description: No. of Shares - example: 657 - CURRENCY : - type: string - description: Currency - example: UNITED STATES OF AMERICA, DOLLARS - SHAREHOLDER_TYPE : - type: string - description: Indicator for Shareholder type - example: 2 - SHARE_TYPE : - type: string - description: Share Type - example: Preference - SHAREHOLDER_NAME : - type: string - description: Shareholder Name - example: KEPPEL COMMUNICATIONS PTE LTD - CHANGE_ADDR_DATE : - type: string - description: Change Address Date - example: 09/05/2003 - ADDR_TYPE : - type: string - description: Address Type, indicates if it is Singapore or foreign address. - example: - NATIONALITY : - type: string - description: Nationality - example: SINGAPORE - LIST_CAPITAL : - type: array - description: |+ - List of Capital details with following children: - [CAPITAL] - example: |+ - - - - - - - - - - items: - properties: - CAPITAL : - type: object - description: |+ - Capital details with following children: - CAPITAL_CATEGORY - CAPITAL_TYPE - CURRENCY - CAPITAL_AMT - NO_OF_SHARES - example: |+ - - - - - - - - properties: - CAPITAL_CATEGORY : - type: string - description: Capital Category - example: Issued - CAPITAL_TYPE : - type: string - description: Capital Type - example: Ordinary - CURRENCY : - type: string - description: Currency - example: SINGAPORE, DOLLARS - CAPITAL_AMT : - type: string - description: Capital Amount - example: 100,000.00 - NO_OF_SHARES : - type: string - description: Nos. of Shares - example: 100,000 - LIST_OFFICER_OWNER : - type: array - description: |+ - List of Officer(s) / Owner(s) with following children: - [OFFICER_OWNER] - example: |+ - - -
- - - - - - - - items: - properties: - OFFICER_OWNER : - type: object - description: |+ - Officer(s) / Owner(s) details with following children: - ADDRESS - IDENTITY_ID - PA_REG_NO - POSITION - ADDR_TYPE - CESSATION_DATE - OFFICER_NAME - CHANGE_ADDR_DATE - APPMT_DATE - NATIONALITY - example: |+ - -
- - - - - - - - - - properties: - ADDRESS : - type: string - description: Address - example: 50A TOH TUCK ROAD, 04 - 08 ; SIGNATURE PARK; 596742, SINGAPORE - IDENTITY_ID : - type: string - description: Identity No. - example: S1674174D - PA_REG_NO : - type: string - description: Public Accountant Registration No. - example: 00091 - POSITION : - type: string - description: Position - example: DIRECTOR - ADDR_TYPE : - type: string - description: Address Type, indicates if it is Singapore or foreign address. - example: S - CESSATION_DATE : - type: string - description: Cessation Date - example: 30/10/2003 - OFFICER_NAME : - type: string - description: Officer Name - example: HENRY GOH - CHANGE_ADDR_DATE : - type: string - description: Change Address Date - example: 30/10/2003 - APPMT_DATE : - type: string - description: Appointment Date - example: 30/10/2003 - NATIONALITY : - type: string - description: Nationality - example: SINGAPORE P.R. - LIST_SALES_REVENUE_AMOUNT : - type: array - description: |+ - List of Sales Revenue Amount with following children: - [SALES_REVENUE_AMOUNT] - example: |+ - - - 30000.00 - - - items: - properties: - SALES_REVENUE_AMOUNT : - type: object - description: |+ - Sales Revenue Amount details with following children: - ELEMENTS - YEAR - CURRENCY - AMOUNT - example: |+ - - - - - 30000.00 - - properties: - ELEMENTS : - type: string - description: Description - example: Sales Revenue Amount - YEAR : - type: integer - description: Year - example: 2008 - CURRENCY : - type: string - description: Currency - example: SGD - AMOUNT : - type: integer - description: Amount - example: 30000.00 - LIST_Ddrptcount : - type: array - description: |+ - List of Search By Financial Sectors and Search By Non- Financial Sectors with following children: - [Ddrptcount] - example: - items: - properties: - Ddrptcount : - type: object - description: |+ - 6 XML tags (open then close) displays - Search By Financial Sectors (counts for 3 recent years) - Search By Non- Financial Sectors (counts for 3 recent years) - Following children are: - Rcyear - RcFlag (only respond for the year exists) - Rcjan - Rcfeb - Rcmar - Rcapr - Rcmay - Rcjun - Rcjul - Rcaug - Rcsep - Rcoct - Rcnov - Rcdec - Rcid (only respond for the year exists) Rcreg (only respond for the year exists) Rcrptyid (only respond for the year exists) - Rcsecflag - LastUpdateDate (only respond for the year exists) - example: - properties: - Rcyear : - type: string - description: To show the year - example: 2017 - RcFlag : - type: string - description: Internal database value - example: N/A - Rcjan : - type: integer - description: Count for January - example: 1 - Rcfeb : - type: integer - description: Count for February - example: 1 - Rcmar : - type: integer - description: Count for March - example: 1 - Rcapr : - type: integer - description: Count for April - example: 1 - Rcmay : - type: integer - description: Count for May - example: 1 - Rcjun : - type: integer - description: Count for June - example: 1 - Rcjul : - type: integer - description: Count for July - example: 1 - Rcaug : - type: integer - description: Count for August - example: 1 - Rcsep : - type: integer - description: Count for September - example: 1 - Rcoct : - type: integer - description: Count for October - example: 1 - Rcnov : - type: integer - description: Count for November - example: 1 - Rcdec : - type: integer - description: Count for December - example: 1 - Rcid : - type: integer - description: Internal database value - example: - Rcreg : - type: string - description: Company Registration Number - example: - Rcrptyid : - type: string - description: Product Type - example: - Rcsecflag : - type: integer - description: Differentiate Search By Financial Sectors and Search By Non- Financial Sectors - example: 1 - LastUpdateDate : - type: string - description: Last update date - example: + example: 50A TOH TUCK ROAD, 04 - 08 ; SIGNATURE PARK; 596742, SINGAPORE + IDENTITY_ID : + type: string + description: Identity No. + example: S1674174D + PA_REG_NO : + type: string + description: Public Accountant Registration No. + example: 00091 + POSITION : + type: string + description: Position + example: DIRECTOR + ADDR_TYPE : + type: string + description: Address Type, indicates if it is Singapore or foreign address. + example: S + CESSATION_DATE : + type: string + description: Cessation Date + example: 30/10/2003 + OFFICER_NAME : + type: string + description: Officer Name + example: HENRY GOH + CHANGE_ADDR_DATE : + type: string + description: Change Address Date + example: 30/10/2003 + APPMT_DATE : + type: string + description: Appointment Date + example: 30/10/2003 + NATIONALITY : + type: string + description: Nationality + example: SINGAPORE P.R. + LIST_SALES_REVENUE_AMOUNT : + type: array + description: |+ + List of Sales Revenue Amount with following children: + [SALES_REVENUE_AMOUNT] + example: |+ + + + 30000.00 + + + items: + properties: + SALES_REVENUE_AMOUNT : + type: object + description: |+ + Sales Revenue Amount details with following children: + ELEMENTS + YEAR + CURRENCY + AMOUNT + example: |+ + + + + + 30000.00 + + properties: + ELEMENTS : + type: string + description: Description + example: Sales Revenue Amount + YEAR : + type: integer + description: Year + example: 2008 + CURRENCY : + type: string + description: Currency + example: SGD + AMOUNT : + type: integer + description: Amount + example: 30000.00 + LIST_Ddrptcount : + type: array + description: |+ + List of Search By Financial Sectors and Search By Non- Financial Sectors with following children: + [Ddrptcount] + example: + items: + properties: + Ddrptcount : + type: object + description: |+ + 6 XML tags (open then close) displays + Search By Financial Sectors (counts for 3 recent years) + Search By Non- Financial Sectors (counts for 3 recent years) + Following children are: + Rcyear + RcFlag (only respond for the year exists) + Rcjan + Rcfeb + Rcmar + Rcapr + Rcmay + Rcjun + Rcjul + Rcaug + Rcsep + Rcoct + Rcnov + Rcdec + Rcid (only respond for the year exists) Rcreg (only respond for the year exists) Rcrptyid (only respond for the year exists) + Rcsecflag + LastUpdateDate (only respond for the year exists) + example: + properties: + Rcyear : + type: string + description: To show the year + example: 2017 + RcFlag : + type: string + description: Internal database value + example: N/A + Rcjan : + type: integer + description: Count for January + example: 1 + Rcfeb : + type: integer + description: Count for February + example: 1 + Rcmar : + type: integer + description: Count for March + example: 1 + Rcapr : + type: integer + description: Count for April + example: 1 + Rcmay : + type: integer + description: Count for May + example: 1 + Rcjun : + type: integer + description: Count for June + example: 1 + Rcjul : + type: integer + description: Count for July + example: 1 + Rcaug : + type: integer + description: Count for August + example: 1 + Rcsep : + type: integer + description: Count for September + example: 1 + Rcoct : + type: integer + description: Count for October + example: 1 + Rcnov : + type: integer + description: Count for November + example: 1 + Rcdec : + type: integer + description: Count for December + example: 1 + Rcid : + type: integer + description: Internal database value + example: + Rcreg : + type: string + description: Company Registration Number + example: + Rcrptyid : + type: string + description: Product Type + example: + Rcsecflag : + type: integer + description: Differentiate Search By Financial Sectors and Search By Non- Financial Sectors + example: 1 + LastUpdateDate : + type: string + description: Last update date + example: unauthorized: type: object properties: From a99bde5696ae4b59cd8039a1612463e0dfe48913 Mon Sep 17 00:00:00 2001 From: Mohamed Luqman <57977684+mohamedSent@users.noreply.github.com> Date: Mon, 15 Mar 2021 12:39:01 +0530 Subject: [PATCH 702/792] Update d&b_business_check_sg.yaml --- data/d&b_business_check_sg.yaml | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/data/d&b_business_check_sg.yaml b/data/d&b_business_check_sg.yaml index b7b557c5b..464930b83 100644 --- a/data/d&b_business_check_sg.yaml +++ b/data/d&b_business_check_sg.yaml @@ -171,7 +171,7 @@ components: properties: META_INFO: type: object - example: |+ + example: META_INFO: CLASS: #text: "class com.technodex.ddp.xmlbean.MetaBean" @@ -218,7 +218,7 @@ components: example: "N/A" REGISTRY_DETAIL : type: object - example: |+ + example: REGISTRY_DETAIL: ADDRESS1: #text: "48 SERANGOON ROAD , 01 - 28" @@ -397,7 +397,7 @@ components: example: "SINGAPORE" REQ_SEARCH_INFO : type: object - example: |+ + example: REQ_SEARCH_INFO: COMP_NAME: #text": "MENNAPPAN COMPANY" From ae00a10eac85135d6c577075aa73336faf53fc12 Mon Sep 17 00:00:00 2001 From: Mohamed Luqman <57977684+mohamedSent@users.noreply.github.com> Date: Mon, 15 Mar 2021 12:53:40 +0530 Subject: [PATCH 703/792] Update d&b_business_check_sg.yaml --- data/d&b_business_check_sg.yaml | 68 ++++++++++++++++----------------- 1 file changed, 34 insertions(+), 34 deletions(-) diff --git a/data/d&b_business_check_sg.yaml b/data/d&b_business_check_sg.yaml index 464930b83..6260e49a2 100644 --- a/data/d&b_business_check_sg.yaml +++ b/data/d&b_business_check_sg.yaml @@ -174,20 +174,20 @@ components: example: META_INFO: CLASS: - #text: "class com.technodex.ddp.xmlbean.MetaBean" - @type: String + "#text": "class com.technodex.ddp.xmlbean.MetaBean" + "@type": String CREATION_DATE: - #text: "Tue Sep 24 20:25:56 SGT 2019" - @type: Date + "#text": "Tue Sep 24 20:25:56 SGT 2019" + "@type": Date SERVICE: - #text: "BC" - @type: String + "#text": "BC" + "@type": String SYSTEM_ID: - #text: "DDP" - @type: String + "#text": "DDP" + "@type": String USER_ID: - #text: "AAA" - @type: String + "#text": "AAA" + "@type": String description: |+ Meta Information details with following children: SERVICE @@ -221,41 +221,41 @@ components: example: REGISTRY_DETAIL: ADDRESS1: - #text: "48 SERANGOON ROAD , 01 - 28" - @type: String + "#text": "48 SERANGOON ROAD , 01 - 28" + "@type": String ADDRESS2: - #text: "LITTLE INDIA ARCADE" - @type: String + "#text": "LITTLE INDIA ARCADE" + "@type": String ADDRESS3: - #text: "217959" - @type: String + "#text": "217959" + "@type": String ADDRESS4: - #text: "SINGAPORE" - @type: String + "#text": "SINGAPORE" + "@type": String AddressStr: - #text: "48 SERANGOON ROAD , 01 - 28
LITTLE INDIA ARCADE
217959
SINGAPORE" - @type: String + "#text": "48 SERANGOON ROAD , 01 - 28
LITTLE INDIA ARCADE
217959
SINGAPORE" + "@type": String CHANGE_ADDR_DATE: - #text: "15/02/1995" - @type: String + "#text": "15/02/1995" + "@type": String COMP_STATUS: - #text: "CANCELLED" - @type: String + "#text": "CANCELLED" + "@type": String COMP_TYPE: - #text: "SOLE PROPRIETOR" - @type: String + "#text": "SOLE PROPRIETOR" + "@type": String COMP_TYPE_CODE: - #text: "SP" - @type: String + "#text": "SP" + "@type": String EXPIRY_DATE: { - #text: "28/09/2003" - @type: String + "#text": "28/09/2003" + "@type": String NAME_EFFECT_DATE: - #text: "28/09/1974" - @type: String + "#text": "28/09/1974" + "@type": String REG_ACTIVITY1: - #text: "47112 - MINI-MARTS, CONVENIENCE STORES AND PROVISION SHOPS" - @type: String + "#text": "47112 - MINI-MARTS, CONVENIENCE STORES AND PROVISION SHOPS" + "@type": String REG_ACTIVITY2: #text: "-" @type: String From f320d20a249eab97364c695a82bb64e597f55044 Mon Sep 17 00:00:00 2001 From: Mohamed Luqman <57977684+mohamedSent@users.noreply.github.com> Date: Mon, 15 Mar 2021 14:52:35 +0530 Subject: [PATCH 704/792] Update d&b_business_check_sg.yaml --- data/d&b_business_check_sg.yaml | 48 ++++++++++++++++----------------- 1 file changed, 24 insertions(+), 24 deletions(-) diff --git a/data/d&b_business_check_sg.yaml b/data/d&b_business_check_sg.yaml index 6260e49a2..4f53a2fe5 100644 --- a/data/d&b_business_check_sg.yaml +++ b/data/d&b_business_check_sg.yaml @@ -257,23 +257,23 @@ components: "#text": "47112 - MINI-MARTS, CONVENIENCE STORES AND PROVISION SHOPS" "@type": String REG_ACTIVITY2: - #text: "-" - @type: String + "#text": "-" + "@type": String REG_ACTIVITY_DESC1: - #text: "-" - @type: String + "#text": "-" + "@type": String REG_ACTIVITY_DESC2: - #text: "-" - @type: String + "#text": "-" + "@type": String REG_DATE: - #text: "28/09/1974" - @type: String + "#text": "28/09/1974" + "@type": String RENEWAL_DATE: - #text: "25/08/2000" - @type: String + "#text": "25/08/2000" + "@type": String STATUS_EFFECT_DATE: - #text: "30/06/2005" - @type: String + "#text": "30/06/2005" + "@type": String description: |+ Registry Details with following children: RENEWAL_DATE @@ -400,23 +400,23 @@ components: example: REQ_SEARCH_INFO: COMP_NAME: - #text": "MENNAPPAN COMPANY" - @type": String + "#text": "MENNAPPAN COMPANY" + "@type": String REG_NO: - #text: "00007400D" - @type: String + "#text": "00007400D" + "@type": String REQ_DATE: - #text: "Tue Sep 24 20:25:56 SGT 2019" - @type: Date + "#text": "Tue Sep 24 20:25:56 SGT 2019" + "@type": Date REQ_DATE_STR: - #text: "24/09/2019 20:25:56" - @type: String + "#text": "24/09/2019 20:25:56" + "@type": String REQ_NAME: - #text: "-" - @type: String + "#text": "-" + "@type": String REQ_REG_NO: - #text: "00007400D" - @type: String + "#text": "00007400D" + "@type": String description: |+ Request criteria & search record with following children: COMP_NAME From 171678b3832498945671306acdab8959ef6f3174 Mon Sep 17 00:00:00 2001 From: Mohamed Luqman <57977684+mohamedSent@users.noreply.github.com> Date: Mon, 15 Mar 2021 15:08:35 +0530 Subject: [PATCH 705/792] Update d&b_business_check_sg.yaml --- data/d&b_business_check_sg.yaml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/data/d&b_business_check_sg.yaml b/data/d&b_business_check_sg.yaml index 4f53a2fe5..781794f06 100644 --- a/data/d&b_business_check_sg.yaml +++ b/data/d&b_business_check_sg.yaml @@ -37,7 +37,7 @@ paths: application/json: schema: $ref: '#/components/schemas/success' - example: + example: |+ message: Successfully Processed status: Success results: @@ -171,7 +171,7 @@ components: properties: META_INFO: type: object - example: + example: |+ META_INFO: CLASS: "#text": "class com.technodex.ddp.xmlbean.MetaBean" From 23decd829bceeee4705ab294bb7e9713f611aa95 Mon Sep 17 00:00:00 2001 From: Mohamed Luqman <57977684+mohamedSent@users.noreply.github.com> Date: Mon, 15 Mar 2021 15:11:31 +0530 Subject: [PATCH 706/792] Update d&b_business_check_sg.yaml --- data/d&b_business_check_sg.yaml | 1945 +++++++++++++++---------------- 1 file changed, 927 insertions(+), 1018 deletions(-) diff --git a/data/d&b_business_check_sg.yaml b/data/d&b_business_check_sg.yaml index 781794f06..2ad44dc82 100644 --- a/data/d&b_business_check_sg.yaml +++ b/data/d&b_business_check_sg.yaml @@ -27,9 +27,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/REQUEST' - example: |+ - {"total_items" : 1,"subject_idno":"199707714C", "subject_name":"GPS INDUSTRIES PTE LTD"} + $ref: '#/components/schemas/REQUEST' responses: '200': description: Ok @@ -37,58 +35,11 @@ paths: application/json: schema: $ref: '#/components/schemas/success' - example: |+ - message: Successfully Processed - status: Success - results: - REPORT: - LIST_BIZ_BRANCH: - "@className": String - LIST_Ddrptcount: - "@className": String - "Ddrptcount": - - Rcapr: - "#text": 0 - "@type": Integer - Rcaug: - "#text": 0 - "@type": Integer - Rcdec: - "#text": 0 - "@type": Integer - Rcfeb: - "#text": 0 - "@type": Integer - Rcjan: - "#text": 0 - "@type": Integer - Rcjul: - "#text": 6 - "@type": Integer - Rcjun: - "#text": 0 - "@type": Integer - Rcmar: - "#text": 0 - "@type": Integer - Rcmay: - "#text": 0 - "@type": Integer - Rcnov: - "#text": 0 - "@type": Integer - Rcoct: - "#text": 0 - "@type": Integer - Rcsecflag: - "#text": 0 - "@type": Integer - Rcsep: - "#text": 0 - "@type": Integer - Rcyear: - "#text": '2020' - "@type": String + example: |+ + string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string 0
string
+ string string string string string string string string string string string string string
string
+ + string string string string string string string string string string string string string string string '401': description: Unauthorized content: @@ -150,973 +101,924 @@ components: success: type: object properties: - results: - type: object - example: {} - description: |+ - Report details with following children: - [META_INFO] - [REGISTRY_DETAIL] - [REQ_SEARCH_INFO] - [EMPLOYEE_SIZE] - [LIST_BIZ_BRANCH] - [LIST_REG_CHARGES] - [LIST_LIQUIDATOR] - [LIST_SHARE_INTEREST_COMP] - [LIST_NAME_CHANGE] - [LIST_SHAREHOLDER] - [LIST_CAPITAL] - [LIST_OFFICER_OWNER] - [LIST_SALES_REVENUE_AMOUNT] - properties: - META_INFO: - type: object - example: |+ - META_INFO: - CLASS: - "#text": "class com.technodex.ddp.xmlbean.MetaBean" - "@type": String - CREATION_DATE: - "#text": "Tue Sep 24 20:25:56 SGT 2019" - "@type": Date - SERVICE: - "#text": "BC" - "@type": String - SYSTEM_ID: - "#text": "DDP" - "@type": String - USER_ID: - "#text": "AAA" - "@type": String - description: |+ - Meta Information details with following children: - SERVICE - SYSTEM_ID - CREATION_DATE - USER_ID - CLASS - properties: - SERVICE: - type: string - description: Report requested - example: "BC" - SYSTEM_ID : - type: string - description: System ID - example: "DDP" - CREATION_DATE: - type: string - description: Report request date - example: "Tue Sep 24 20:25:56 SGT 2019" - USER_ID : - type: string - description: Valid user id in DDP system. It is for (For internal use) - example: "N/A" - CLASS: - type: string - description: Class location for metabean. It is for (For internal use) - example: "N/A" - REGISTRY_DETAIL : - type: object - example: - REGISTRY_DETAIL: - ADDRESS1: - "#text": "48 SERANGOON ROAD , 01 - 28" - "@type": String - ADDRESS2: - "#text": "LITTLE INDIA ARCADE" - "@type": String - ADDRESS3: - "#text": "217959" - "@type": String - ADDRESS4: - "#text": "SINGAPORE" - "@type": String - AddressStr: - "#text": "48 SERANGOON ROAD , 01 - 28
LITTLE INDIA ARCADE
217959
SINGAPORE" - "@type": String - CHANGE_ADDR_DATE: - "#text": "15/02/1995" - "@type": String - COMP_STATUS: - "#text": "CANCELLED" - "@type": String - COMP_TYPE: - "#text": "SOLE PROPRIETOR" - "@type": String - COMP_TYPE_CODE: - "#text": "SP" - "@type": String - EXPIRY_DATE: { - "#text": "28/09/2003" - "@type": String - NAME_EFFECT_DATE: - "#text": "28/09/1974" - "@type": String - REG_ACTIVITY1: - "#text": "47112 - MINI-MARTS, CONVENIENCE STORES AND PROVISION SHOPS" - "@type": String - REG_ACTIVITY2: - "#text": "-" - "@type": String - REG_ACTIVITY_DESC1: - "#text": "-" - "@type": String - REG_ACTIVITY_DESC2: - "#text": "-" - "@type": String - REG_DATE: - "#text": "28/09/1974" - "@type": String - RENEWAL_DATE: - "#text": "25/08/2000" - "@type": String - STATUS_EFFECT_DATE: - "#text": "30/06/2005" - "@type": String - description: |+ - Registry Details with following children: - RENEWAL_DATE - ADDRESS1 - ADDRESS2 - ADDRESS3 - ADDRESS4 - COMP_TYPE_CODE - REG_DATE - REG_ACTIVITY1 - REG_ACTIVITY2 - ACC_DATE - STATUS_EFFECT_DATE - NAME_EFFECT_DATE - EXPIRY_DATE - COMP_TYPE - CHANGE_ADDR_DATE - COMP_STATUS - REG_ACTIVITY_DESC1 - REG_ACTIVITY_DESC2 - AUDITOR - AUDITOR_APPMT_DATE - LAST_AR_DATE - LAST_AGM_DATE - COUNTRY_INCORP - properties: - RENEWAL_DATE: - type: string - description: Renewal Date - example: "25/08/2000" - ADDRESS1: - type: string - description: Address Line 1 - example: "1 HARBOURFRONT AVENUE , 18 - 01" - ADDRESS2: - type: string - description: Address Line 2 - example: "KEPPEL BAY TOWER" - ADDRESS3: - type: string - description: Address Line 3 - example: "098632" - ADDRESS4: - type: string - description: Address Line 4 - example: "SINGAPORE" - COMP_TYPE_CODE: - type: string - example: CP - description: |+ - Report Code. Available values are: - 1. CP Corporate - 2. SP Sole Proprietor - REG_DATE: - type: string - description: Registration Date - example: "14/10/1974" - REG_ACTIVITY1: - type: string - description: Registered Activities 1 - example: "OTHER INVESTMENT HOLDING COMPANIES" - REG_ACTIVITY2: - type: string - description: Registered Activities 2 - example: "SHIP MANAGEMENT SERVICES" - ACC_DATE: - type: string - description: Account Date - example: "31/12/2007" - STATUS_EFFECT_DATE: - type: string - description: Status Effective Date - example: "14/10/1974" - NAME_EFFECT_DATE: - type: string - description: Name Effective Date - example: "14/10/1974" - EXPIRY_DATE: - type: string - description: Expiry Date - example: "25/10/2009" - COMP_TYPE: - type: string - description: Company Type - example: "LIMITED PRIVATE COMPANY" - CHANGE_ADDR_DATE: - type: string - description: Change Address Date - example: "09/05/2003" - COMP_STATUS: - type: string - description: Company Status - example: "Live Company" - REG_ACTIVITY_DESC1: - type: string - description: Registered Activities Description - example: - REG_ACTIVITY_DESC2: - type: string - description: Registered Activities Description - example: - AUDITOR: - type: string - description: Auditor Name - example: - AUDITOR_APPMT_DATE: - type: string - description: Auditor Appointment Date - example: "13/06/1990" - LAST_AR_DATE: - type: string - description: Date of Last AR - example: "30/06/2008" - LAST_AGM_DATE: - type: string - description: Date of Last AGM - example: "11/06/2008" - COUNTRY_INCORP: - type: string - description: Country Incorporated - example: "SINGAPORE" - REQ_SEARCH_INFO : - type: object - example: - REQ_SEARCH_INFO: - COMP_NAME: - "#text": "MENNAPPAN COMPANY" - "@type": String - REG_NO: - "#text": "00007400D" - "@type": String - REQ_DATE: - "#text": "Tue Sep 24 20:25:56 SGT 2019" - "@type": Date - REQ_DATE_STR: - "#text": "24/09/2019 20:25:56" - "@type": String - REQ_NAME: - "#text": "-" - "@type": String - REQ_REG_NO: - "#text": "00007400D" - "@type": String - description: |+ - Request criteria & search record with following children: - COMP_NAME - REG_NO - REQ_DATE - REQ_REG_NO - REQ_NAME - REQ_DATE_STR - properties: - COMP_NAME: - type: string - description: Company Name - example: "KAPAL MANAGEMENT (PRIVATE) LIMITED" - REG_NO: - type: string - description: Subject’s ID Number (individual) or Registration Number (company/business) - example: "197401835M" - REQ_DATE: - type: string - description: Report Requested Date - example: "2009-04-08 11:36:03.611" - REQ_REG_NO: - type: string - description: Request Registration Number - example: "197401835M" - REQ_NAME: - type: string - description: Request Name - example: "KAPAL MANAGEMENT (PRIVATE) LIMITED" - REQ_DATE_STR: - type: string - description: Request Date String - example: "08/04/2009 11:36:03" - EMPLOYEE_SIZE : - type: object - description: |+ - Employee Size details with following children: - ELEMENTS - AMOUNT - example: |+ - - - 300 - - properties: - ELEMENTS: - type: string - description: Description - example: "Employee Size" - AMOUNT: - type: string - description: Number of employee - example: "300" - LIST_BIZ_BRANCH : - type: array - description: |+ - List of Business Branches with following children: - [BIZ_BRANCH] - example: |+ - - - - - - - properties: - BIZ_BRANCH : - type: object - description: |+ - Business Branches with following children: - ADDR_BUILDING - ADDR_POSTCODE - ADDR_ADDRESS1 - example: |+ - - - - - - properties: - ADDR_BUILDING: - type: string - description: Building Name - example: - ADDR_POSTCODE: - type: string - description: Postcode - example: 289848 - ADDR_ADDRESS1: - type: string - description: Address - example: 251A ARCADIA ROAD - LIST_REG_CHARGES: - type: array - description: |+ - List of Registered Charges with following children: - [REG_CHARGES] - example: |+ - - - - - - - - - - - items: - properties: - REG_CHARGES : - type: object - description: |+ - Registered Charges details with following children: - CHARGE_NO - CHARGE_DATE - CHARGEE_COMP - CURRENCY - AMT_SECURED - STATUS_SATISFACTION - example: |+ - - - - - - - - - properties: - CHARGE_NO : - type: string - description: Charge No. - example: 8205117 - CHARGE_DATE: - type: string - description: Charge Date - example: 26/11/1982 - CHARGEE_COMP: - type: string - description: Charges Company - example: UNITED OVERSEAS BANK LIMITED - CURRENCY: - type: string - description: Currency - example: - AMT_SECURED: - type: string - description: Amount Secured - example: 0.00 - STATUS_SATISFACTION: - type: string - description: Status of Satisfaction - example: - LIST_LIQUIDATOR: - type: array - description: |+ - List of Liquidator / Receiver / Judicial Manager with following children: - [LIQUIDATOR] - example: |+ - - - ABUTHAHIR ABDUL GAFOOR S1676216D - Liquidator - EL TICI FINANCIAL ADVISORY SERVICES PTE. LTD. 1 RAFFLES PLACE #20-01 - OUB CENTRE SINGAPORE 048616 30/03/2009 - - - items: + REPORT: + type: object + example: + description: |+ + Report details with following children: + [META_INFO] + [REGISTRY_DETAIL] + [REQ_SEARCH_INFO] + [EMPLOYEE_SIZE] + [LIST_BIZ_BRANCH] + [LIST_REG_CHARGES] + [LIST_LIQUIDATOR] + [LIST_SHARE_INTEREST_COMP] + [LIST_NAME_CHANGE] + [LIST_SHAREHOLDER] + [LIST_CAPITAL] + [LIST_OFFICER_OWNER] + [LIST_SALES_REVENUE_AMOUNT] + properties: + META_INFO: + type: object + example: |+ + + + + + + + + description: |+ + Meta Information details with following children: + SERVICE + SYSTEM_ID + CREATION_DATE + USER_ID + CLASS properties: - LIQUIDATOR : - type: object - description: |+ - Liquidator details with following children: - LIQ_POSITION - LIQ_ID - LIQ_NAME - LIQ_COMP - LIQ_ADDRESS1 - LIQ_ADDRESS2 - LIQ_ADDRESS3 - LIQ_ADDRESS4 - LIQ_APPOINTMENT_DATE - example: |+ - - ABUTHAHIR ABDUL GAFOOR - S1676216D - Liquidator - EL TICI FINANCIAL ADVISORY SERVICES PTE. LTD. - 1 RAFFLES PLACE - #20-01 - OUB CENTRE - SINGAPORE 048616 - 30/03/2009 - - properties: - LIQ_POSITION: - type: string - description: Liquidator / Receiver / Judicial Manager Position - example: Liquidator - LIQ_ID: - type: string - description: Liquidator / Receiver / Judicial Manager ID - example: S1676216D - LIQ_NAME : - type: string - description: Liquidator / Receiver / Judicial Manager Name - example: ABUTHAHIR ABDUL GAFOOR - LIQ_COMP: - type: string - description: Liquidator / Receiver / Judicial Manager Company Name - example: EL TICI FINANCIAL ADVISORY SERVICES PTE. LTD. - LIQ_ADDRESS1: - type: string - description: Liquidator / Receiver / Judicial Manager Address 1 - example: 1 RAFFLES PLACE - LIQ_ADDRESS2: - type: string - description: Liquidator / Receiver / Judicial Manager Address 2 - example: #20-01 - LIQ_ADDRESS3: - type: string - description: Liquidator / Receiver / Judicial Manager Address 3 - example: OUB CENTRE - LIQ_ADDRESS4: - type: string - description: Liquidator / Receiver / Judicial Manager Address 4 - example: SINGAPORE 048616 - LIQ_APPOINTMENT_DATE: - type: string - description: Liquidator / Receiver / Judicial Manager Appointment Date - example: 30/03/2009 - LIST_SHARE_INTEREST_COMP : - type: array - description: |+ - List of Share Interest In Companies with following children: - [SHARE_INTEREST_COMP] - example: |+ - - - - - - - - - items: + SERVICE: + type: string + description: Report requested + example: "BC" + SYSTEM_ID : + type: string + description: System ID + example: "DDP" + CREATION_DATE: + type: datetime + description: Report request date + example: "Wed Apr 08 11:37:51 MYT 2009" + USER_ID : + type: string + description: Valid user id in DDP system. It is for (For internal use) + example: "N/A" + CLASS: + type: string + description: Class location for metabean. It is for (For internal use) + example: "N/A" + REGISTRY_DETAIL : + type: object + example: |+ + + + + + + + + + + + + + + + + + + + + + + + + + + description: |+ + Registry Details with following children: + RENEWAL_DATE + ADDRESS1 + ADDRESS2 + ADDRESS3 + ADDRESS4 + COMP_TYPE_CODE + REG_DATE + REG_ACTIVITY1 + REG_ACTIVITY2 + ACC_DATE + STATUS_EFFECT_DATE + NAME_EFFECT_DATE + EXPIRY_DATE + COMP_TYPE + CHANGE_ADDR_DATE + COMP_STATUS + REG_ACTIVITY_DESC1 + REG_ACTIVITY_DESC2 + AUDITOR + AUDITOR_APPMT_DATE + LAST_AR_DATE + LAST_AGM_DATE + COUNTRY_INCORP properties: - SHARE_INTEREST_COMP : - type: object + RENEWAL_DATE: + type: string + description: Renewal Date + example: "23/12/2008" + ADDRESS1: + type: string + description: Address Line 1 + example: "1 HARBOURFRONT AVENUE , 18 - 01" + ADDRESS2: + type: string + description: Address Line 2 + example: "KEPPEL BAY TOWER" + ADDRESS3: + type: string + description: Address Line 3 + example: "098632" + ADDRESS4: + type: string + description: Address Line 4 + example: "SINGAPORE" + COMP_TYPE_CODE: + type: string + example: CP description: |+ - Share Interest In Companies details with following children: - COMP_NAME - SHARE_OWNED_UNIT - SHARE_OWNED_PERCENT - STATUS - example: |+ - - - - - - - properties: - COMP_NAME : - type: string - description: Company Name - example: ORCHID (HOLDINGS) PTE. LTD. - SHARE_OWNED_UNIT : - type: string - description: Shares Owned Unit - example: 500000 - SHARE_OWNED_PERCENT : - type: string - description: Shares Owned Value (%) - example: 100.00 - STATUS : - type: string - description: Status - example: DISSOLVED - MEMBERS' VOLUNTARY WINDING UP - LIST_NAME_CHANGE : - type: array - description: |+ - List of Change of Company/Business Name(s) with following children: - [NAME_CHANGE] - example: |+ - - - - - - - items: + Report Code. Available values are: + 1. CP Corporate + 2. SP Sole Proprietor + REG_DATE: + type: string + description: Registration Date + example: "14/10/1974" + REG_ACTIVITY1: + type: string + description: Registered Activities 1 + example: "OTHER INVESTMENT HOLDING COMPANIES" + REG_ACTIVITY2: + type: string + description: Registered Activities 2 + example: "SHIP MANAGEMENT SERVICES" + ACC_DATE: + type: string + description: Account Date + example: "31/12/2007" + STATUS_EFFECT_DATE: + type: string + description: Status Effective Date + example: "14/10/1974" + NAME_EFFECT_DATE: + type: string + description: Name Effective Date + example: "14/10/1974" + EXPIRY_DATE: + type: string + description: Expiry Date + example: "25/10/2009" + COMP_TYPE: + type: string + description: Company Type + example: "LIMITED PRIVATE COMPANY" + CHANGE_ADDR_DATE: + type: string + description: Change Address Date + example: "09/05/2003" + COMP_STATUS: + type: string + description: Company Status + example: "Live Company" + REG_ACTIVITY_DESC1: + type: string + description: Registered Activities Description + example: + REG_ACTIVITY_DESC2: + type: string + description: Registered Activities Description + example: + AUDITOR: + type: string + description: Auditor Name + example: + AUDITOR_APPMT_DATE: + type: string + description: Auditor Appointment Date + example: "13/06/1990" + LAST_AR_DATE: + type: string + description: Date of Last AR + example: "30/06/2008" + LAST_AGM_DATE: + type: string + description: Date of Last AGM + example: "11/06/2008" + COUNTRY_INCORP: + type: string + description: Country Incorporated + example: "SINGAPORE" + REQ_SEARCH_INFO : + type: object + example: |+ + + + + + + + + + description: |+ + Request criteria & search record with following children: + COMP_NAME + REG_NO + REQ_DATE + REQ_REG_NO + REQ_NAME + REQ_DATE_STR properties: - NAME_CHANGE : - type: object - description: |+ - Change of Company/Business Name(s) with following children: - PREV_NAME - EFFECT_DATE - example: |+ - - - - - properties: - PREV_NAME : - type: string - description: Previous Name - example: HUA XI EATING HOUSE - EFFECT_DATE : - type: string - description: Effective Date - example: 25/10/1997 00:00:00 - LIST_SHAREHOLDER : - type: array - description: |+ - List of Shareholders with following children: - [SHAREHOLDER] - example: |+ - - -
- - - - - - - - - - items: + COMP_NAME: + type: string + description: Company Name + example: "KAPAL MANAGEMENT (PRIVATE) LIMITED" + REG_NO: + type: string + description: Subject’s ID Number (individual) or Registration Number (company/business) + example: "197401835M" + REQ_DATE: + type: string + description: Report Requested Date + example: "2009-04-08 11:36:03.611" + REQ_REG_NO: + type: string + description: Request Registration Number + example: "197401835M" + REQ_NAME: + type: string + description: Request Name + example: "KAPAL MANAGEMENT (PRIVATE) LIMITED" + REQ_DATE_STR: + type: string + description: Request Date String + example: "08/04/2009 11:36:03" + EMPLOYEE_SIZE : + type: object + description: |+ + Employee Size details with following children: + ELEMENTS + AMOUNT + example: |+ + + + 300 + properties: - SHAREHOLDER : - type: object - description: |+ - Shareholders details with following children: - ADDRESS - COMP_ID - NO_OF_SHARE - CURRENCY - SHAREHOLDER_TYPE - SHARE_TYPE - SHAREHOLDER_NAME - CHANGE_ADDR_DATE - ADDR_TYPE - NATIONALITY - example: |+ - -
- - - - - - - - - - - properties: - ADDRESS : - type: string - description: Address - example: 1 HARBOURFRONT AVENUE , 18 – 01; KEPPEL BAY TOWER; 098632, SINGAPORE - COMP_ID : - type: string - description: Company/ Identity No. - example: 198200406H - NO_OF_SHARE : - type: string - description: No. of Shares - example: 657 - CURRENCY : - type: string - description: Currency - example: UNITED STATES OF AMERICA, DOLLARS - SHAREHOLDER_TYPE : - type: string - description: Indicator for Shareholder type - example: 2 - SHARE_TYPE : - type: string - description: Share Type - example: Preference - SHAREHOLDER_NAME : - type: string - description: Shareholder Name - example: KEPPEL COMMUNICATIONS PTE LTD - CHANGE_ADDR_DATE : - type: string - description: Change Address Date - example: 09/05/2003 - ADDR_TYPE : - type: string - description: Address Type, indicates if it is Singapore or foreign address. - example: - NATIONALITY : - type: string - description: Nationality - example: SINGAPORE - LIST_CAPITAL : - type: array - description: |+ - List of Capital details with following children: - [CAPITAL] - example: |+ - - - - - - - - - - items: + ELEMENTS: + type: string + description: Description + example: "Employee Size" + AMOUNT: + type: string + description: Number of employee + example: "300" + LIST_BIZ_BRANCH : + type: array + description: |+ + List of Business Branches with following children: + [BIZ_BRANCH] + example: |+ + + + + + + properties: - CAPITAL : + BIZ_BRANCH : type: object description: |+ - Capital details with following children: - CAPITAL_CATEGORY - CAPITAL_TYPE - CURRENCY - CAPITAL_AMT - NO_OF_SHARES + Business Branches with following children: + ADDR_BUILDING + ADDR_POSTCODE + ADDR_ADDRESS1 example: |+ - - - - - - - + + + + + properties: - CAPITAL_CATEGORY : - type: string - description: Capital Category - example: Issued - CAPITAL_TYPE : - type: string - description: Capital Type - example: Ordinary - CURRENCY : + ADDR_BUILDING: type: string - description: Currency - example: SINGAPORE, DOLLARS - CAPITAL_AMT : - type: string - description: Capital Amount - example: 100,000.00 - NO_OF_SHARES : + description: Building Name + example: + ADDR_POSTCODE: type: string - description: Nos. of Shares - example: 100,000 - LIST_OFFICER_OWNER : - type: array - description: |+ - List of Officer(s) / Owner(s) with following children: - [OFFICER_OWNER] - example: |+ - - -
- - - - - - - - items: - properties: - OFFICER_OWNER : - type: object - description: |+ - Officer(s) / Owner(s) details with following children: - ADDRESS - IDENTITY_ID - PA_REG_NO - POSITION - ADDR_TYPE - CESSATION_DATE - OFFICER_NAME - CHANGE_ADDR_DATE - APPMT_DATE - NATIONALITY - example: |+ - -
- - - - - - - - - - properties: - ADDRESS : + description: Postcode + example: 289848 + ADDR_ADDRESS1: type: string description: Address - example: 50A TOH TUCK ROAD, 04 - 08 ; SIGNATURE PARK; 596742, SINGAPORE - IDENTITY_ID : - type: string - description: Identity No. - example: S1674174D - PA_REG_NO : - type: string - description: Public Accountant Registration No. - example: 00091 - POSITION : - type: string - description: Position - example: DIRECTOR - ADDR_TYPE : - type: string - description: Address Type, indicates if it is Singapore or foreign address. - example: S - CESSATION_DATE : - type: string - description: Cessation Date - example: 30/10/2003 - OFFICER_NAME : - type: string - description: Officer Name - example: HENRY GOH - CHANGE_ADDR_DATE : - type: string - description: Change Address Date - example: 30/10/2003 - APPMT_DATE : - type: string - description: Appointment Date - example: 30/10/2003 - NATIONALITY : - type: string - description: Nationality - example: SINGAPORE P.R. - LIST_SALES_REVENUE_AMOUNT : - type: array - description: |+ - List of Sales Revenue Amount with following children: - [SALES_REVENUE_AMOUNT] - example: |+ - - - 30000.00 - - - items: - properties: - SALES_REVENUE_AMOUNT : - type: object - description: |+ - Sales Revenue Amount details with following children: - ELEMENTS - YEAR - CURRENCY - AMOUNT - example: |+ - - - - - 30000.00 - - properties: - ELEMENTS : - type: string - description: Description - example: Sales Revenue Amount - YEAR : - type: integer - description: Year - example: 2008 - CURRENCY : - type: string - description: Currency - example: SGD - AMOUNT : - type: integer - description: Amount - example: 30000.00 - LIST_Ddrptcount : - type: array - description: |+ - List of Search By Financial Sectors and Search By Non- Financial Sectors with following children: - [Ddrptcount] - example: - items: - properties: - Ddrptcount : - type: object - description: |+ - 6 XML tags (open then close) displays - Search By Financial Sectors (counts for 3 recent years) - Search By Non- Financial Sectors (counts for 3 recent years) - Following children are: - Rcyear - RcFlag (only respond for the year exists) - Rcjan - Rcfeb - Rcmar - Rcapr - Rcmay - Rcjun - Rcjul - Rcaug - Rcsep - Rcoct - Rcnov - Rcdec - Rcid (only respond for the year exists) Rcreg (only respond for the year exists) Rcrptyid (only respond for the year exists) - Rcsecflag - LastUpdateDate (only respond for the year exists) - example: - properties: - Rcyear : - type: string - description: To show the year - example: 2017 - RcFlag : - type: string - description: Internal database value - example: N/A - Rcjan : - type: integer - description: Count for January - example: 1 - Rcfeb : - type: integer - description: Count for February - example: 1 - Rcmar : - type: integer - description: Count for March - example: 1 - Rcapr : - type: integer - description: Count for April - example: 1 - Rcmay : - type: integer - description: Count for May - example: 1 - Rcjun : - type: integer - description: Count for June - example: 1 - Rcjul : - type: integer - description: Count for July - example: 1 - Rcaug : - type: integer - description: Count for August - example: 1 - Rcsep : - type: integer - description: Count for September - example: 1 - Rcoct : - type: integer - description: Count for October - example: 1 - Rcnov : - type: integer - description: Count for November - example: 1 - Rcdec : - type: integer - description: Count for December - example: 1 - Rcid : - type: integer - description: Internal database value - example: - Rcreg : - type: string - description: Company Registration Number - example: - Rcrptyid : - type: string - description: Product Type - example: - Rcsecflag : - type: integer - description: Differentiate Search By Financial Sectors and Search By Non- Financial Sectors - example: 1 - LastUpdateDate : - type: string - description: Last update date - example: + example: 251A ARCADIA ROAD + LIST_REG_CHARGES: + type: array + description: |+ + List of Registered Charges with following children: + [REG_CHARGES] + example: |+ + + + + + + + + + + + items: + properties: + REG_CHARGES : + type: object + description: |+ + Registered Charges details with following children: + CHARGE_NO + CHARGE_DATE + CHARGEE_COMP + CURRENCY + AMT_SECURED + STATUS_SATISFACTION + example: |+ + + + + + + + + + properties: + CHARGE_NO : + type: string + description: Charge No. + example: 8205117 + CHARGE_DATE: + type: string + description: Charge Date + example: 26/11/1982 + CHARGEE_COMP: + type: string + description: Charges Company + example: UNITED OVERSEAS BANK LIMITED + CURRENCY: + type: string + description: Currency + example: + AMT_SECURED: + type: string + description: Amount Secured + example: 0.00 + STATUS_SATISFACTION: + type: string + description: Status of Satisfaction + example: + LIST_LIQUIDATOR: + type: array + description: |+ + List of Liquidator / Receiver / Judicial Manager with following children: + [LIQUIDATOR] + example: |+ + + + ABUTHAHIR ABDUL GAFOOR S1676216D + Liquidator + EL TICI FINANCIAL ADVISORY SERVICES PTE. LTD. 1 RAFFLES PLACE #20-01 + OUB CENTRE SINGAPORE 048616 30/03/2009 + + + items: + properties: + LIQUIDATOR : + type: object + description: |+ + Liquidator details with following children: + LIQ_POSITION + LIQ_ID + LIQ_NAME + LIQ_COMP + LIQ_ADDRESS1 + LIQ_ADDRESS2 + LIQ_ADDRESS3 + LIQ_ADDRESS4 + LIQ_APPOINTMENT_DATE + example: |+ + + ABUTHAHIR ABDUL GAFOOR + S1676216D + Liquidator + EL TICI FINANCIAL ADVISORY SERVICES PTE. LTD. + 1 RAFFLES PLACE + #20-01 + OUB CENTRE + SINGAPORE 048616 + 30/03/2009 + + properties: + LIQ_POSITION: + type: string + description: Liquidator / Receiver / Judicial Manager Position + example: Liquidator + LIQ_ID: + type: string + description: Liquidator / Receiver / Judicial Manager ID + example: S1676216D + LIQ_NAME : + type: string + description: Liquidator / Receiver / Judicial Manager Name + example: ABUTHAHIR ABDUL GAFOOR + LIQ_COMP: + type: string + description: Liquidator / Receiver / Judicial Manager Company Name + example: EL TICI FINANCIAL ADVISORY SERVICES PTE. LTD. + LIQ_ADDRESS1: + type: string + description: Liquidator / Receiver / Judicial Manager Address 1 + example: 1 RAFFLES PLACE + LIQ_ADDRESS2: + type: string + description: Liquidator / Receiver / Judicial Manager Address 2 + example: #20-01 + LIQ_ADDRESS3: + type: string + description: Liquidator / Receiver / Judicial Manager Address 3 + example: OUB CENTRE + LIQ_ADDRESS4: + type: string + description: Liquidator / Receiver / Judicial Manager Address 4 + example: SINGAPORE 048616 + LIQ_APPOINTMENT_DATE: + type: string + description: Liquidator / Receiver / Judicial Manager Appointment Date + example: 30/03/2009 + LIST_SHARE_INTEREST_COMP : + type: array + description: |+ + List of Share Interest In Companies with following children: + [SHARE_INTEREST_COMP] + example: |+ + + + + + + + + + items: + properties: + SHARE_INTEREST_COMP : + type: object + description: |+ + Share Interest In Companies details with following children: + COMP_NAME + SHARE_OWNED_UNIT + SHARE_OWNED_PERCENT + STATUS + example: |+ + + + + + + + properties: + COMP_NAME : + type: string + description: Company Name + example: ORCHID (HOLDINGS) PTE. LTD. + SHARE_OWNED_UNIT : + type: string + description: Shares Owned Unit + example: 500000 + SHARE_OWNED_PERCENT : + type: string + description: Shares Owned Value (%) + example: 100.00 + STATUS : + type: string + description: Status + example: DISSOLVED - MEMBERS' VOLUNTARY WINDING UP + LIST_NAME_CHANGE : + type: array + description: |+ + List of Change of Company/Business Name(s) with following children: + [NAME_CHANGE] + example: |+ + + + + + + + items: + properties: + NAME_CHANGE : + type: object + description: |+ + Change of Company/Business Name(s) with following children: + PREV_NAME + EFFECT_DATE + example: |+ + + + + + properties: + PREV_NAME : + type: string + description: Previous Name + example: HUA XI EATING HOUSE + EFFECT_DATE : + type: string + description: Effective Date + example: 25/10/1997 00:00:00 + LIST_SHAREHOLDER : + type: array + description: |+ + List of Shareholders with following children: + [SHAREHOLDER] + example: |+ + + +
+ + + + + + + + + + items: + properties: + SHAREHOLDER : + type: object + description: |+ + Shareholders details with following children: + ADDRESS + COMP_ID + NO_OF_SHARE + CURRENCY + SHAREHOLDER_TYPE + SHARE_TYPE + SHAREHOLDER_NAME + CHANGE_ADDR_DATE + ADDR_TYPE + NATIONALITY + example: |+ + +
+ + + + + + + + + + + properties: + ADDRESS : + type: string + description: Address + example: 1 HARBOURFRONT AVENUE , 18 – 01; KEPPEL BAY TOWER; 098632, SINGAPORE + COMP_ID : + type: string + description: Company/ Identity No. + example: 198200406H + NO_OF_SHARE : + type: string + description: No. of Shares + example: 657 + CURRENCY : + type: string + description: Currency + example: UNITED STATES OF AMERICA, DOLLARS + SHAREHOLDER_TYPE : + type: string + description: Indicator for Shareholder type + example: 2 + SHARE_TYPE : + type: string + description: Share Type + example: Preference + SHAREHOLDER_NAME : + type: string + description: Shareholder Name + example: KEPPEL COMMUNICATIONS PTE LTD + CHANGE_ADDR_DATE : + type: string + description: Change Address Date + example: 09/05/2003 + ADDR_TYPE : + type: string + description: Address Type, indicates if it is Singapore or foreign address. + example: + NATIONALITY : + type: string + description: Nationality + example: SINGAPORE + LIST_CAPITAL : + type: array + description: |+ + List of Capital details with following children: + [CAPITAL] + example: |+ + + + + + + + + + + items: + properties: + CAPITAL : + type: object + description: |+ + Capital details with following children: + CAPITAL_CATEGORY + CAPITAL_TYPE + CURRENCY + CAPITAL_AMT + NO_OF_SHARES + example: |+ + + + + + + + + properties: + CAPITAL_CATEGORY : + type: string + description: Capital Category + example: Issued + CAPITAL_TYPE : + type: string + description: Capital Type + example: Ordinary + CURRENCY : + type: string + description: Currency + example: SINGAPORE, DOLLARS + CAPITAL_AMT : + type: string + description: Capital Amount + example: 100,000.00 + NO_OF_SHARES : + type: string + description: Nos. of Shares + example: 100,000 + LIST_OFFICER_OWNER : + type: array + description: |+ + List of Officer(s) / Owner(s) with following children: + [OFFICER_OWNER] + example: |+ + + +
+ + + + + + + + items: + properties: + OFFICER_OWNER : + type: object + description: |+ + Officer(s) / Owner(s) details with following children: + ADDRESS + IDENTITY_ID + PA_REG_NO + POSITION + ADDR_TYPE + CESSATION_DATE + OFFICER_NAME + CHANGE_ADDR_DATE + APPMT_DATE + NATIONALITY + example: |+ + +
+ + + + + + + + + + properties: + ADDRESS : + type: string + description: Address + example: 50A TOH TUCK ROAD, 04 - 08 ; SIGNATURE PARK; 596742, SINGAPORE + IDENTITY_ID : + type: string + description: Identity No. + example: S1674174D + PA_REG_NO : + type: string + description: Public Accountant Registration No. + example: 00091 + POSITION : + type: string + description: Position + example: DIRECTOR + ADDR_TYPE : + type: string + description: Address Type, indicates if it is Singapore or foreign address. + example: S + CESSATION_DATE : + type: string + description: Cessation Date + example: 30/10/2003 + OFFICER_NAME : + type: string + description: Officer Name + example: HENRY GOH + CHANGE_ADDR_DATE : + type: string + description: Change Address Date + example: 30/10/2003 + APPMT_DATE : + type: string + description: Appointment Date + example: 30/10/2003 + NATIONALITY : + type: string + description: Nationality + example: SINGAPORE P.R. + LIST_SALES_REVENUE_AMOUNT : + type: array + description: |+ + List of Sales Revenue Amount with following children: + [SALES_REVENUE_AMOUNT] + example: |+ + + + 30000.00 + + + items: + properties: + SALES_REVENUE_AMOUNT : + type: object + description: |+ + Sales Revenue Amount details with following children: + ELEMENTS + YEAR + CURRENCY + AMOUNT + example: |+ + + + + + 30000.00 + + properties: + ELEMENTS : + type: string + description: Description + example: Sales Revenue Amount + YEAR : + type: integer + description: Year + example: 2008 + CURRENCY : + type: string + description: Currency + example: SGD + AMOUNT : + type: integer + description: Amount + example: 30000.00 + LIST_Ddrptcount : + type: array + description: |+ + List of Search By Financial Sectors and Search By Non- Financial Sectors with following children: + [Ddrptcount] + example: + items: + properties: + Ddrptcount : + type: object + description: |+ + 6 XML tags (open then close) displays + Search By Financial Sectors (counts for 3 recent years) + Search By Non- Financial Sectors (counts for 3 recent years) + Following children are: + Rcyear + RcFlag (only respond for the year exists) + Rcjan + Rcfeb + Rcmar + Rcapr + Rcmay + Rcjun + Rcjul + Rcaug + Rcsep + Rcoct + Rcnov + Rcdec + Rcid (only respond for the year exists) Rcreg (only respond for the year exists) Rcrptyid (only respond for the year exists) + Rcsecflag + LastUpdateDate (only respond for the year exists) + example: + properties: + Rcyear : + type: string + description: To show the year + example: 2017 + RcFlag : + type: string + description: Internal database value + example: N/A + Rcjan : + type: integer + description: Count for January + example: 1 + Rcfeb : + type: integer + description: Count for February + example: 1 + Rcmar : + type: integer + description: Count for March + example: 1 + Rcapr : + type: integer + description: Count for April + example: 1 + Rcmay : + type: integer + description: Count for May + example: 1 + Rcjun : + type: integer + description: Count for June + example: 1 + Rcjul : + type: integer + description: Count for July + example: 1 + Rcaug : + type: integer + description: Count for August + example: 1 + Rcsep : + type: integer + description: Count for September + example: 1 + Rcoct : + type: integer + description: Count for October + example: 1 + Rcnov : + type: integer + description: Count for November + example: 1 + Rcdec : + type: integer + description: Count for December + example: 1 + Rcid : + type: integer + description: Internal database value + example: + Rcreg : + type: string + description: Company Registration Number + example: + Rcrptyid : + type: string + description: Product Type + example: + Rcsecflag : + type: integer + description: Differentiate Search By Financial Sectors and Search By Non- Financial Sectors + example: 1 + LastUpdateDate : + type: string + description: Last update date + example: unauthorized: type: object properties: @@ -1201,21 +1103,28 @@ components: REQUEST: type: object properties: - total_items: + TOT_ITEMS: type: number example: 1 description: Number of subjects being enquired relating to the Run default: false - subject_idno: - type: string - example: "199707714C" - description: "Subject’s ID Number (individual) or Registration Number (company/business) as captured in DDP" + ENQUIRY: + type: object + example: |+ + 197601887ETRANSTAR TRAVEL PTE LTD + description: Contains information of each request details default: true - subject_name: - type: string - example: GPS INDUSTRIES PTE LTD - description: Subjects Name as captured in DDP - default: false + properties: + SUBJECT_IDNO: + type: string + example: 199707714C + description: "Subject’s ID Number (individual) or Registration Number (company/business) as captured in DDP" + default: true + SUBJECT_NAME: + type: string + example: GPS INDUSTRIES PTE LTD + description: Subjects Name as captured in DDP + default: false versions: type: object properties: From 38ac6c2a948c3537d8540110945ab5c8ebef50eb Mon Sep 17 00:00:00 2001 From: Mohamed Luqman <57977684+mohamedSent@users.noreply.github.com> Date: Mon, 15 Mar 2021 15:14:08 +0530 Subject: [PATCH 707/792] Update d&b_business_check_sg.yaml --- data/d&b_business_check_sg.yaml | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/data/d&b_business_check_sg.yaml b/data/d&b_business_check_sg.yaml index 2ad44dc82..a1df33953 100644 --- a/data/d&b_business_check_sg.yaml +++ b/data/d&b_business_check_sg.yaml @@ -13,26 +13,26 @@ info: version: '0.1.0' x-subscribelink: d&b_business_check_sg servers: - - url: 'https://dev-apis.sentient.io' + - url: 'https://api.sentient.io' tags: - name: "v0.1.0" description: "Published Date - Aug 15, 2019" paths: - /microservices/data/sbc/v0/getdata: + /dnb/prod/sbc: post: tags: - - v0 + - v0.1.0 summary: Adds a new user requestBody: content: - application/json: + application/xml: schema: $ref: '#/components/schemas/REQUEST' responses: '200': description: Ok content: - application/json: + application/xml: schema: $ref: '#/components/schemas/success' example: |+ From 05e3168a824701faa6a59b3b5ccbfaa2e1445a08 Mon Sep 17 00:00:00 2001 From: Mohamed Luqman <57977684+mohamedSent@users.noreply.github.com> Date: Mon, 15 Mar 2021 15:19:28 +0530 Subject: [PATCH 708/792] Update d&b_business_check_sg.yaml --- data/d&b_business_check_sg.yaml | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/data/d&b_business_check_sg.yaml b/data/d&b_business_check_sg.yaml index a1df33953..ce5765a22 100644 --- a/data/d&b_business_check_sg.yaml +++ b/data/d&b_business_check_sg.yaml @@ -13,26 +13,26 @@ info: version: '0.1.0' x-subscribelink: d&b_business_check_sg servers: - - url: 'https://api.sentient.io' + - url: 'https://dev-apis.sentient.io' tags: - name: "v0.1.0" description: "Published Date - Aug 15, 2019" paths: - /dnb/prod/sbc: + /microservices/data/sbc/v0/getdata: post: tags: - v0.1.0 summary: Adds a new user requestBody: content: - application/xml: + application/json: schema: $ref: '#/components/schemas/REQUEST' responses: '200': description: Ok content: - application/xml: + application/json: schema: $ref: '#/components/schemas/success' example: |+ From f08c680a653480391cff9ca1c13ee2f30ff7a914 Mon Sep 17 00:00:00 2001 From: Mohamed Luqman <57977684+mohamedSent@users.noreply.github.com> Date: Mon, 15 Mar 2021 15:41:25 +0530 Subject: [PATCH 709/792] Update d&b_business_check_sg.yaml --- data/d&b_business_check_sg.yaml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/data/d&b_business_check_sg.yaml b/data/d&b_business_check_sg.yaml index ce5765a22..1e768ee7a 100644 --- a/data/d&b_business_check_sg.yaml +++ b/data/d&b_business_check_sg.yaml @@ -25,14 +25,14 @@ paths: summary: Adds a new user requestBody: content: - application/json: + application/xml: schema: $ref: '#/components/schemas/REQUEST' responses: '200': description: Ok content: - application/json: + application/xml: schema: $ref: '#/components/schemas/success' example: |+ From fb3b347b51a5a1592666ff948b8747ffca65dac5 Mon Sep 17 00:00:00 2001 From: rameshsentient <51635015+rameshsentient@users.noreply.github.com> Date: Mon, 15 Mar 2021 15:48:34 +0530 Subject: [PATCH 710/792] Update automatic_speech_recognition_chi_sg_V1.0.yaml --- voice/automatic_speech_recognition_chi_sg_V1.0.yaml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/voice/automatic_speech_recognition_chi_sg_V1.0.yaml b/voice/automatic_speech_recognition_chi_sg_V1.0.yaml index de68d5b7f..d8e19c07a 100644 --- a/voice/automatic_speech_recognition_chi_sg_V1.0.yaml +++ b/voice/automatic_speech_recognition_chi_sg_V1.0.yaml @@ -40,7 +40,7 @@ paths: message: Successfully Processed status: Success results: - output: " 和 许诺 的 含着 那 主力 候补 含住 探测 好的 海里 的 非礼\n" + output: "和 许诺 的 含着 那 主力 候补 含住 探测 好的 海里 的 非礼" '401': description: Unauthorized content: @@ -114,7 +114,7 @@ components: properties: output: type: string - example: 各位同学朋友老师教授大家好我叫墓园 + example: 和 许诺 的 含着 那 主力 候补 含住 探测 好的 海里 的 非礼 description: converted text status: type: string From 09b181cf0e9daca01e5868161a4bdd6f3e548271 Mon Sep 17 00:00:00 2001 From: Mohamed Luqman <57977684+mohamedSent@users.noreply.github.com> Date: Mon, 15 Mar 2021 15:50:18 +0530 Subject: [PATCH 711/792] Update d&b_business_check_sg.yaml --- data/d&b_business_check_sg.yaml | 27 ++++++++++----------------- 1 file changed, 10 insertions(+), 17 deletions(-) diff --git a/data/d&b_business_check_sg.yaml b/data/d&b_business_check_sg.yaml index 1e768ee7a..3ba7f0a9a 100644 --- a/data/d&b_business_check_sg.yaml +++ b/data/d&b_business_check_sg.yaml @@ -1103,28 +1103,21 @@ components: REQUEST: type: object properties: - TOT_ITEMS: + total_items: type: number example: 1 description: Number of subjects being enquired relating to the Run default: false - ENQUIRY: - type: object - example: |+ - 197601887ETRANSTAR TRAVEL PTE LTD - description: Contains information of each request details + subject_idno: + type: string + example: 199707714C + description: "Subject’s ID Number (individual) or Registration Number (company/business) as captured in DDP" default: true - properties: - SUBJECT_IDNO: - type: string - example: 199707714C - description: "Subject’s ID Number (individual) or Registration Number (company/business) as captured in DDP" - default: true - SUBJECT_NAME: - type: string - example: GPS INDUSTRIES PTE LTD - description: Subjects Name as captured in DDP - default: false + subject_name: + type: string + example: GPS INDUSTRIES PTE LTD + description: Subjects Name as captured in DDP + default: false versions: type: object properties: From dd477244483a67fc89abce5faf7cef4b3782401c Mon Sep 17 00:00:00 2001 From: Mohamed Luqman <57977684+mohamedSent@users.noreply.github.com> Date: Mon, 15 Mar 2021 15:55:58 +0530 Subject: [PATCH 712/792] Update d&b_business_check_sg.yaml --- data/d&b_business_check_sg.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/data/d&b_business_check_sg.yaml b/data/d&b_business_check_sg.yaml index 3ba7f0a9a..ad85f65aa 100644 --- a/data/d&b_business_check_sg.yaml +++ b/data/d&b_business_check_sg.yaml @@ -25,7 +25,7 @@ paths: summary: Adds a new user requestBody: content: - application/xml: + application/json: schema: $ref: '#/components/schemas/REQUEST' responses: From 97921fe15f1ad3b8e40de0ef55f4290f3864cd04 Mon Sep 17 00:00:00 2001 From: Mohamed Luqman <57977684+mohamedSent@users.noreply.github.com> Date: Mon, 15 Mar 2021 16:23:31 +0530 Subject: [PATCH 713/792] Update d&b_business_check_sg.yaml --- data/d&b_business_check_sg.yaml | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/data/d&b_business_check_sg.yaml b/data/d&b_business_check_sg.yaml index ad85f65aa..0d6e779ee 100644 --- a/data/d&b_business_check_sg.yaml +++ b/data/d&b_business_check_sg.yaml @@ -27,7 +27,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/REQUEST' + $ref: '#/components/schemas/REQUEST' + required: true responses: '200': description: Ok From 9ea7a9ef447c670873619908be8e386e113d209a Mon Sep 17 00:00:00 2001 From: Mohamed Luqman <57977684+mohamedSent@users.noreply.github.com> Date: Mon, 15 Mar 2021 16:28:05 +0530 Subject: [PATCH 714/792] Update d&b_business_check_sg.yaml --- data/d&b_business_check_sg.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/data/d&b_business_check_sg.yaml b/data/d&b_business_check_sg.yaml index 0d6e779ee..6e3874044 100644 --- a/data/d&b_business_check_sg.yaml +++ b/data/d&b_business_check_sg.yaml @@ -25,7 +25,7 @@ paths: summary: Adds a new user requestBody: content: - application/json: + application/xml: schema: $ref: '#/components/schemas/REQUEST' required: true From 1f98fc51241a8df6904551a2fd689ef636875b80 Mon Sep 17 00:00:00 2001 From: Mohamed Luqman <57977684+mohamedSent@users.noreply.github.com> Date: Mon, 15 Mar 2021 16:41:39 +0530 Subject: [PATCH 715/792] Update d&b_business_check_sg.yaml --- data/d&b_business_check_sg.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/data/d&b_business_check_sg.yaml b/data/d&b_business_check_sg.yaml index 6e3874044..d991310c5 100644 --- a/data/d&b_business_check_sg.yaml +++ b/data/d&b_business_check_sg.yaml @@ -33,7 +33,7 @@ paths: '200': description: Ok content: - application/xml: + application/json: schema: $ref: '#/components/schemas/success' example: |+ From aaaa94b8ec75efd866142675ee0641dfb07ff870 Mon Sep 17 00:00:00 2001 From: Mohamed Luqman <57977684+mohamedSent@users.noreply.github.com> Date: Tue, 16 Mar 2021 08:35:28 +0530 Subject: [PATCH 716/792] updated url --- data/amenities_hardcourts_hdb_sg.yaml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/data/amenities_hardcourts_hdb_sg.yaml b/data/amenities_hardcourts_hdb_sg.yaml index 6149a2b04..8b0fc4702 100644 --- a/data/amenities_hardcourts_hdb_sg.yaml +++ b/data/amenities_hardcourts_hdb_sg.yaml @@ -37,12 +37,12 @@ info: | Shape__Length | Float | N/A | Length of the feature | version: '0.1.0' servers: - - url: 'https://api.sentient.io' + - url: 'https://dev-apis.sentient.io' tags: - name: "v0.1.0" description: "Published Date - Mar 24, 2020" paths: - /DaaS/prod/hdb/amenities/gs/csv/hardcourt/hdb: + /microservices/data/hardcourt/v0/getdata: get: tags: - v0.1.0 From 83386ec1ae3484f775ee52d296ebdd826c472d30 Mon Sep 17 00:00:00 2001 From: Mohamed Luqman <57977684+mohamedSent@users.noreply.github.com> Date: Tue, 16 Mar 2021 08:41:47 +0530 Subject: [PATCH 717/792] Update amenities_hardcourts_hdb_sg.yaml --- data/amenities_hardcourts_hdb_sg.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/data/amenities_hardcourts_hdb_sg.yaml b/data/amenities_hardcourts_hdb_sg.yaml index 8b0fc4702..d5f1ac9f0 100644 --- a/data/amenities_hardcourts_hdb_sg.yaml +++ b/data/amenities_hardcourts_hdb_sg.yaml @@ -50,7 +50,7 @@ paths: '200': description: Ok content: - application/json: + application/json : schema: $ref: '#/components/schemas/success' example: From 1a068c361fa38e20692ae68cf854ee34fd8028a7 Mon Sep 17 00:00:00 2001 From: Mohamed Luqman <57977684+mohamedSent@users.noreply.github.com> Date: Tue, 16 Mar 2021 09:26:25 +0530 Subject: [PATCH 718/792] Update d&b_brief_financial_information_sg.yaml --- data/d&b_brief_financial_information_sg.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/data/d&b_brief_financial_information_sg.yaml b/data/d&b_brief_financial_information_sg.yaml index 1a446842d..bdb008f3f 100644 --- a/data/d&b_brief_financial_information_sg.yaml +++ b/data/d&b_brief_financial_information_sg.yaml @@ -22,7 +22,7 @@ paths: summary: Adds a new user requestBody: content: - application/xml: + application/json: schema: $ref: '#/components/schemas/REQUEST' responses: From a22e3b08f2f9f8b83810e09deeea38dc3c7729f5 Mon Sep 17 00:00:00 2001 From: Mohamed Luqman <57977684+mohamedSent@users.noreply.github.com> Date: Tue, 16 Mar 2021 09:29:43 +0530 Subject: [PATCH 719/792] Update d&b_brief_financial_information_sg.yaml --- data/d&b_brief_financial_information_sg.yaml | 27 ++++++++------------ 1 file changed, 10 insertions(+), 17 deletions(-) diff --git a/data/d&b_brief_financial_information_sg.yaml b/data/d&b_brief_financial_information_sg.yaml index bdb008f3f..41ccc7398 100644 --- a/data/d&b_brief_financial_information_sg.yaml +++ b/data/d&b_brief_financial_information_sg.yaml @@ -1363,28 +1363,21 @@ components: REQUEST: type: object properties: - TOT_ITEMS: + total_items: type: number example: 1 description: Number of subjects being enquired relating to the Run default: false - ENQUIRY: - type: object - example: |+ - "197601887ETRANSTAR TRAVEL PTE LTD" - description: Contains information of each request details + subject_idno: + type: string + example: 199707714C + description: "Subject’s ID Number (individual) or Registration Number (company/business) as captured in DDP" default: true - properties: - SUBJECT_IDNO: - type: string - example: 199707714C - description: "Subject’s ID Number (individual) or Registration Number (company/business) as captured in DDP" - default: true - SUBJECT_NAME: - type: string - example: GPS INDUSTRIES PTE LTD - description: Subjects Name as captured in DDP - default: false + subject_name: + type: string + example: GPS INDUSTRIES PTE LTD + description: Subjects Name as captured in DDP + default: false versions: type: object properties: From 032a65ba5304368ebbff5463fd4d035000dad231 Mon Sep 17 00:00:00 2001 From: Mohamed Luqman <57977684+mohamedSent@users.noreply.github.com> Date: Tue, 16 Mar 2021 09:33:05 +0530 Subject: [PATCH 720/792] Update d&b_brief_financial_information_sg.yaml --- data/d&b_brief_financial_information_sg.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/data/d&b_brief_financial_information_sg.yaml b/data/d&b_brief_financial_information_sg.yaml index 41ccc7398..38bf9f6d1 100644 --- a/data/d&b_brief_financial_information_sg.yaml +++ b/data/d&b_brief_financial_information_sg.yaml @@ -22,7 +22,7 @@ paths: summary: Adds a new user requestBody: content: - application/json: + application/xml: schema: $ref: '#/components/schemas/REQUEST' responses: From 5d39fa52bd1173b09dc607516567381f4914ef92 Mon Sep 17 00:00:00 2001 From: Mohamed Luqman <57977684+mohamedSent@users.noreply.github.com> Date: Tue, 16 Mar 2021 09:50:27 +0530 Subject: [PATCH 721/792] Update d&b_brief_financial_information_sg.yaml --- data/d&b_brief_financial_information_sg.yaml | 70 ++++++++++++-------- 1 file changed, 42 insertions(+), 28 deletions(-) diff --git a/data/d&b_brief_financial_information_sg.yaml b/data/d&b_brief_financial_information_sg.yaml index 38bf9f6d1..bbb275f47 100644 --- a/data/d&b_brief_financial_information_sg.yaml +++ b/data/d&b_brief_financial_information_sg.yaml @@ -32,34 +32,48 @@ paths: application/xml: schema: $ref: '#/components/schemas/success' - example: |+ - - 25/02/2009 17:31:44> - - - 2009-04-21 10:56:06.716 - 2004 2003 2002 2005 - 2006 2007 2008 2009 2008 2007 2006 2005 2004 - - 9403795.00 8617168.00 7807393.00 31467.00 162620.00 1281387.00 31467.00 162620.00 1281387.00 0.00 0.00 60318.00> 31467.00 162620.00 1341705.00 3889213.00 3395740.00 4374368.00 3359007.00 2855754.00 3546381.00 530206.00 539986.00 827987.00> 7370430.00 6845490.00 7661498.00 6739073.00 6157560.00 6435365.00 631357.00 687930.00 122133.00 -3481217.00 -3449750.00 -3287130.00 2000000.00 2000000.00 2000000.00 0.00 0.00 0.00 5481217.00 5449750.00 5287130.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 - 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 - - 10877254.00 9982533.00 1121483.00 262632.00 1347380.00 262632.00 6562990.00 5424551.00 6283449.00 4948821.00 279541.00 475730.00 8434195.00 8643136.00 8434195.00 7933013.00 0.00 710123.00 -1871205.00 -3218585.00 2000000.00 2000000.00 0.00 0.00 -3,871,205.00 -5,218,585.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 - 0.00 0.00 0.00 0.00 - - 12.39 2.63 0.00 0.00 0.00 20.53 4.84 0.00 0.00 0.00 -72.01 -8.16 -0.00 -0.00 -0.00 1.66 1.84 2.42 2.54 1.78 0.74 0.62 0.50 0.46 0.55 -28.51 -59.33 -89.51 -101.59 -75.15 128.51 168.27 189.51 201.59 175.15 - - 1121483.0 10877254 2008 - - 262632.0> 9982533 2007 - - -31467.0 9403795 2006 - - -162620.0 8617168 2005 - - -1281387.0 7807393 2004 - - + example: + message: Successfully Processed + results: + REPORT: + FH_DTL: + FH_RATIOS_DTL: + FH_SEARCH_INFO: + COMP_NAME: + "#text": MENNAPPAN COMPANY + "@type": String + REG_NO: + "#text": 00007400D + "@type": String + REQ_DATE: + "#text": 24/09/2019 20:27:06 + "@type": String + REQ_DATE_STR: + "#text": 24/09/2019 20:27:06 + "@type": String + REQ_NAME: + "#text": "-" + "@type": String + REQ_REG_NO: + "#text": 00007400D + "@type": String + LIST_FH_CHART_INFO: + META_INFO: + CREATION_DATE: + "#text": 24/09/2019 20:27:06 + "@type": String + SERVICE: + "#text": BFE + "@type": String + SYSTEM_ID: + "#text": DDP + "@type": String + USER_ID: + "#text": B2BSENTIENT + "@type": String + XBRL_DTL: + status: Success + '401': description: Unauthorized content: From 6f07fe1f12b19a7d6a56e62f0d65f09ef5028147 Mon Sep 17 00:00:00 2001 From: Mohamed Luqman <57977684+mohamedSent@users.noreply.github.com> Date: Tue, 16 Mar 2021 10:00:20 +0530 Subject: [PATCH 722/792] Update d&b_brief_financial_information_sg.yaml --- data/d&b_brief_financial_information_sg.yaml | 26 ++++++++++++-------- 1 file changed, 16 insertions(+), 10 deletions(-) diff --git a/data/d&b_brief_financial_information_sg.yaml b/data/d&b_brief_financial_information_sg.yaml index bbb275f47..4163f379e 100644 --- a/data/d&b_brief_financial_information_sg.yaml +++ b/data/d&b_brief_financial_information_sg.yaml @@ -29,7 +29,7 @@ paths: '200': description: Ok content: - application/xml: + application/json: schema: $ref: '#/components/schemas/success' example: @@ -72,8 +72,7 @@ paths: "#text": B2BSENTIENT "@type": String XBRL_DTL: - status: Success - + status: Success '401': description: Unauthorized content: @@ -155,13 +154,20 @@ components: SYSTEM_ID CREATION_DATE USER_ID - example: |+ - - - - 25/02/2009 17:31:44> - - + example: + META_INFO: + CREATION_DATE: + "#text": 24/09/2019 20:27:06 + "@type": String + SERVICE: + "#text": BFE + "@type": String + SYSTEM_ID: + "#text": DDP + "@type": String + USER_ID: + "#text": B2BSENTIENT + "@type": String properties: SERVICE: type: string From bead3afd2c1af8f10eb55f7c08c61428b1c32a1a Mon Sep 17 00:00:00 2001 From: Mohamed Luqman <57977684+mohamedSent@users.noreply.github.com> Date: Tue, 16 Mar 2021 11:49:50 +0530 Subject: [PATCH 723/792] Update amenities_hardcourts_hdb_sg.yaml --- data/amenities_hardcourts_hdb_sg.yaml | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/data/amenities_hardcourts_hdb_sg.yaml b/data/amenities_hardcourts_hdb_sg.yaml index d5f1ac9f0..6149a2b04 100644 --- a/data/amenities_hardcourts_hdb_sg.yaml +++ b/data/amenities_hardcourts_hdb_sg.yaml @@ -37,12 +37,12 @@ info: | Shape__Length | Float | N/A | Length of the feature | version: '0.1.0' servers: - - url: 'https://dev-apis.sentient.io' + - url: 'https://api.sentient.io' tags: - name: "v0.1.0" description: "Published Date - Mar 24, 2020" paths: - /microservices/data/hardcourt/v0/getdata: + /DaaS/prod/hdb/amenities/gs/csv/hardcourt/hdb: get: tags: - v0.1.0 @@ -50,7 +50,7 @@ paths: '200': description: Ok content: - application/json : + application/json: schema: $ref: '#/components/schemas/success' example: From d5d1137443a156fdcecb9efe977f8e0cc3f954f1 Mon Sep 17 00:00:00 2001 From: Mohamed Luqman <57977684+mohamedSent@users.noreply.github.com> Date: Tue, 16 Mar 2021 12:07:35 +0530 Subject: [PATCH 724/792] initial commit of new version 1.0 --- data/amenities_hardcourts_hdb_sg_v1.0.yaml | 243 +++++++++++++++++++++ 1 file changed, 243 insertions(+) create mode 100644 data/amenities_hardcourts_hdb_sg_v1.0.yaml diff --git a/data/amenities_hardcourts_hdb_sg_v1.0.yaml b/data/amenities_hardcourts_hdb_sg_v1.0.yaml new file mode 100644 index 000000000..e9b03e5f8 --- /dev/null +++ b/data/amenities_hardcourts_hdb_sg_v1.0.yaml @@ -0,0 +1,243 @@ +openapi: 3.0.1 +info: + title: HDB Hardcourts Locations (SG) + x-subscribelink: amenities_hardcourts_hdb_sg + description: |+ + This Data microservice returns the indicative outline of hardcourts for all Housing Development Board of Singapore (HDB) Towns, HDB Estates and on HDB Land. The features were identified visually from high definition ortho-rectified aerial imagery and manually digitised. The imagery was obtained from Singapore Land Authority (SLA) (captured in 2014). Objects largely obstructed by trees, structures and / or shadow are likely not captured in this dataset. The outlines of partially obstructed objects were extrapolated where possible and may not fully represent the actual shape of the actual object. + As this is a dataset download microservice, a successful call will return a pre-signed URL where the entire dataset can be downloaded as a CSV file. + The HDB POTH programme makes selected public and non-public datasets available to developers and companies to improve their service offerings to benefit the lives of Singapore citizens. Sentient.io is proud to partner with HDB to manage and facilitate the sharing of data for the POTH Programme. + x-additionalinfo: |+ + Suggested Use Cases: + - Real estate services - can be used as a solution to extract information related to the types and number of hardcourts present in an area for people buying or renting a HDB home. + + Download the complete dataset using a pre-signed URL. It's a two steps process + + **Step 1:** Get the pre-signed URL + + Replace the correct x-api-key, and API endpoint + + > **curl -X GET -H "Content-Type: application/json" -H "x-api-key:XXXXX" <\>** + + **Step 2:** Download file + + Using the results.url (i.e) the pre-signed URL to download the dataset + + > **curl --request GET "results.url" >> "FILE_NAME"** + + **Data schema** + + | Name | Type | Size | Description | + |---|---|---|---|---| + | FEATID | Integer | N/A | Feature ID. Unique running number. | + | TYPE | Char | N/A | Captures the type of object. | + | LVL | Char | N/A | Captures whether the object is located at Ground level or Above Ground level. | + | QUALITY | Char | N/A | Captures whether the section of the feature was Fully Visible or Partially Visible. | + | INC_CRC | Varchar | 50 | Sub Location Id | + | FMEL_UPD_D | Datetime | N/A | Area of the feature | + | Shape__Length | Float | N/A | Length of the feature | + version: '0.1.0' +servers: + - url: 'https://api.sentient.io' +tags: +- name: "v0.1.0" + description: "Published Date - Mar 24, 2020" +paths: + /DaaS/prod/hdb/amenities/gs/csv/hardcourt/hdb: + get: + tags: + - v0.1.0 + responses: + '200': + description: Ok + content: + application/json: + schema: + $ref: '#/components/schemas/success' + example: + results: + url: "" + status: Success + message: Successfully Processed + '401': + description: Unauthorized + content: + application/json: + schema: + $ref: '#/components/schemas/unauthorized' + '402': + description: Payment Required + content: + application/json: + schema: + $ref: '#/components/schemas/paymentrequired' + '403': + description: Forbidden + content: + application/json: + schema: + $ref: '#/components/schemas/forbidden' + '404': + description: Not Found + content: + application/json: + schema: + $ref: '#/components/schemas/notfound' + '419': + description: Input Field Missing + content: + application/json: + schema: + $ref: '#/components/schemas/inputfieldmissing' + '413': + description: Payload Too Large + content: + application/json: + schema: + $ref: '#/components/schemas/inputlimitexceeded' + '415': + description: Unsupported Media Type + content: + application/json: + schema: + $ref: '#/components/schemas/invalidinput' + '500': + description: Internal Server Error + content: + application/json: + schema: + $ref: '#/components/schemas/servererror' + '504': + description: Gateway Timeout + content: + application/json: + schema: + $ref: '#/components/schemas/gatewaytimeout' + security: + - APIAuthorizer: [] +components: + schemas: + success: + type: object + properties: + results: + type: object + example: { "" } + description: Json Object of returned results + properties: + url: + type: string + description: pre-signed URL to download the file + example: "" + status: + type: string + example: Success + description: The status of the API call. success/failure + message: + type: string + example: Successfully Processed + description: Detail description on the api status + unauthorized: + type: object + properties: + message: + type: string + example: Missing Authentication Token + status: + type: string + example: Failure + forbidden: + type: object + properties: + message: + type: string + example: Access Denied Unauthorized User + status: + type: string + example: Failure + paymentrequired: + type: object + properties: + message: + type: string + example: Insufficient Credits Kindly Top Up + status: + type: string + example: Failure + notfound: + type: object + properties: + message: + type: string + example: Invalid Request URL + status: + type: string + example: Failure + servererror: + type: object + properties: + message: + type: string + example: Internal Server Error + status: + type: string + example: Failure + gatewaytimeout: + type: object + properties: + message: + type: string + example: Request Timeout + status: + type: string + example: Failure + inputfieldmissing: + type: object + properties: + message: + type: string + example: Input Field Missing + status: + type: string + example: Failure + inputlimitexceeded: + type: object + properties: + message: + type: string + example: Input Limit Exceeded + status: + type: string + example: Failure + invalidinput: + type: object + properties: + message: + type: string + example: Invalid Input + status: + type: string + example: Failure + versions: + type: object + properties: + v1.0.0: + type: array + items: + oneOf: + - type: string + example: Published Date - Apr 09, 2021 + description: Optimization done + v0.1.0: + type: array + items: + oneOf: + - type: string + example: Published Date - Mar 24, 2020 + description: Initial version release + securitySchemes: + APIAuthorizer: + type: apiKey + name: x-api-key + in: header + x-amazon-apigateway-authtype: custom + description: Authentication is done using the x-api-key in the request header. From 7e831e135c024de07c9e8eaf46839f6b79231e42 Mon Sep 17 00:00:00 2001 From: Mohamed Luqman <57977684+mohamedSent@users.noreply.github.com> Date: Tue, 16 Mar 2021 12:13:54 +0530 Subject: [PATCH 725/792] Update amenities_hardcourts_hdb_sg_v1.0.yaml --- data/amenities_hardcourts_hdb_sg_v1.0.yaml | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/data/amenities_hardcourts_hdb_sg_v1.0.yaml b/data/amenities_hardcourts_hdb_sg_v1.0.yaml index e9b03e5f8..59fff963a 100644 --- a/data/amenities_hardcourts_hdb_sg_v1.0.yaml +++ b/data/amenities_hardcourts_hdb_sg_v1.0.yaml @@ -35,17 +35,17 @@ info: | INC_CRC | Varchar | 50 | Sub Location Id | | FMEL_UPD_D | Datetime | N/A | Area of the feature | | Shape__Length | Float | N/A | Length of the feature | - version: '0.1.0' + version: '1.0.0' servers: - - url: 'https://api.sentient.io' + - url: 'https://dev-apis.sentient.io' tags: -- name: "v0.1.0" - description: "Published Date - Mar 24, 2020" +- name: "v1.0.0" + description: "Published Date - Apr 09, 2021" paths: - /DaaS/prod/hdb/amenities/gs/csv/hardcourt/hdb: + /microservices/data/hardcourt/v0/getdata: get: tags: - - v0.1.0 + - v1.0.0 responses: '200': description: Ok From 502ba3554e29d120223c67a1536d5ef00dd5eaf4 Mon Sep 17 00:00:00 2001 From: Mohamed Luqman <57977684+mohamedSent@users.noreply.github.com> Date: Tue, 16 Mar 2021 12:19:53 +0530 Subject: [PATCH 726/792] Update index.yaml --- index.yaml | 1 + 1 file changed, 1 insertion(+) diff --git a/index.yaml b/index.yaml index d19c95c88..ae5c65a89 100644 --- a/index.yaml +++ b/index.yaml @@ -256,6 +256,7 @@ data: amenities_hardcourts_hdb_sg: title: HDB Hardcourts Locations (SG) versions: + 1.0.0: 'amenities_hardcourts_hdb_sg_v1.0.yaml' 0.1.0: 'amenities_hardcourts_hdb_sg.yaml' amenities_shelters_hdb_sg: title: HDB Shelters Locations (SG) From 748de840c86e98c6162bfcd24482b91472a62dba Mon Sep 17 00:00:00 2001 From: Mohamed Luqman <57977684+mohamedSent@users.noreply.github.com> Date: Tue, 16 Mar 2021 12:24:03 +0530 Subject: [PATCH 727/792] Update amenities_hardcourts_hdb_sg_v1.0.yaml --- data/amenities_hardcourts_hdb_sg_v1.0.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/data/amenities_hardcourts_hdb_sg_v1.0.yaml b/data/amenities_hardcourts_hdb_sg_v1.0.yaml index 59fff963a..2f67e7cc0 100644 --- a/data/amenities_hardcourts_hdb_sg_v1.0.yaml +++ b/data/amenities_hardcourts_hdb_sg_v1.0.yaml @@ -226,7 +226,7 @@ components: oneOf: - type: string example: Published Date - Apr 09, 2021 - description: Optimization done + description: Optimized release v0.1.0: type: array items: From 3dd7bbb803f758a5af6d0ab25f091ee19ae76d81 Mon Sep 17 00:00:00 2001 From: Mohamed Luqman <57977684+mohamedSent@users.noreply.github.com> Date: Tue, 16 Mar 2021 14:08:11 +0530 Subject: [PATCH 728/792] initial commit of version1 --- data/amenities_lamp_posts_hdb_sg_v1.0.yaml | 245 +++++++++++++++++++++ 1 file changed, 245 insertions(+) create mode 100644 data/amenities_lamp_posts_hdb_sg_v1.0.yaml diff --git a/data/amenities_lamp_posts_hdb_sg_v1.0.yaml b/data/amenities_lamp_posts_hdb_sg_v1.0.yaml new file mode 100644 index 000000000..5506ad54c --- /dev/null +++ b/data/amenities_lamp_posts_hdb_sg_v1.0.yaml @@ -0,0 +1,245 @@ +openapi: 3.0.1 +info: + title: HDB Lamp Posts Locations (SG) + x-subscribelink: amenities_lamp_posts_hdb_sg + description: |+ + This Data microservice returns the indicative location of lamp posts for all Housing Development Board of Singapore (HDB) Towns, HDB Estates and on HDB Land. The features were identified visually from high definition ortho-rectified aerial imagery and manually digitised. The imagery was obtained from Singapore Land Authority (SLA) (captured in 2014). Objects largely obstructed by trees, structures and / or shadow are likely not captured in this dataset. + As this is a dataset download microservice, a successful call will return a pre-signed URL where the entire dataset can be downloaded as a CSV file. + The HDB POTH programme makes selected public and non-public datasets available to developers and companies to improve their service offerings to benefit the lives of Singapore citizens. Sentient.io is proud to partner with HDB to manage and facilitate the sharing of data for the POTH Programme. + x-additionalinfo: |+ + Suggested Use Cases: + - Real estate services or social service solutions - can be used as a background check solution to extract information related to lampposts present in an area for people with certain preferences when buying or renting a HDB home. For example, the elderly may prefer HDB homes surrounded with more lampposts as they require more aid in terms of lighting when walking home. + + Download the complete dataset using a pre-signed URL. It's a two steps process + + **Step 1:** Get the pre-signed URL + + Replace the correct x-api-key, and API endpoint + + > **curl -X GET -H "Content-Type: application/json" -H "x-api-key:XXXXX" ** + + **Step 2:** Download file + + Using the results.url (i.e) the pre-signed URL to download the dataset + + > **curl --request GET "results.url" >> "FILE_NAME"** + + **Data schema** + + | Name | Type | Size | Description | + |---|---|---|---|---| + | FEATID | Integer | N/A | Feature ID. Unique running number. | + | TYPE | Char | N/A | Captures the type of object. | + | LVL | Char | N/A | Captures whether the object is located at Ground level or Above Ground level. | + | QUALITY | Char | N/A | Captures whether the section of the feature was Fully Visible or Partially Visible. | + | INC_CRC | Varchar | 50 | Sub Location Id | + | FMEL_UPD_D | Datetime | N/A | Area of the feature | + | x | Float | N/A | ESRI x coordinate | + | y | Float | N/A | ESRI y coordinate | + version: '1.0.0' +servers: + - url: 'https://dev-apis.sentient.io' +tags: +- name: "v1.0.0" + description: "Published Date - Apr 09, 2021" + +paths: + /microservices/data/lamppost/v0/getdata: + get: + tags: + - v1.0.0 + responses: + '200': + description: Ok + content: + application/json: + schema: + $ref: '#/components/schemas/success' + example: + results: + url: "" + status: Success + message: Successfully Processed + '401': + description: Unauthorized + content: + application/json: + schema: + $ref: '#/components/schemas/unauthorized' + '402': + description: Payment Required + content: + application/json: + schema: + $ref: '#/components/schemas/paymentrequired' + '403': + description: Forbidden + content: + application/json: + schema: + $ref: '#/components/schemas/forbidden' + '404': + description: Not Found + content: + application/json: + schema: + $ref: '#/components/schemas/notfound' + '419': + description: Input Field Missing + content: + application/json: + schema: + $ref: '#/components/schemas/inputfieldmissing' + '413': + description: Payload Too Large + content: + application/json: + schema: + $ref: '#/components/schemas/inputlimitexceeded' + '415': + description: Unsupported Media Type + content: + application/json: + schema: + $ref: '#/components/schemas/invalidinput' + '500': + description: Internal Server Error + content: + application/json: + schema: + $ref: '#/components/schemas/servererror' + '504': + description: Gateway Timeout + content: + application/json: + schema: + $ref: '#/components/schemas/gatewaytimeout' + security: + - APIAuthorizer: [] +components: + schemas: + success: + type: object + properties: + results: + type: object + example: { "" } + description: Json Object of returned results + properties: + url: + type: string + description: pre-signed URL to download the file + example: "" + status: + type: string + example: Success + description: The status of the API call. success/failure + message: + type: string + example: Successfully Processed + description: Detail description on the api status + unauthorized: + type: object + properties: + message: + type: string + example: Missing Authentication Token + status: + type: string + example: Failure + forbidden: + type: object + properties: + message: + type: string + example: Access Denied Unauthorized User + status: + type: string + example: Failure + paymentrequired: + type: object + properties: + message: + type: string + example: Insufficient Credits Kindly Top Up + status: + type: string + example: Failure + notfound: + type: object + properties: + message: + type: string + example: Invalid Request URL + status: + type: string + example: Failure + servererror: + type: object + properties: + message: + type: string + example: Internal Server Error + status: + type: string + example: Failure + gatewaytimeout: + type: object + properties: + message: + type: string + example: Request Timeout + status: + type: string + example: Failure + inputfieldmissing: + type: object + properties: + message: + type: string + example: Input Field Missing + status: + type: string + example: Failure + inputlimitexceeded: + type: object + properties: + message: + type: string + example: Input Limit Exceeded + status: + type: string + example: Failure + invalidinput: + type: object + properties: + message: + type: string + example: Invalid Input + status: + type: string + example: Failure + versions: + type: object + properties: + v1.0.0: + type: array + items: + oneOf: + - type: string + example: Published Date - Apr 09, 2021 + description: Optimized release + v0.1.0: + type: array + items: + oneOf: + - type: string + example: Published Date - Mar 24, 2020 + description: Initial version release + securitySchemes: + APIAuthorizer: + type: apiKey + name: x-api-key + in: header + x-amazon-apigateway-authtype: custom + description: Authentication is done using the x-api-key in the request header. From 5c0426514e618bd23e0d86751bb0e69bf2d9b5a2 Mon Sep 17 00:00:00 2001 From: Mohamed Luqman <57977684+mohamedSent@users.noreply.github.com> Date: Tue, 16 Mar 2021 14:09:42 +0530 Subject: [PATCH 729/792] Update index.yaml --- index.yaml | 1 + 1 file changed, 1 insertion(+) diff --git a/index.yaml b/index.yaml index ae5c65a89..f74b668b6 100644 --- a/index.yaml +++ b/index.yaml @@ -252,6 +252,7 @@ data: amenities_lamp_posts_hdb_sg: title: HDB Lamp Posts Locations (SG) versions: + 1.0.0: 'amenities_lamp_posts_hdb_sg_v1.0.yaml' 0.1.0: 'amenities_lamp_posts_hdb_sg.yaml' amenities_hardcourts_hdb_sg: title: HDB Hardcourts Locations (SG) From 7a445980a339a82cd9023a8bf9b7487ec3aa92a6 Mon Sep 17 00:00:00 2001 From: Mohamed Luqman <57977684+mohamedSent@users.noreply.github.com> Date: Tue, 16 Mar 2021 14:17:04 +0530 Subject: [PATCH 730/792] Create amenities_shelters_hdb_sg_v1.0.yaml --- data/amenities_shelters_hdb_sg_v1.0.yaml | 246 +++++++++++++++++++++++ 1 file changed, 246 insertions(+) create mode 100644 data/amenities_shelters_hdb_sg_v1.0.yaml diff --git a/data/amenities_shelters_hdb_sg_v1.0.yaml b/data/amenities_shelters_hdb_sg_v1.0.yaml new file mode 100644 index 000000000..c0c339c4e --- /dev/null +++ b/data/amenities_shelters_hdb_sg_v1.0.yaml @@ -0,0 +1,246 @@ +openapi: 3.0.1 +info: + title: HDB Shelters Locations (SG) + x-subscribelink: amenities_shelters_hdb_sg + description: |+ + This Data microservice returns the indicative outline of shelters for all HDB Towns and Estates and only on HDB Land. The features were identified visually from high definition ortho-rectified aerial imagery and manually digitised. The imagery was obtained from SLA (captured in 2014). Objects largely obstructed by trees, structures and / or shadow are likely not captured in this dataset. The outlines of partially obstructed objects were extrapolated where possible and may not fully represent the actual shape of the actual object. Precinct Pavilions are not included in this microservice. + As this is a dataset download microservice, a successful call will return a pre-signed URL where the entire dataset can be downloaded as a CSV file. + The HDB POTH programme makes selected public and non-public datasets available to developers and companies to improve their service offerings to benefit the lives of Singapore citizens. Sentient.io is proud to partner with HDB to manage and facilitate the sharing of data for the POTH Programme. + x-additionalinfo: |+ + Suggested Use Cases: + - Real estate services - can be used as a solution to extract information related to the types and number of shelters present for people buying or renting a HDB home. + - Property background checks - can be used as a background check service for retail shops owners looking to set up their shops in HDBs, as areas with shelters may induce the likelihood of more customers. + - Can also be used as a solution to improve user awareness and personalization - for example, a weather app can refer a user to the nearest HDB shelter in the case of a rainy day. + + Download the complete dataset using a pre-signed URL. It's a two steps process + + **Step 1:** Get the pre-signed URL + + Replace the correct x-api-key, and API endpoint + + > **curl -X GET -H "Content-Type: application/json" -H "x-api-key:XXXXX" <\>** + + **Step 2:** Download file + + Using the results.url (i.e) the pre-signed URL to download the dataset + + > **curl --request GET "results.url" >> "FILE_NAME"** + + **Data schema** + + | Name | Type | Size | Description | + |---|---|---|---|---| + | FEATID | Integer | N/A | Feature ID. Unique running number. | + | TYPE | Char | N/A | Captures the type of object. | + | LVL | Char | N/A | Captures whether the object is located at Ground level or Above Ground level. | + | QUALITY | Char | N/A | Captures whether the section of the feature was Fully Visible or Partially Visible. | + | INC_CRC | Varchar | 50 | Sub Location Id | + | FMEL_UPD_D | Datetime | N/A | Area of the feature | + | Shape__Area | Float | N/A | Area of the feature | + | Shape__Length | Float | N/A | Length of the feature | + version: '1.0.0' +servers: + - url: 'https://dev-apis.sentient.io' +tags: +- name: "v1.0.0" + description: "Published Date - Apr 09, 2021" +paths: + /microservices/data/shelter/v0/getdata: + get: + tags: + - v1.0.0 + responses: + '200': + description: Ok + content: + application/json: + schema: + $ref: '#/components/schemas/success' + example: + results: + url: "" + status: Success + message: Successfully Processed + '401': + description: Unauthorized + content: + application/json: + schema: + $ref: '#/components/schemas/unauthorized' + '402': + description: Payment Required + content: + application/json: + schema: + $ref: '#/components/schemas/paymentrequired' + '403': + description: Forbidden + content: + application/json: + schema: + $ref: '#/components/schemas/forbidden' + '404': + description: Not Found + content: + application/json: + schema: + $ref: '#/components/schemas/notfound' + '419': + description: Input Field Missing + content: + application/json: + schema: + $ref: '#/components/schemas/inputfieldmissing' + '413': + description: Payload Too Large + content: + application/json: + schema: + $ref: '#/components/schemas/inputlimitexceeded' + '415': + description: Unsupported Media Type + content: + application/json: + schema: + $ref: '#/components/schemas/invalidinput' + '500': + description: Internal Server Error + content: + application/json: + schema: + $ref: '#/components/schemas/servererror' + '504': + description: Gateway Timeout + content: + application/json: + schema: + $ref: '#/components/schemas/gatewaytimeout' + security: + - APIAuthorizer: [] +components: + schemas: + success: + type: object + properties: + results: + type: object + example: { "" } + description: Json Object of returned results + properties: + url: + type: string + description: pre-signed URL to download the file + example: "" + status: + type: string + example: Success + description: The status of the API call. success/failure + message: + type: string + example: Successfully Processed + description: Detail description on the api status + unauthorized: + type: object + properties: + message: + type: string + example: Missing Authentication Token + status: + type: string + example: Failure + forbidden: + type: object + properties: + message: + type: string + example: Access Denied Unauthorized User + status: + type: string + example: Failure + paymentrequired: + type: object + properties: + message: + type: string + example: Insufficient Credits Kindly Top Up + status: + type: string + example: Failure + notfound: + type: object + properties: + message: + type: string + example: Invalid Request URL + status: + type: string + example: Failure + servererror: + type: object + properties: + message: + type: string + example: Internal Server Error + status: + type: string + example: Failure + gatewaytimeout: + type: object + properties: + message: + type: string + example: Request Timeout + status: + type: string + example: Failure + inputfieldmissing: + type: object + properties: + message: + type: string + example: Input Field Missing + status: + type: string + example: Failure + inputlimitexceeded: + type: object + properties: + message: + type: string + example: Input Limit Exceeded + status: + type: string + example: Failure + invalidinput: + type: object + properties: + message: + type: string + example: Invalid Input + status: + type: string + example: Failure + versions: + type: object + properties: + v1.0.0: + type: array + items: + oneOf: + - type: string + example: Published Date - Apr 09, 2021 + description: Optimized release + v0.1.0: + type: array + items: + oneOf: + - type: string + example: Published Date - Mar 24, 2020 + description: Initial version release + securitySchemes: + APIAuthorizer: + type: apiKey + name: x-api-key + in: header + x-amazon-apigateway-authtype: custom + description: Authentication is done using the x-api-key in the request header. From 50bb60bd4cce68f4bda2dcaad2923d709175509c Mon Sep 17 00:00:00 2001 From: Mohamed Luqman <57977684+mohamedSent@users.noreply.github.com> Date: Tue, 16 Mar 2021 14:18:04 +0530 Subject: [PATCH 731/792] Update index.yaml --- index.yaml | 1 + 1 file changed, 1 insertion(+) diff --git a/index.yaml b/index.yaml index f74b668b6..24b020af9 100644 --- a/index.yaml +++ b/index.yaml @@ -262,6 +262,7 @@ data: amenities_shelters_hdb_sg: title: HDB Shelters Locations (SG) versions: + 1.0.0: 'amenities_shelters_hdb_sg_v1.0.yaml' 0.1.0: 'amenities_shelters_hdb_sg.yaml' d&b_business_check_plus_sg: title: D&B Business Check Plus (SG) From 7eeb70e8d6038fd41e0a642ffb857ec9c08f1f80 Mon Sep 17 00:00:00 2001 From: Mohamed Luqman <57977684+mohamedSent@users.noreply.github.com> Date: Tue, 16 Mar 2021 14:25:34 +0530 Subject: [PATCH 732/792] initial commit of version1 --- ..._stations_and_playgrounds_hdb_sg_v1.0.yaml | 244 ++++++++++++++++++ 1 file changed, 244 insertions(+) create mode 100644 data/fitness_stations_and_playgrounds_hdb_sg_v1.0.yaml diff --git a/data/fitness_stations_and_playgrounds_hdb_sg_v1.0.yaml b/data/fitness_stations_and_playgrounds_hdb_sg_v1.0.yaml new file mode 100644 index 000000000..b339d1645 --- /dev/null +++ b/data/fitness_stations_and_playgrounds_hdb_sg_v1.0.yaml @@ -0,0 +1,244 @@ +openapi: 3.0.1 +info: + title: HDB Fitness Stations and Playgrounds (SG) + x-subscribelink: fitness_stations_and_playgrounds_hdb_sg + description: |+ + This Data microservice captures the indicative outline of fitness stations/playgrounds for all Housing Development Board of Singapore (HDB) Towns, HDB Estates and on HDB Land. The features were identified visually from high definition ortho-rectified aerial imagery (2014) and manually digitized. Objects largely obstructed by trees, structures and/or shadow are likely not captured in this dataset. The outlines of partially obstructed objects were extrapolated where possible and may not fully represent the actual shape of the actual object. + As this is a dataset download microservice, a successful call will return a pre-signed URL where the entire dataset can be downloaded as a CSV file. + The HDB POTH programme makes selected public and non-public datasets available to developers and companies to improve their service offerings to benefit the lives of Singapore citizens. Sentient.io is proud to partner with HDB to manage and facilitate the sharing of data for the POTH Programme. + x-additionalinfo: |+ + Suggested Use Cases: + - Real estate services - can be used as a background check solution to extract information related to the types and number of fitness stations/playgrounds present in an area for people buying or renting a HDB home. + + Download the complete dataset using a pre-signed URL. It's a two steps process. + + **Step 1:** Get the pre-signed URL + + Replace the correct x-api-key, and API endpoint + + > **curl -X GET -H "Content-Type: application/json" -H "x-api-key:XXXXX" ** + **Step 2:** Download file + + Using the results.url (i.e) the pre-signed URL to download the dataset + + > **curl --request GET "results.url" >> "FILE_NAME"** + + **Data schema** + + | Name | Type | Size | Description | + |---|---|---|---|---| + | FEATID | Integer | N/A | Feature ID. Unique running number. | + | TYPE | Char | N/A | Captures the type of object. | + | LVL | Char | N/A | Captures whether the object is located at Ground level or Above Ground level. | + | QUALITY | Char | N/A | Captures whether the section of the feature was Fully Visible or Partially Visible. | + | INC_CRC | Varchar | 50 | Sub Location Id | + | FMEL_UPD_D | Datetime | N/A | Date Updated | + | Shape__Area | Float | N/A | Area of the feature | + | Shape__Length | Float | N/A | Length of the feature | + + version: '1.0.0' +servers: + - url: 'https://dev-apis.sentient.io' +tags: +- name: "v1.0.0" + description: "Published Date - Apr 09, 2021" +paths: + /microservices/data/fitnessstationplaygrnd/v0/getdata: + get: + tags: + - v1.0.0 + responses: + '200': + description: Ok + content: + application/json: + schema: + $ref: '#/components/schemas/success' + example: + results: + url: "" + status: Success + message: Successfully Processed + '401': + description: Unauthorized + content: + application/json: + schema: + $ref: '#/components/schemas/unauthorized' + '402': + description: Payment Required + content: + application/json: + schema: + $ref: '#/components/schemas/paymentrequired' + '403': + description: Forbidden + content: + application/json: + schema: + $ref: '#/components/schemas/forbidden' + '404': + description: Not Found + content: + application/json: + schema: + $ref: '#/components/schemas/notfound' + '419': + description: Input Field Missing + content: + application/json: + schema: + $ref: '#/components/schemas/inputfieldmissing' + '413': + description: Payload Too Large + content: + application/json: + schema: + $ref: '#/components/schemas/inputlimitexceeded' + '415': + description: Unsupported Media Type + content: + application/json: + schema: + $ref: '#/components/schemas/invalidinput' + '500': + description: Internal Server Error + content: + application/json: + schema: + $ref: '#/components/schemas/servererror' + '504': + description: Gateway Timeout + content: + application/json: + schema: + $ref: '#/components/schemas/gatewaytimeout' + security: + - APIAuthorizer: [] +components: + schemas: + success: + type: object + properties: + results: + type: object + example: { "" } + description: Json Object of returned results + properties: + url: + type: string + description: pre-signed URL to download the file + example: "" + status: + type: string + example: Success + description: The status of the API call. success/failure + message: + type: string + example: Successfully Processed + description: Detail description on the api status + unauthorized: + type: object + properties: + message: + type: string + example: Missing Authentication Token + status: + type: string + example: Failure + forbidden: + type: object + properties: + message: + type: string + example: Access Denied Unauthorized User + status: + type: string + example: Failure + paymentrequired: + type: object + properties: + message: + type: string + example: Insufficient Credits Kindly Top Up + status: + type: string + example: Failure + notfound: + type: object + properties: + message: + type: string + example: Invalid Request URL + status: + type: string + example: Failure + servererror: + type: object + properties: + message: + type: string + example: Internal Server Error + status: + type: string + example: Failure + gatewaytimeout: + type: object + properties: + message: + type: string + example: Request Timeout + status: + type: string + example: Failure + inputfieldmissing: + type: object + properties: + message: + type: string + example: Input Field Missing + status: + type: string + example: Failure + inputlimitexceeded: + type: object + properties: + message: + type: string + example: Input Limit Exceeded + status: + type: string + example: Failure + invalidinput: + type: object + properties: + message: + type: string + example: Invalid Input + status: + type: string + example: Failure + versions: + type: object + properties: + v1.0.0: + type: array + items: + oneOf: + - type: string + example: Published Date - Apr 09, 2021 + description: Optimized release + v0.1.0: + type: array + items: + oneOf: + - type: string + example: Published Date - Mar 24, 2020 + description: Initial version release + securitySchemes: + APIAuthorizer: + type: apiKey + name: x-api-key + in: header + x-amazon-apigateway-authtype: custom + description: Authentication is done using the x-api-key in the request header. From 17a66d049f535c57ce25e68c77cc83f38fc58cb6 Mon Sep 17 00:00:00 2001 From: Mohamed Luqman <57977684+mohamedSent@users.noreply.github.com> Date: Tue, 16 Mar 2021 14:26:37 +0530 Subject: [PATCH 733/792] Update index.yaml --- index.yaml | 1 + 1 file changed, 1 insertion(+) diff --git a/index.yaml b/index.yaml index 24b020af9..95ba10a05 100644 --- a/index.yaml +++ b/index.yaml @@ -248,6 +248,7 @@ data: fitness_stations_and_playgrounds_hdb_sg: title: HDB Fitness Stations and Playgrounds (SG) versions: + 1.0.0: 'fitness_stations_and_playgrounds_hdb_sg_v1.0.yaml' 0.1.0: 'fitness_stations_and_playgrounds_hdb_sg.yaml' amenities_lamp_posts_hdb_sg: title: HDB Lamp Posts Locations (SG) From e773ec551c12d0b0d5324f3fcdc7c7f4d3457e44 Mon Sep 17 00:00:00 2001 From: Mohamed Luqman <57977684+mohamedSent@users.noreply.github.com> Date: Tue, 16 Mar 2021 15:17:06 +0530 Subject: [PATCH 734/792] Update d&b_business_check_sg.yaml --- data/d&b_business_check_sg.yaml | 36 +++++++++++++++++++-------------- 1 file changed, 21 insertions(+), 15 deletions(-) diff --git a/data/d&b_business_check_sg.yaml b/data/d&b_business_check_sg.yaml index d991310c5..a1df33953 100644 --- a/data/d&b_business_check_sg.yaml +++ b/data/d&b_business_check_sg.yaml @@ -13,12 +13,12 @@ info: version: '0.1.0' x-subscribelink: d&b_business_check_sg servers: - - url: 'https://dev-apis.sentient.io' + - url: 'https://api.sentient.io' tags: - name: "v0.1.0" description: "Published Date - Aug 15, 2019" paths: - /microservices/data/sbc/v0/getdata: + /dnb/prod/sbc: post: tags: - v0.1.0 @@ -27,13 +27,12 @@ paths: content: application/xml: schema: - $ref: '#/components/schemas/REQUEST' - required: true + $ref: '#/components/schemas/REQUEST' responses: '200': description: Ok content: - application/json: + application/xml: schema: $ref: '#/components/schemas/success' example: |+ @@ -1104,21 +1103,28 @@ components: REQUEST: type: object properties: - total_items: + TOT_ITEMS: type: number example: 1 description: Number of subjects being enquired relating to the Run default: false - subject_idno: - type: string - example: 199707714C - description: "Subject’s ID Number (individual) or Registration Number (company/business) as captured in DDP" + ENQUIRY: + type: object + example: |+ + 197601887ETRANSTAR TRAVEL PTE LTD + description: Contains information of each request details default: true - subject_name: - type: string - example: GPS INDUSTRIES PTE LTD - description: Subjects Name as captured in DDP - default: false + properties: + SUBJECT_IDNO: + type: string + example: 199707714C + description: "Subject’s ID Number (individual) or Registration Number (company/business) as captured in DDP" + default: true + SUBJECT_NAME: + type: string + example: GPS INDUSTRIES PTE LTD + description: Subjects Name as captured in DDP + default: false versions: type: object properties: From 709a22536c636f4ef30a2a2052fece704a50f1db Mon Sep 17 00:00:00 2001 From: Mohamed Luqman <57977684+mohamedSent@users.noreply.github.com> Date: Tue, 16 Mar 2021 15:23:22 +0530 Subject: [PATCH 735/792] Update d&b_brief_financial_information_sg.yaml --- data/d&b_brief_financial_information_sg.yaml | 127 ++++++++----------- 1 file changed, 56 insertions(+), 71 deletions(-) diff --git a/data/d&b_brief_financial_information_sg.yaml b/data/d&b_brief_financial_information_sg.yaml index 4163f379e..049d6a4f8 100644 --- a/data/d&b_brief_financial_information_sg.yaml +++ b/data/d&b_brief_financial_information_sg.yaml @@ -5,20 +5,19 @@ info: x-additionalinfo: |+ Suggested Use Cases: - Software solutions with functions for personal credit checks, e.g. for parties who have a vested interest (e.g. banks, investors) in the company’s performance and to evaluate the company’s gearing and acid ratios. - - Information from this microservice can be used for financial analysis - one can build models based on historical behavior. Continually update fraud patterns and compare with real-time transactions. Store and consolidate market data, trade activity, and other data, such as social and transactional data. version: '0.1.0' x-subscribelink: d&b_brief_financial_information_sg servers: - - url: 'https://dev-apis.sentient.io' + - url: 'https://api.sentient.io' tags: - name: "v0.1.0" description: "Published Date - Aug 15, 2019" paths: - /microservices/data/sbfe/v0/getdata: + /dnb/prod/sbfe: post: tags: - - v0 + - v0.1.0 summary: Adds a new user requestBody: content: @@ -29,50 +28,37 @@ paths: '200': description: Ok content: - application/json: + application/xml: schema: $ref: '#/components/schemas/success' - example: - message: Successfully Processed - results: - REPORT: - FH_DTL: - FH_RATIOS_DTL: - FH_SEARCH_INFO: - COMP_NAME: - "#text": MENNAPPAN COMPANY - "@type": String - REG_NO: - "#text": 00007400D - "@type": String - REQ_DATE: - "#text": 24/09/2019 20:27:06 - "@type": String - REQ_DATE_STR: - "#text": 24/09/2019 20:27:06 - "@type": String - REQ_NAME: - "#text": "-" - "@type": String - REQ_REG_NO: - "#text": 00007400D - "@type": String - LIST_FH_CHART_INFO: - META_INFO: - CREATION_DATE: - "#text": 24/09/2019 20:27:06 - "@type": String - SERVICE: - "#text": BFE - "@type": String - SYSTEM_ID: - "#text": DDP - "@type": String - USER_ID: - "#text": B2BSENTIENT - "@type": String - XBRL_DTL: - status: Success + example: |+ + + 25/02/2009 17:31:44> + + + 2009-04-21 10:56:06.716 + 2004 2003 2002 2005 + 2006 2007 2008 2009 2008 2007 2006 2005 2004 + + 9403795.00 8617168.00 7807393.00 31467.00 162620.00 1281387.00 31467.00 162620.00 1281387.00 0.00 0.00 60318.00> 31467.00 162620.00 1341705.00 3889213.00 3395740.00 4374368.00 3359007.00 2855754.00 3546381.00 530206.00 539986.00 827987.00> 7370430.00 6845490.00 7661498.00 6739073.00 6157560.00 6435365.00 631357.00 687930.00 122133.00 -3481217.00 -3449750.00 -3287130.00 2000000.00 2000000.00 2000000.00 0.00 0.00 0.00 5481217.00 5449750.00 5287130.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 + 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 + + 10877254.00 9982533.00 1121483.00 262632.00 1347380.00 262632.00 6562990.00 5424551.00 6283449.00 4948821.00 279541.00 475730.00 8434195.00 8643136.00 8434195.00 7933013.00 0.00 710123.00 -1871205.00 -3218585.00 2000000.00 2000000.00 0.00 0.00 -3,871,205.00 -5,218,585.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 + 0.00 0.00 0.00 0.00 + + 12.39 2.63 0.00 0.00 0.00 20.53 4.84 0.00 0.00 0.00 -72.01 -8.16 -0.00 -0.00 -0.00 1.66 1.84 2.42 2.54 1.78 0.74 0.62 0.50 0.46 0.55 -28.51 -59.33 -89.51 -101.59 -75.15 128.51 168.27 189.51 201.59 175.15 + + 1121483.0 10877254 2008 + + 262632.0> 9982533 2007 + + -31467.0 9403795 2006 + + -162620.0 8617168 2005 + + -1281387.0 7807393 2004 + + '401': description: Unauthorized content: @@ -154,20 +140,13 @@ components: SYSTEM_ID CREATION_DATE USER_ID - example: - META_INFO: - CREATION_DATE: - "#text": 24/09/2019 20:27:06 - "@type": String - SERVICE: - "#text": BFE - "@type": String - SYSTEM_ID: - "#text": DDP - "@type": String - USER_ID: - "#text": B2BSENTIENT - "@type": String + example: |+ + + + + 25/02/2009 17:31:44> + + properties: SERVICE: type: string @@ -1153,7 +1132,6 @@ components: CURR_CAPITAL_RATIO1 PROPRIETARY_RATIO1 TOTAL_DEBT_RATIO1 - Note: Each tag will consist of maximum 5 sets with suffix 1 to 5. But it is optional, depending on how many years of FH & XBRL data displayed in the report. example: |+ @@ -1383,21 +1361,28 @@ components: REQUEST: type: object properties: - total_items: + TOT_ITEMS: type: number example: 1 description: Number of subjects being enquired relating to the Run default: false - subject_idno: - type: string - example: 199707714C - description: "Subject’s ID Number (individual) or Registration Number (company/business) as captured in DDP" + ENQUIRY: + type: object + example: |+ + "197601887ETRANSTAR TRAVEL PTE LTD" + description: Contains information of each request details default: true - subject_name: - type: string - example: GPS INDUSTRIES PTE LTD - description: Subjects Name as captured in DDP - default: false + properties: + SUBJECT_IDNO: + type: string + example: 199707714C + description: "Subject’s ID Number (individual) or Registration Number (company/business) as captured in DDP" + default: true + SUBJECT_NAME: + type: string + example: GPS INDUSTRIES PTE LTD + description: Subjects Name as captured in DDP + default: false versions: type: object properties: From 3989d9bf8b57efde1585a7ec98f4628805793d4e Mon Sep 17 00:00:00 2001 From: Mohamed Luqman <57977684+mohamedSent@users.noreply.github.com> Date: Tue, 16 Mar 2021 15:59:58 +0530 Subject: [PATCH 736/792] initial commit of version1 --- ...b_brief_financial_information_sg_v1.0.yaml | 1409 +++++++++++++++++ 1 file changed, 1409 insertions(+) create mode 100644 data/d&b_brief_financial_information_sg_v1.0.yaml diff --git a/data/d&b_brief_financial_information_sg_v1.0.yaml b/data/d&b_brief_financial_information_sg_v1.0.yaml new file mode 100644 index 000000000..b370febfd --- /dev/null +++ b/data/d&b_brief_financial_information_sg_v1.0.yaml @@ -0,0 +1,1409 @@ +openapi: 3.0.1 +info: + title: D&B Brief Financial Information (SG) + description: This Data microservice provides the annual financial information of Singapore-registered businesses, inclusive of annual profit and loss and financial ratios. Updated daily. + x-additionalinfo: |+ + Suggested Use Cases: + - Software solutions with functions for personal credit checks, e.g. for parties who have a vested interest (e.g. banks, investors) in the company’s performance and to evaluate the company’s gearing and acid ratios. + - Information from this microservice can be used for financial analysis - one can build models based on historical behavior. Continually update fraud patterns and compare with real-time transactions. Store and consolidate market data, trade activity, and other data, such as social and transactional data. + version: '1.0.0' + x-subscribelink: d&b_brief_financial_information_sg +servers: + - url: 'https://dev-apis.sentient.io' +tags: +- name: "v1.0.0" + description: "Published Date - Apr 09, 2021" +paths: + /microservices/data/sbfe/v0/getdata: + post: + tags: + - v1.0.0 + summary: Adds a new user + requestBody: + content: + application/xml: + schema: + $ref: '#/components/schemas/REQUEST' + responses: + '200': + description: Ok + content: + application/xml: + schema: + $ref: '#/components/schemas/success' + example: |+ + + 25/02/2009 17:31:44> + + + 2009-04-21 10:56:06.716 + 2004 2003 2002 2005 + 2006 2007 2008 2009 2008 2007 2006 2005 2004 + + 9403795.00 8617168.00 7807393.00 31467.00 162620.00 1281387.00 31467.00 162620.00 1281387.00 0.00 0.00 60318.00> 31467.00 162620.00 1341705.00 3889213.00 3395740.00 4374368.00 3359007.00 2855754.00 3546381.00 530206.00 539986.00 827987.00> 7370430.00 6845490.00 7661498.00 6739073.00 6157560.00 6435365.00 631357.00 687930.00 122133.00 -3481217.00 -3449750.00 -3287130.00 2000000.00 2000000.00 2000000.00 0.00 0.00 0.00 5481217.00 5449750.00 5287130.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 + 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 + + 10877254.00 9982533.00 1121483.00 262632.00 1347380.00 262632.00 6562990.00 5424551.00 6283449.00 4948821.00 279541.00 475730.00 8434195.00 8643136.00 8434195.00 7933013.00 0.00 710123.00 -1871205.00 -3218585.00 2000000.00 2000000.00 0.00 0.00 -3,871,205.00 -5,218,585.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 + 0.00 0.00 0.00 0.00 + + 12.39 2.63 0.00 0.00 0.00 20.53 4.84 0.00 0.00 0.00 -72.01 -8.16 -0.00 -0.00 -0.00 1.66 1.84 2.42 2.54 1.78 0.74 0.62 0.50 0.46 0.55 -28.51 -59.33 -89.51 -101.59 -75.15 128.51 168.27 189.51 201.59 175.15 + + 1121483.0 10877254 2008 + + 262632.0> 9982533 2007 + + -31467.0 9403795 2006 + + -162620.0 8617168 2005 + + -1281387.0 7807393 2004 + + + '401': + description: Unauthorized + content: + application/json: + schema: + $ref: '#/components/schemas/unauthorized' + '402': + description: Payment Required + content: + application/json: + schema: + $ref: '#/components/schemas/paymentrequired' + '403': + description: Forbidden + content: + application/json: + schema: + $ref: '#/components/schemas/forbidden' + '404': + description: Not Found + content: + application/json: + schema: + $ref: '#/components/schemas/notfound' + '419': + description: Input Field Missing + content: + application/json: + schema: + $ref: '#/components/schemas/inputfieldmissing' + '413': + description: Payload Too Large + content: + application/json: + schema: + $ref: '#/components/schemas/inputlimitexceeded' + '415': + description: Unsupported Media Type + content: + application/json: + schema: + $ref: '#/components/schemas/invalidinput' + '500': + description: Internal Server Error + content: + application/json: + schema: + $ref: '#/components/schemas/servererror' + '504': + description: Gateway Timeout + content: + application/json: + schema: + $ref: '#/components/schemas/gatewaytimeout' + security: + - APIAuthorizer: [] +components: + schemas: + success: + type: object + properties: + REPORT: + type: object + description: |+ + Report details with following children: + [META_INFO] + [FH_SEARCH_INFO] + [FH_DTL] + [XBRL_DTL] + [FH_RATIO_DTL] + [LIST_FH_CHART_INFO] + example: + properties: + META_INFO: + type: object + description: |+ + Meta Information details with following children: + SERVICE + SYSTEM_ID + CREATION_DATE + USER_ID + example: |+ + + + + 25/02/2009 17:31:44> + + + properties: + SERVICE: + type: string + description: Report Requested + example: "BFE" + SYSTEM_ID : + type: string + description: System ID + example: "DDP" + CREATION_DATE: + type: string + description: Report Request Date + example: "25/02/2009 17:31:44" + USER_ID : + type: string + description: Valid user id in DDP system. It is for (For internal use) + example: N/A + FH_SEARCH_INFO: + type: object + description: |+ + FH search information with following children: + COMP_NAME + REG_NO + REQ_DATE + REQ_REG_NO + REQ_NAME + REQ_DATE_STR + FH_BEFORE_YR1 + FH_BEFORE_YR2 + FH_BEFORE_YR3 + FH_BEFORE_YR4 + FH_BEFORE_YR5 + FH_AFTER_YR1 + FH_AFTER_YR2 + FH_AFTER_YR3 + FH_AFTER_YR4 + FH_AFTER_YR5 + AC_RATIOS_YR1 + AC_RATIOS_YR2 + AC_RATIOS_YR3 + AC_RATIOS_YR4 + AC_RATIOS_YR5 + example: |+ + + + + 2009-04-21 10:56:06.716 + + + + 2004 + 2003 + 2002 + 2005 + 2006 + 2007 + 2008 + 2009 + 2008 + 2007 + 2006 + 2005 + 2004 + + properties: + COMP_NAME : + type: string + description: Company Name + example: "DUN & BRADSTREET (SINGAPORE) PTE. LTD." + REG_NO : + type: string + description: Company Registration No + example: "200003058W" + REQ_DATE : + type: datetime + description: Requested Date + example: "2009-04-21 10:56:06.716" + REQ_REG_NO : + type: string + description: Request Registration Number + example: "200003058W" + REQ_NAME : + type: string + description: Request Name + example: "DUN & BRADSTREET (SINGAPORE) PTE. LTD." + REQ_DATE_STR : + type: string + description: Request Date String + example: "21/04/2009 10:56:06" + FH_BEFORE_YR1 : + type: string + description: Financial Highlight filed before year 1 + example: "2004" + FH_BEFORE_YR2 : + type: string + description: Financial Highlight filed before year 2 + example: "2003" + FH_BEFORE_YR3 : + type: string + description: Financial Highlight filed before year 3 + example: "2002" + FH_AFTER_YR1: + type: string + description: Financial Highlight filed after year 1 + example: "2005" + FH_AFTER_YR2 : + type: string + description: Financial Highlight filed after year 2 + example: "2006" + FH_AFTER_YR3 : + type: string + description: Financial Highlight filed after year 3 + example: "2007" + FH_AFTER_YR4: + type: string + description: Financial Highlight filed after year 4 + example: "2008" + FH_AFTER_YR5: + type: string + description: Financial Highlight filed after year 5 + example: "2009" + AC_RATIOS_YR1 : + type: string + description: Account Ratio year 1 + example: "2008" + AC_RATIOS_YR2 : + type: string + description: Account Ratio year 2 + example: "2007" + AC_RATIOS_YR3 : + type: string + description: Account Ratio year 3 + example: "2006" + AC_RATIOS_YR4 : + type: string + description: Account Ratio year 4 + example: "2005" + AC_RATIOS_YR5 : + type: string + description: Account Ratio year 5 + example: "2004" + FH_DTL: + type: object + description: |+ + Financial Highlight with following children: + FH_YR1_CURR + TURNOVER1 + PL_BEF_TAX1 + PL_AFT_TAX1 + NETINC_NON_EXT1 + PL_AFT_TAX_EXT1 + TOT_ASSETS1 + TA_CURRENT1 + TA_FIXED1 + TOT_LIABILITIES1 + TL_CURRENT1 + TL_NON_CURRENT1 + SH_FUNDS1 + SH_PAIDUP_CAPITAL1 + SH_RESERVES1 + SH_ACCUM_LOSS1 + GRP_TURNOVER1 + GRP_PL_BEF_TAX1 + GRP_PL_AFT_TAX1 + GRP_NETINC_NON_EXT1 + GRP_PL_AFT_TAX_EXT1 + GRP_TOT_ASSETS1 + GRP_TA_CURRENT1 + GRP_TA_FIXED1 + GRP_TOT_LIABILITIES1 + GRP_TL_CURRENT1 + GRP_TL_NON_CURRENT1 + GRP_SH_FUNDS1 + GRP_SH_PAIDUP_CAPITAL1 + GRP_SH_RESERVES1 + GRP_SH_ACCUM_LOSS1 + GRP_INDICATOR1 + + Note: Each tag will consist of maximum 5 sets with suffix 1 to 5. But it is optional, depending on how many years of FH data displayed in the report. + example: |+ + + + + + 9403795.00 + 8617168.00 + 7807393.00 + 31467.00 + 162620.00 + 1281387.00 + 31467.00 + 162620.00 + 1281387.00 + 0.00 + 0.00 + 60318.00> + 31467.00 + 162620.00 + 1341705.00 + 3889213.00 + 3395740.00 + 4374368.00 + 3359007.00 + 2855754.00 + 3546381.00 + 530206.00 + 539986.00 + 827987.00> + 7370430.00 + 6845490.00 + 7661498.00 + 6739073.00 + 6157560.00 + 6435365.00 + 631357.00 + 687930.00 + 122133.00 + -3481217.00 + -3449750.00 + -3287130.00 + 2000000.00 + 2000000.00 + 2000000.00 + 0.00 + 0.00 + 0.00 + 5481217.00 + 5449750.00 + 5287130.00 + 0.00 + 0.00 + 0.00 + 0.00 + 0.00 + 0.00 + 0.00 + 0.00 + 0.00 + 0.00 + 0.00 + 0.00 + 0.00 + 0.00 + 0.00 + 0.00 + 0.00 + 0.00 + 0.00 + 0.00 + 0.00 + 0.00 + 0.00 + 0.00 + 0.00 + 0.00 + 0.00 + 0.00 + 0.00 + 0.00 + 0.00 + 0.00 + 0.00 + 0.00 + 0.00 + 0.00 + 0.00 + 0.00 + 0.00 + 0.00 + 0.00 + 0.00 + 0.00 + 0.00 + 0.00 + + + + + properties: + FH_YR1_CURR : + type: string + description: |+ + FH Before Year 1 Currency + Subsequent Years: + FH_YR2_CURR + FH_YR3_CURR + FH_YR4_CURR + FH_YR5_CURR + example: "(SGD)" + TURNOVER1 : + type: string + description: |+ + Turnover / Sales And Other Operating Revenues + Subsequent Years: + TURNOVER2 + TURNOVER3 + TURNOVER4 + TURNOVER5 + example: "9403795.00" + PL_BEF_TAX1 : + type: string + description: |+ + Profit / Loss Before Tax + Subsequent Years: + PL_BEF_TAX2 + PL_BEF_TAX3 + PL_BEF_TAX4 + PL_BEF_TAX5 + example: "31467.00" + PL_AFT_TAX1: + type: string + description: |+ + Profit / Loss After Tax + Subsequent Years: + PL_AFT_TAX2 + PL_AFT_TAX3 + PL_AFT_TAX4 + PL_AFT_TAX5 + example: "31467.00" + NETINC_NON_EXT1: + type: string + description: |+ + Net Income / Loss From Extraordinary And Non- Operating Items + Subsequent Years: + NETINC_NON_EXT2 + NETINC_NON_EXT3 + NETINC_NON_EXT4 + NETINC_NON_EXT5 + example: "0.00" + PL_AFT_TAX_EXT1 : + type: string + description: |+ + Profit / Loss After Tax and Extraordinary Items + Subsequent Years: + PL_AFT_TAX_EXT2 + PL_AFT_TAX_EXT3 + PL_AFT_TAX_EXT4 + PL_AFT_TAX_EXT5 + example: "31467.00" + TOT_ASSETS1 : + type: string + description: |+ + Total Assets + Subsequent Years: + TOT_ASSETS2 + TOT_ASSETS3 + TOT_ASSETS4 + TOT_ASSETS5 + example: "3889213.00" + TA_CURRENT1 : + type: string + description: |+ + Total Assets - Current + Subsequent Years: + TA_CURRENT2 + TA_CURRENT3 + TA_CURRENT4 + TA_CURRENT5 + example: "3359007.00" + TA_FIXED1 : + type: string + description: |+ + Total Assets – Fixed and Others + Subsequent Years: + TA_FIXED2 + TA_FIXED3 + TA_FIXED4 + TA_FIXED5 + example: "530206.00" + TOT_LIABILITIES1 : + type: string + description: |+ + Total Liabilities + Subsequent Years: + TOT_LIABILITIES2 + TOT_LIABILITIES3 + TOT_LIABILITIES4 + TOT_LIABILITIES5 + example: "7370430.00" + TL_CURRENT1 : + type: string + description: |+ + Total Liabilities - Current + Subsequent Years: + TL_CURRENT2 + TL_CURRENT3 + TL_CURRENT4 + TL_CURRENT5 + example: "6739073.00" + TL_NON_CURRENT1 : + type: string + description: |+ + Total Liabilities – Non- Current & Long Term + Subsequent Years: + TL_NON_CURRENT2 + TL_NON_CURRENT3 + TL_NON_CURRENT4 + TL_NON_CURRENT5 + example: "631357.00" + SH_FUNDS1: + type: string + description: |+ + Shareholder’s Fund + Subsequent Years: + SH_FUNDS2 + SH_FUNDS3 + SH_FUNDS4 + SH_FUNDS5 + example: "-3481217.00" + SH_PAIDUP_CAPITAL1 : + type: string + description: |+ + Shareholder’s Fund – Paid Up Capital + Subsequent Years: + SH_PAIDUP_CAPITAL2 + SH_PAIDUP_CAPITAL3 + SH_PAIDUP_CAPITAL4 + SH_PAIDUP_CAPITAL5 + example: "2000000.00" + SH_RESERVES1 : + type: string + description: |+ + Shareholder’s Fund - Reserves + Subsequent Years: + SH_RESERVES2 + SH_RESERVES3 + SH_RESERVES4 + SH_RESERVES5 + example: "0.00" + SH_ACCUM_LOSS1: + type: string + description: |+ + Shareholder’s Fund – Accumulated Loss + Subsequent Years: + SH_ACCUM_LOSS2 + SH_ACCUM_LOSS3 + SH_ACCUM_LOSS4 + SH_ACCUM_LOSS5 + example: "5481217.00" + GRP_TURNOVER1 : + type: string + description: |+ + Group Turnover / Sales and Other Operating Revenues + Subsequent Years: + GRP_TURNOVER2 + GRP_TURNOVER3 + GRP_TURNOVER4 + GRP_TURNOVER5 + example: "0.00" + GRP_PL_BEF_TAX1 : + type: string + description: |+ + Group Profit / Loss Before Tax + Subsequent Years: + GRP_PL_BEF_TAX2 + GRP_PL_BEF_TAX3 + GRP_PL_BEF_TAX4 + GRP_PL_BEF_TAX5 + example: "0.00" + GRP_PL_AFT_TAX1 : + type: string + description: |+ + Group Profit / Loss After Tax + Subsequent Years: + GRP_PL_AFT_TAX2 + GRP_PL_AFT_TAX3 + GRP_PL_AFT_TAX4 + GRP_PL_AFT_TAX5 + example: "0.00" + GRP_NETINC_NON_EXT1 : + type: string + description: |+ + Group Net Income / Loss From Extraordinary and Non-Operating Items + Subsequent Years: + GRP_NETINC_NON_EXT2 + GRP_NETINC_NON_EXT3 + GRP_NETINC_NON_EXT4 + GRP_NETINC_NON_EXT5 + example: "0.00" + GRP_PL_AFT_TAX_EXT1: + type: string + description: |+ + Group Profit / Loss After Tax and Extraordinary items + Subsequent Years: + GRP_ PL_AFT_TAX_EXT2 + GRP_ PL_AFT_TAX_EXT3 + GRP_ PL_AFT_TAX_EXT4 + GRP_ PL_AFT_TAX_EXT5 + example: "0.00" + GRP_TOT_ASSETS1: + type: string + description: |+ + Group Total Assets + Subsequent Years: + GRP_TOT_ASSETS2 + GRP_TOT_ASSETS3 + GRP_TOT_ASSETS4 + GRP_TOT_ASSETS5 + example: "0.00" + GRP_TA_CURRENT1 : + type: string + description: |+ + Group Total Assets – Current + Subsequent Years: + GRP_TA_CURRENT2 + GRP_TA_CURRENT3 + GRP_TA_CURRENT4 + GRP_TA_CURRENT5 + example: "0.00" + GRP_TA_FIXED1 : + type: string + description: |+ + Group Total Assets – Fixed and Others + Subsequent Years: + GRP_TA_FIXED2 + GRP_TA_FIXED3 + GRP_TA_FIXED4 + GRP_TA_FIXED5 + example: "0.00" + GRP_TOT_LIABILITIES1 : + type: string + description: |+ + Group Total Liabilities + Subsequent Years: + GRP_TOT_LIABILITIES2 + GRP_TOT_LIABILITIES3 + GRP_TOT_LIABILITIES4 + GRP_TOT_LIABILITIES5 + example: "0.00" + GRP_TL_CURRENT1 : + type: string + description: |+ + Group Total Liabilities - Current + Subsequent Years: + GRP_TL_CURRENT2 + GRP_TL_CURRENT3 + GRP_TL_CURRENT4 + GRP_TL_CURRENT5 + example: "0.00" + GRP_TL_NON_CURRENT1 : + type: string + description: |+ + Group Total Liabilities – Non-Current & Long Term + Subsequent Years: + GRP_TL_NON_CURRENT2 + GRP_TL_NON_CURRENT3 + GRP_TL_NON_CURRENT4 + GRP_TL_NON_CURRENT5 + example: "0.00" + GRP_SH_FUNDS1 : + type: string + description: |+ + Group Shareholder’s Fund + Subsequent Years: + GRP_ SH_FUNDS2 + GRP_ SH_FUNDS3 + GRP_ SH_FUNDS4 + GRP_ SH_FUNDS5 + example: "0.00" + GRP_SH_PAIDUP_CAPITAL1 : + type: string + description: |+ + Group Shareholder’s Fund – Paid Up Capital + Subsequent Years: + GRP_SH_PAIDUP_CAPITAL2 + GRP_SH_PAIDUP_CAPITAL3 + GRP_SH_PAIDUP_CAPITAL4 + GRP_SH_PAIDUP_CAPITAL5 + example: "0.00" + GRP_SH_RESERVES1: + type: string + description: |+ + Group Shareholder’s Fund - Reserves + Subsequent Years: + GRP_SH_RESERVES2 + GRP_SH_RESERVES3 + GRP_SH_RESERVES4 + GRP_SH_RESERVES5 + example: "0.00" + GRP_SH_ACCUM_LOSS1 : + type: string + description: |+ + Group Shareholder’s Fund – Accumulated Loss + Subsequent Years: + GRP_SH_ACCUM_LOSS2 + GRP_SH_ACCUM_LOSS3 + GRP_SH_ACCUM_LOSS4 + GRP_SH_ACCUM_LOSS5 + example: "0.00" + GRP_INDICATOR1 : + type: string + description: |+ + Company Financial Highlights Group Indicator + Subsequent Years: + GRP_INDICATOR2 + GRP_INDICATOR3 + GRP_INDICATOR4 + GRP_INDICATOR5 + example: "B" + XBRL_DTL: + type: object + description: |+ + XBRL filed after 1 Nov 2007 with following children: + XBRL_YR1_CURR + REVENUE1 + PL_BEF_TAX1 + PL_AFT_TAX1 + TOT_ASSETS1 + TA_CURRENT1 + TA_NON_CURRENT1 + TOT_LIABILITIES1 + TL_CURRENT1 + TL_NON_CURRENT1 + TOT_EQUITY1 + EQ_SH_CAPITAL1 + EQ_RESERVES1 + EQ_RETAINED_EARN1 + GRP_REVENUE1 + GRP_PL_BEF_TAX1 + GRP_PL_AFT_TAX1 + GRP_TOT_ASSETS1 + GRP_TA_CURRENT1 + GRP_TA_NON_CURRENT1 + GRP_TOT_LIABILITIES1 + GRP_TL_CURRENT1 + GRP_TL_NON_CURRENT1 + GRP_TOT_EQUITY1 + GRP_SH_CAPITAL1 + GRP_RESERVES1 + GRP_RETAINED_EARN1 + GRP_INDICATOR1 + + Note: Each tag will consist of maximum 5 sets with suffix 1 to 5. But it is optional, depending on how many years of XBRL data displayed in the report. + example: |+ + + + + 10877254.00 + 9982533.00 + 1121483.00 + 262632.00 + 1347380.00 + 262632.00 + 6562990.00 + 5424551.00 + 6283449.00 + 4948821.00 + 279541.00 + 475730.00 + 8434195.00 + 8643136.00 + 8434195.00 + 7933013.00 + 0.00 + 710123.00 + -1871205.00 + -3218585.00 + 2000000.00 + 2000000.00 + 0.00 + 0.00 + -3,871,205.00 + -5,218,585.00 + 0.00 + 0.00 + 0.00 + 0.00 + 0.00 + 0.00 + 0.00 + 0.00 + 0.00 + 0.00 + 0.00 + 0.00 + 0.00 + 0.00 + 0.00 + 0.00 + 0.00 + 0.00 + 0.00 + 0.00 + 0.00 + 0.00 + 0.00 + 0.00 + 0.00 + 0.00 + + + + + properties: + XBRL_YR1_CURR: + type: string + description: |+ + FH After Year 1 Currency + Subsequent Years: + XBRL_YR2_CURR + XBRL_YR3_CURR + XBRL_YR4_CURR + XBRL_YR5_CURR + example: "(SGD)" + REVENUE1 : + type: string + description: |+ + Revenue Amount + Subsequent Years: + REVENUE2 + REVENUE3 + REVENUE4 + REVENUE5 + example: "10877254.00" + PL_BEF_TAX1 : + type: string + description: |+ + Profit / Loss Before Tax from Continuing Operations + Subsequent Years: + PL_BEF_TAX2 + PL_BEF_TAX3 + PL_BEF_TAX4 + PL_BEF_TAX5 + example: "1121483.00" + PL_AFT_TAX1 : + type: string + description: |+ + Profit / Loss After Tax from Continuing Operations + Subsequent Years: + PL_AFT_TAX2 + PL_AFT_TAX3 + PL_AFT_TAX4 + PL_AFT_TAX5 + example: "1347380.00" + TOT_ASSETS1 : + type: string + description: |+ + Total Assets + Subsequent Years: + TOT_ASSETS2 + TOT_ASSETS3 + TOT_ASSETS4 + TOT_ASSETS5 + example: "6562990.00" + TA_CURRENT1 : + type: string + description: |+ + Total Current Assets (Only for Balance Sheet by Current / Non-Current) + Subsequent Years: + TA_CURRENT2 + TA_CURRENT3 + TA_CURRENT4 + TA_CURRENT5 + example: "6283449.00" + TA_NON_CURRENT1 : + type: string + description: |+ + Total Non-Current Assets (Only for Balance Sheet by Current / Non-Current) + Subsequent Years: + TA_NON_CURRENT2 + TA_NON_CURRENT3 + TA_NON_CURRENT4 + TA_NON_CURRENT5 + example: "279541.00" + TOT_LIABILITIES1 : + type: string + description: |+ + Total Liabilities + Subsequent Years: + TOT_LIABILITIES2 + TOT_LIABILITIES3 + TOT_LIABILITIES4 + TOT_LIABILITIES5 + example: "8434195.00" + TL_CURRENT1 : + type: string + description: |+ + Total Current Liabilities (Only for Balance Sheet by Current / Non-Current) + Subsequent Years: + TL_CURRENT2 + TL_CURRENT3 + TL_CURRENT4 + TL_CURRENT5 + example: "8434195.00" + TL_NON_CURRENT1 : + type: string + description: |+ + Total Non-Current Liabilities (Only for Balance Sheet by Current / Non- Current) + Subsequent Years: + TL_NON_CURRENT2 + TL_NON_CURRENT3 + TL_NON_CURRENT4 + TL_NON_CURRENT5 + example: "0.00" + TOT_EQUITY1 : + type: string + description: |+ + Total Equity (inclusive of Equity Attributable to Equity Holders of Parent and Minority Interest) + Subsequent Years: + TOT_EQUITY2 + TOT_EQUITY3 + TOT_EQUITY4 + TOT_EQUITY5 + example: "-1871205.00" + EQ_SH_CAPITAL1 : + type: string + description: |+ + Total Equity – Share Capital + Subsequent Years: + EQ_SH_CAPITAL2 + EQ_SH_CAPITAL3 + EQ_SH_CAPITAL4 + EQ_SH_CAPITAL5 + example: "2000000.00" + EQ_RESERVES1 : + type: string + description: |+ + Total Equity – Other Reserves + Subsequent Years: + EQ_RESERVES2 + EQ_RESERVES3 + EQ_RESERVES4 + EQ_RESERVES5 + example: "0.00" + EQ_RETAINED_EARN1 : + type: string + description: |+ + Total Equity – Retained Earnings (Accumulated Loss) + Subsequent Years: + EQ_RETAINED_EARN2 + EQ_RETAINED_EARN3 + EQ_RETAINED_EARN4 + EQ_RETAINED_EARN5 + example: "-3,871,205.00" + GRP_REVENUE1 : + type: string + description: |+ + Group’s Revenue Amount + Subsequent Years: + GRP_REVENUE2 + GRP_REVENUE3 + GRP_REVENUE4 + GRP_REVENUE5 + example: "0.00" + GRP_PL_BEF_TAX1 : + type: string + description: |+ + Group Profit / Loss Before Tax from Continuing Operations + Subsequent Years: + GRP_PL_BEF_TAX2 + GRP_PL_BEF_TAX3 + GRP_PL_BEF_TAX4 + GRP_PL_BEF_TAX5 + example: "0.00" + GRP_PL_AFT_TAX1 : + type: string + description: |+ + Group Profit / Loss After Tax from Continuing Operations + Subsequent Years: + GRP_PL_AFT_TAX2 + GRP_PL_AFT_TAX3 + GRP_PL_AFT_TAX4 + GRP_PL_AFT_TAX5 + example: "0.00" + GRP_TOT_ASSETS1 : + type: string + description: |+ + Group’s Total Assets + Subsequent Years: + GRP_TOT_ASSETS2 + GRP_TOT_ASSETS3 + GRP_TOT_ASSETS4 + GRP_TOT_ASSETS5 + example: "0.00" + GRP_TA_CURRENT1 : + type: string + description: |+ + Group’s Total Current Assets (Only for Balance Sheet by Current / Non- Current) + Subsequent Years: + GRP_TA_CURRENT2 + GRP_TA_CURRENT3 + GRP_TA_CURRENT4 + GRP_TA_CURRENT4 + example: "0.00" + GRP_TA_NON_CURRENT1 : + type: string + description: |+ + Group’s Total Non-Current Assets (Only for Balance Sheet by Current / Non- Current) + Subsequent Years: + GRP_TA_NON_CURRENT2 + GRP_TA_NON_CURRENT3 + GRP_TA_NON_CURRENT4 + GRP_TA_NON_CURRENT4 + example: "0.00" + GRP_TOT_LIABILITIES1 : + type: string + description: |+ + Group’s Total Liabilities + Subsequent Years: + GRP_TOT_LIABILITIES2 + GRP_TOT_LIABILITIES3 + GRP_TOT_LIABILITIES4 + GRP_TOT_LIABILITIES5 + example: "0.00" + GRP_TL_CURRENT1 : + type: string + description: |+ + Group’s Total Current Liabilities (Only for Balance Sheet by Current / Non- Current) + Subsequent Years: + GRP_TL_CURRENT2 + GRP_TL_CURRENT3 + GRP_TL_CURRENT4 + GRP_TL_CURRENT5 + example: "0.00" + GRP_TL_NON_CURRENT1 : + type: string + description: |+ + Group’s Total Non-Current Liabilities (Only for Balance Sheet by Current / Non- Current) + Subsequent Years: + GRP_TL_NON_CURRENT2 + GRP_TL_NON_CURRENT3 + GRP_TL_NON_CURRENT4 + GRP_TL_NON_CURRENT5 + example: "0.00" + GRP_TOT_EQUITY1 : + type: string + description: |+ + Group’s Total Equity (inclusive of Equity Attributable to Equity Holders of Parent and Minority Interest) + Subsequent Years: + GRP_TOT_EQUITY2 + GRP_TOT_EQUITY3 + GRP_TOT_EQUITY4 + GRP_TOT_EQUITY5 + example: "0.00" + GRP_SH_CAPITAL1 : + type: string + description: |+ + Group’s Share Capital + Subsequent Years: + GRP_SH_CAPITAL2 + GRP_SH_CAPITAL3 + GRP_SH_CAPITAL4 + GRP_SH_CAPITAL5 + example: "0.00" + GRP_RESERVES1 : + type: string + description: |+ + Group’s Other Reserves + Subsequent Years: + GRP_RESERVES2 + GRP_RESERVES3 + GRP_RESERVES4 + GRP_RESERVES5 + example: "0.00" + GRP_RETAINED_EARN1 : + type: string + description: |+ + Group’s – Retained Earnings (Accumulated Loss) + Subsequent Years: + GRP_RETAINED_EARN2 + GRP_RETAINED_EARN3 + GRP_RETAINED_EARN4 + GRP_RETAINED_EARN5 + example: "0.00" + GRP_INDICATOR1 : + type: string + description: |+ + XBRL Financial Highlights Group Indicator + Subsequent Years: + GRP_INDICATOR2 + GRP_INDICATOR3 + GRP_INDICATOR4 + GRP_INDICATOR5 + example: "B" + FH_RATIOS_DTL: + type: object + description: |+ + Accounting Ratios Details with following children: + RATE_NET_PROFIT1 + RET_INVESTMENT1 + RET_SH_FUNDS1 + TOT_ASSETS_TURNOVER1 + CURR_CAPITAL_RATIO1 + PROPRIETARY_RATIO1 + TOTAL_DEBT_RATIO1 + Note: Each tag will consist of maximum 5 sets with suffix 1 to 5. But it is optional, depending on how many years of FH & XBRL data displayed in the report. + example: |+ + + 12.39 + 2.63 + 0.00 + 0.00 + 0.00 + 20.53 + 4.84 + 0.00 + 0.00 + 0.00 + -72.01 + -8.16 + -0.00 + -0.00 + -0.00 + 1.66 + 1.84 + 2.42 + 2.54 + 1.78 + 0.74 + 0.62 + 0.50 + 0.46 + 0.55 + -28.51 + -59.33 + -89.51 + -101.59 + -75.15 + 128.51 + 168.27 + 189.51 + 201.59 + 175.15 + + properties: + RATE_NET_PROFIT1 : + type: string + description: |+ + Rate of Net Profit On Sales (%) + Subsequent Years: + RATE_NET_PROFIT2 + RATE_NET_PROFIT3 + RATE_NET_PROFIT4 + RATE_NET_PROFIT5 + example: "12.39" + RET_INVESTMENT1 : + type: string + description: |+ + Return of Investment (%) + Subsequent Years: + RET_INVESTMENT2 + RET_INVESTMENT3 + RET_INVESTMENT4 + RET_INVESTMENT5 + example: "20.53" + RET_SH_FUNDS1 : + type: string + description: |+ + Return of Shareholder’s Funds (%) + Subsequent Years: + RET_SH_FUNDS2 + RET_SH_FUNDS3 + RET_SH_FUNDS4 + RET_SH_FUNDS4 + example: "-72.01" + TOT_ASSETS_TURNOVER1 : + type: string + description: |+ + Total Assets Turnover (%) + Subsequent Years: + TOT_ASSETS_TURNOVER2 + TOT_ASSETS_TURNOVER3 + TOT_ASSETS_TURNOVER4 + TOT_ASSETS_TURNOVER5 + example: "1.66" + CURR_CAPITAL_RATIO1: + type: string + description: |+ + Current / Working Capital Ratio (%) + Subsequent Years: + CURR_CAPITAL_RATIO2 + CURR_CAPITAL_RATIO3 + CURR_CAPITAL_RATIO4 + CURR_CAPITAL_RATIO5 + example: "0.74" + PROPRIETARY_RATIO1: + type: string + description: |+ + Proprietary Ratio (%) 1 + Subsequent Years: + PROPRIETARY_RATIO2 + PROPRIETARY_RATIO3 + PROPRIETARY_RATIO4 + PROPRIETARY_RATIO5 + example: "-28.51" + TOTAL_DEBT_RATIO1 : + type: string + description: |+ + Total Debt to Equity Ratio (%) 1 + Subsequent Years: + TOTAL_DEBT_RATIO2 + TOTAL_DEBT_RATIO3 + TOTAL_DEBT_RATIO4 + TOTAL_DEBT_RATIO5 + example: "128.51" + LIST_FH_CHART_INFO : + type: array + example: |+ + + + 1121483.0 + 10877254 + 2008 + + + description: |+ + List of chart info with following children: + [FH_CHART_INFO] + items: + properties: + FH_CHART_INFO: + type: object + description: |+ + Chart Info info with following children: + YEAR + REVENUE + PROFIT_LOSS + properties: + PROFIT_LOSS: + type: string + example: "1121483.0" + description: Profit / Loss Before Tax of the year + REVENUE: + type: string + example: "10877254" + description: Revenue Amount of the year + YEAR: + type: string + example: "2008" + description: Financial Year + unauthorized: + type: object + properties: + message: + type: string + example: Missing Authentication Token + status: + type: string + example: Failure + forbidden: + type: object + properties: + message: + type: string + example: Access Denied Unauthorized User + status: + type: string + example: Failure + paymentrequired: + type: object + properties: + message: + type: string + example: Insufficient Credits Kindly Top Up + status: + type: string + example: Failure + notfound: + type: object + properties: + message: + type: string + example: Invalid Request URL + status: + type: string + example: Failure + servererror: + type: object + properties: + message: + type: string + example: Internal Server Error + status: + type: string + example: Failure + gatewaytimeout: + type: object + properties: + message: + type: string + example: Request Timeout + status: + type: string + example: Failure + inputfieldmissing: + type: object + properties: + message: + type: string + example: Input Field Missing + status: + type: string + example: Failure + inputlimitexceeded: + type: object + properties: + message: + type: string + example: Input Limit Exceeded + status: + type: string + example: Failure + invalidinput: + type: object + properties: + message: + type: string + example: Invalid Input + status: + type: string + example: Failure + REQUEST: + type: object + properties: + TOT_ITEMS: + type: number + example: 1 + description: Number of subjects being enquired relating to the Run + default: false + ENQUIRY: + type: object + example: |+ + "197601887ETRANSTAR TRAVEL PTE LTD" + description: Contains information of each request details + default: true + properties: + SUBJECT_IDNO: + type: string + example: 199707714C + description: "Subject’s ID Number (individual) or Registration Number (company/business) as captured in DDP" + default: true + SUBJECT_NAME: + type: string + example: GPS INDUSTRIES PTE LTD + description: Subjects Name as captured in DDP + default: false + versions: + type: object + properties: + v1.0.0: + type: array + items: + oneOf: + - type: string + example: Published Date - Apr 09, 2021 + description: Optimized and Standardized results in Json format + v0.1.0: + type: array + items: + oneOf: + - type: string + example: Published Date - Aug 15, 2019 + description: Initial version release + securitySchemes: + APIAuthorizer: + type: apiKey + name: x-api-key + in: header + x-amazon-apigateway-authtype: custom + description: Authentication is done using the x-api-key in the request header From b6e04a1c8129251ab98e28af6f67ae80b61bfc68 Mon Sep 17 00:00:00 2001 From: Mohamed Luqman <57977684+mohamedSent@users.noreply.github.com> Date: Tue, 16 Mar 2021 16:01:04 +0530 Subject: [PATCH 737/792] Update index.yaml --- index.yaml | 1 + 1 file changed, 1 insertion(+) diff --git a/index.yaml b/index.yaml index 95ba10a05..25000470c 100644 --- a/index.yaml +++ b/index.yaml @@ -280,6 +280,7 @@ data: d&b_brief_financial_information_sg: title: D&B Brief Financial Information (SG) versions: + 1.0.0: 'd&b_brief_financial_information_sg_v1.0.yaml' 0.1.0: 'd&b_brief_financial_information_sg.yaml' lidar_trajectory_data: title: LiDAR Trajectory Data From 57eeebc0db1c6d9dee2fb3ae7f05e995e1bbeb98 Mon Sep 17 00:00:00 2001 From: Mohamed Luqman <57977684+mohamedSent@users.noreply.github.com> Date: Tue, 16 Mar 2021 16:03:02 +0530 Subject: [PATCH 738/792] Update d&b_brief_financial_information_sg_v1.0.yaml --- data/d&b_brief_financial_information_sg_v1.0.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/data/d&b_brief_financial_information_sg_v1.0.yaml b/data/d&b_brief_financial_information_sg_v1.0.yaml index b370febfd..59fbb54bc 100644 --- a/data/d&b_brief_financial_information_sg_v1.0.yaml +++ b/data/d&b_brief_financial_information_sg_v1.0.yaml @@ -21,7 +21,7 @@ paths: summary: Adds a new user requestBody: content: - application/xml: + application/json: schema: $ref: '#/components/schemas/REQUEST' responses: From a8e29e00e2bb6479e83a32a002baf1819b4a7787 Mon Sep 17 00:00:00 2001 From: Mohamed Luqman <57977684+mohamedSent@users.noreply.github.com> Date: Tue, 16 Mar 2021 16:09:01 +0530 Subject: [PATCH 739/792] Update d&b_brief_financial_information_sg_v1.0.yaml --- ...b_brief_financial_information_sg_v1.0.yaml | 29 +++++++------------ 1 file changed, 11 insertions(+), 18 deletions(-) diff --git a/data/d&b_brief_financial_information_sg_v1.0.yaml b/data/d&b_brief_financial_information_sg_v1.0.yaml index 59fbb54bc..c8887129a 100644 --- a/data/d&b_brief_financial_information_sg_v1.0.yaml +++ b/data/d&b_brief_financial_information_sg_v1.0.yaml @@ -28,7 +28,7 @@ paths: '200': description: Ok content: - application/xml: + application/json: schema: $ref: '#/components/schemas/success' example: |+ @@ -1361,28 +1361,21 @@ components: REQUEST: type: object properties: - TOT_ITEMS: + total_items: type: number example: 1 description: Number of subjects being enquired relating to the Run default: false - ENQUIRY: - type: object - example: |+ - "197601887ETRANSTAR TRAVEL PTE LTD" - description: Contains information of each request details + subject_idno: + type: string + example: "199707714C" + description: "Subject’s ID Number (individual) or Registration Number (company/business) as captured in DDP" default: true - properties: - SUBJECT_IDNO: - type: string - example: 199707714C - description: "Subject’s ID Number (individual) or Registration Number (company/business) as captured in DDP" - default: true - SUBJECT_NAME: - type: string - example: GPS INDUSTRIES PTE LTD - description: Subjects Name as captured in DDP - default: false + subject_name: + type: string + example: "GPS INDUSTRIES PTE LTD" + description: Subjects Name as captured in DDP + default: false versions: type: object properties: From d5787d11bfd05c120c4ce790e06108abcc7c6091 Mon Sep 17 00:00:00 2001 From: Mohamed Luqman <57977684+mohamedSent@users.noreply.github.com> Date: Tue, 16 Mar 2021 17:09:06 +0530 Subject: [PATCH 740/792] Update d&b_brief_financial_information_sg_v1.0.yaml --- ...b_brief_financial_information_sg_v1.0.yaml | 261 ++++++++++++++++-- 1 file changed, 233 insertions(+), 28 deletions(-) diff --git a/data/d&b_brief_financial_information_sg_v1.0.yaml b/data/d&b_brief_financial_information_sg_v1.0.yaml index c8887129a..c71e575ca 100644 --- a/data/d&b_brief_financial_information_sg_v1.0.yaml +++ b/data/d&b_brief_financial_information_sg_v1.0.yaml @@ -31,34 +31,239 @@ paths: application/json: schema: $ref: '#/components/schemas/success' - example: |+ - - 25/02/2009 17:31:44> - - - 2009-04-21 10:56:06.716 - 2004 2003 2002 2005 - 2006 2007 2008 2009 2008 2007 2006 2005 2004 - - 9403795.00 8617168.00 7807393.00 31467.00 162620.00 1281387.00 31467.00 162620.00 1281387.00 0.00 0.00 60318.00> 31467.00 162620.00 1341705.00 3889213.00 3395740.00 4374368.00 3359007.00 2855754.00 3546381.00 530206.00 539986.00 827987.00> 7370430.00 6845490.00 7661498.00 6739073.00 6157560.00 6435365.00 631357.00 687930.00 122133.00 -3481217.00 -3449750.00 -3287130.00 2000000.00 2000000.00 2000000.00 0.00 0.00 0.00 5481217.00 5449750.00 5287130.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 - 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 - - 10877254.00 9982533.00 1121483.00 262632.00 1347380.00 262632.00 6562990.00 5424551.00 6283449.00 4948821.00 279541.00 475730.00 8434195.00 8643136.00 8434195.00 7933013.00 0.00 710123.00 -1871205.00 -3218585.00 2000000.00 2000000.00 0.00 0.00 -3,871,205.00 -5,218,585.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 - 0.00 0.00 0.00 0.00 - - 12.39 2.63 0.00 0.00 0.00 20.53 4.84 0.00 0.00 0.00 -72.01 -8.16 -0.00 -0.00 -0.00 1.66 1.84 2.42 2.54 1.78 0.74 0.62 0.50 0.46 0.55 -28.51 -59.33 -89.51 -101.59 -75.15 128.51 168.27 189.51 201.59 175.15 - - 1121483.0 10877254 2008 - - 262632.0> 9982533 2007 - - -31467.0 9403795 2006 - - -162620.0 8617168 2005 - - -1281387.0 7807393 2004 - - + example: + META_INFO: + SERVICE: BFE + SYSTEM_ID: DDP + CREATION_DATE: 25/02/2009 17:31:44> + USER_ID: plcust102 + FH_SEARCH_INFO: + COMP_NAME: DUN & BRADSTREET (SINGAPORE) PTE. LTD. + REG_NO: 200003058W + REQ_DATE: '2009-04-21 10:56:06.716' + REQ_REG_NO: 200003058W + REQ_NAME: DUN & BRADSTREET (SINGAPORE) PTE. LTD. + REQ_DATE_STR: 21/04/2009 10:56:06 + FH_BEFORE_YR1: '2004' + FH_BEFORE_YR2: '2003' + FH_BEFORE_YR3: '2002' + FH_AFTER_YR1: '2005' + FH_AFTER_YR2: '2006' + FH_AFTER_YR3: '2007' + FH_AFTER_YR4: '2008' + FH_AFTER_YR5: '2009' + AC_RATIOS_YR1: '2008' + AC_RATIOS_YR2: '2007' + AC_RATIOS_YR3: '2006' + AC_RATIOS_YR4: '2005' + AC_RATIOS_YR5: '2004' + FH_DTL: + FH_YR1_CURR: "(SGD)" + FH_YR2_CURR: "(SGD)" + FH_YR3_CURR: "(SGD)" + TURNOVER1: '9403795.00' + TURNOVER2: '8617168.00' + TURNOVER3: '7807393.00' + PL_BEF_TAX1: '31467.00' + PL_BEF_TAX2: '162620.00' + PL_BEF_TAX3: '1281387.00' + PL_AFT_TAX1: '31467.00' + PL_AFT_TAX2: '162620.00' + PL_AFT_TAX3: '1281387.00' + NETINC_NON_EXT1: '0.00' + NETINC_NON_EXT2: '0.00' + NETINC_NON_EXT3: 60318.00> + PL_AFT_TAX_EXT1: '31467.00' + PL_AFT_TAX_EXT2: '162620.00' + PL_AFT_TAX_EXT3: '1341705.00' + TOT_ASSETS1: '3889213.00' + TOT_ASSETS2: '3395740.00' + TOT_ASSETS3: '4374368.00' + TA_CURRENT1: '3359007.00' + TA_CURRENT2: '2855754.00' + TA_CURRENT3: '3546381.00' + TA_FIXED1: '530206.00' + TA_FIXED2: '539986.00' + TA_FIXED3: 827987.00> + TOT_LIABILITIES1: '7370430.00' + TOT_LIABILITIES2: '6845490.00' + TOT_LIABILITIES3: '7661498.00' + TL_CURRENT1: '6739073.00' + TL_CURRENT2: '6157560.00' + TL_CURRENT3: '6435365.00' + TL_NON_CURRENT1: '631357.00' + TL_NON_CURRENT2: '687930.00' + TL_NON_CURRENT3: '122133.00' + SH_FUNDS1: "-3481217.00" + SH_FUNDS2: "-3449750.00" + SH_FUNDS3: "-3287130.00" + SH_PAIDUP_CAPITAL1: '2000000.00' + SH_PAIDUP_CAPITAL2: '2000000.00' + SH_PAIDUP_CAPITAL3: '2000000.00' + SH_RESERVES1: '0.00' + SH_RESERVES2: '0.00' + SH_RESERVES3: '0.00' + SH_ACCUM_LOSS1: '5481217.00' + SH_ACCUM_LOSS2: '5449750.00' + SH_ACCUM_LOSS3: '5287130.00' + GRP_TURNOVER1: '0.00' + GRP_TURNOVER2: '0.00' + GRP_TURNOVER3: '0.00' + GRP_PL_BEF_TAX1: '0.00' + GRP_PL_BEF_TAX2: '0.00' + GRP_PL_BEF_TAX3: '0.00' + GRP_PL_AFT_TAX1: '0.00' + GRP_PL_AFT_TAX2: '0.00' + GRP_PL_AFT_TAX3: '0.00' + GRP_NETINC_NON_EXT1: '0.00' + GRP_NETINC_NON_EXT2: '0.00' + GRP_NETINC_NON_EXT3: '0.00' + GRP_PL_AFT_TAX_EXT1: '0.00' + GRP_PL_AFT_TAX_EXT2: '0.00' + GRP_PL_AFT_TAX_EXT3: '0.00' + GRP_TOT_ASSETS1: '0.00' + GRP_TOT_ASSETS2: '0.00' + GRP_TOT_ASSETS3: '0.00' + GRP_TA_CURRENT1: '0.00' + GRP_TA_CURRENT2: '0.00' + GRP_TA_CURRENT3: '0.00' + GRP_TA_FIXED1: '0.00' + GRP_TA_FIXED2: '0.00' + GRP_TA_FIXED3: '0.00' + GRP_TOT_LIABILITIES1: '0.00' + GRP_TOT_LIABILITIES2: '0.00' + GRP_TOT_LIABILITIES3: '0.00' + GRP_TL_CURRENT1: '0.00' + GRP_TL_CURRENT2: '0.00' + GRP_TL_CURRENT3: '0.00' + GRP_TL_NON_CURRENT1: '0.00' + GRP_TL_NON_CURRENT2: '0.00' + GRP_TL_NON_CURRENT3: '0.00' + GRP_SH_FUNDS1: '0.00' + GRP_SH_FUNDS2: '0.00' + GRP_SH_FUNDS3: '0.00' + GRP_SH_PAIDUP_CAPITAL1: '0.00' + GRP_SH_PAIDUP_CAPITAL2: '0.00' + GRP_SH_PAIDUP_CAPITAL3: '0.00' + GRP_SH_RESERVES1: '0.00' + GRP_SH_RESERVES2: '0.00' + GRP_SH_RESERVES3: '0.00' + GRP_SH_ACCUM_LOSS1: '0.00' + GRP_SH_ACCUM_LOSS2: '0.00' + GRP_SH_ACCUM_LOSS3: '0.00' + GRP_INDICATOR1: B + GRP_INDICATOR2: B + GRP_INDICATOR3: B + XBRL_DTL: + XBRL_YR1_CURR: "(SGD)" + XBRL_YR2_CURR: "(SGD)" + REVENUE1: '10877254.00' + REVENUE2: '9982533.00' + PL_BEF_TAX1: '1121483.00' + PL_BEF_TAX2: '262632.00' + PL_AFT_TAX1: '1347380.00' + PL_AFT_TAX2: '262632.00' + TOT_ASSETS1: '6562990.00' + TOT_ASSETS2: '5424551.00' + TA_CURRENT1: '6283449.00' + TA_CURRENT2: '4948821.00' + TA_NON_CURRENT1: '279541.00' + TA_NON_CURRENT2: '475730.00' + TOT_LIABILITIES1: '8434195.00' + TOT_LIABILITIES2: '8643136.00' + TL_CURRENT1: '8434195.00' + TL_CURRENT2: '7933013.00' + TL_NON_CURRENT1: '0.00' + TL_NON_CURRENT2: '710123.00' + TOT_EQUITY1: "-1871205.00" + TOT_EQUITY2: "-3218585.00" + EQ_SH_CAPITAL1: '2000000.00' + EQ_SH_CAPITAL2: '2000000.00' + EQ_RESERVES1: '0.00' + EQ_RESERVES2: '0.00' + EQ_RETAINED_EARN1: "-3,871,205.00" + EQ_RETAINED_EARN2: "-5,218,585.00" + GRP_REVENUE1: '0.00' + GRP_REVENUE2: '0.00' + GRP_PL_BEF_TAX1: '0.00' + GRP_PL_BEF_TAX2: '0.00' + GRP_PL_AFT_TAX1: '0.00' + GRP_PL_AFT_TAX2: '0.00' + GRP_TOT_ASSETS1: '0.00' + GRP_TOT_ASSETS2: '0.00' + GRP_TA_CURRENT1: '0.00' + GRP_TA_CURRENT2: '0.00' + GRP_TA_NON_CURRENT1: '0.00' + GRP_TA_NON_CURRENT2: '0.00' + GRP_TOT_LIABILITIES1: '0.00' + GRP_TOT_LIABILITIES2: '0.00' + GRP_TL_CURRENT1: '0.00' + GRP_TL_CURRENT2: '0.00' + GRP_TL_NON_CURRENT1: '0.00' + GRP_TL_NON_CURRENT2: '0.00' + GRP_TOT_EQUITY1: '0.00' + GRP_TOT_EQUITY2: '0.00' + GRP_SH_CAPITAL1: '0.00' + GRP_SH_CAPITAL2: '0.00' + GRP_RESERVES1: '0.00' + GRP_RESERVES2: '0.00' + GRP_RETAINED_EARN1: '0.00' + GRP_RETAINED_EARN2: '0.00' + GRP_INDICATOR1: B + GRP_INDICATOR2: B + GRP_INDICATOR3: B + FH_RATIOS_DTL: + RATE_NET_PROFIT1: '12.39' + RATE_NET_PROFIT2: '2.63' + RATE_NET_PROFIT3: '0.00' + RATE_NET_PROFIT4: '0.00' + RATE_NET_PROFIT5: '0.00' + RET_INVESTMENT1: '20.53' + RET_INVESTMENT2: '4.84' + RET_INVESTMENT3: '0.00' + RET_INVESTMENT4: '0.00' + RET_INVESTMENT5: '0.00' + RET_SH_FUNDS1: "-72.01" + RET_SH_FUNDS2: "-8.16" + RET_SH_FUNDS3: "-0.00" + RET_SH_FUNDS4: "-0.00" + RET_SH_FUNDS5: "-0.00" + TOT_ASSETS_TURNOVER1: '1.66' + TOT_ASSETS_TURNOVER2: '1.84' + TOT_ASSETS_TURNOVER3: '2.42' + TOT_ASSETS_TURNOVER4: '2.54' + TOT_ASSETS_TURNOVER5: '1.78' + CURR_CAPITAL_RATIO1: '0.74' + CURR_CAPITAL_RATIO2: '0.62' + CURR_CAPITAL_RATIO3: '0.50' + CURR_CAPITAL_RATIO4: '0.46' + CURR_CAPITAL_RATIO5: '0.55' + PROPRIETARY_RATIO1: "-28.51" + PROPRIETARY_RATIO2: "-59.33" + PROPRIETARY_RATIO3: "-89.51" + PROPRIETARY_RATIO4: "-101.59" + PROPRIETARY_RATIO5: "-75.15" + TOTAL_DEBT_RATIO1: '128.51' + TOTAL_DEBT_RATIO2: '168.27' + TOTAL_DEBT_RATIO3: '189.51' + TOTAL_DEBT_RATIO4: '201.59' + TOTAL_DEBT_RATIO5: '175.15' + LIST_FH_CHART_INFO: + - PROFIT_LOSS: '1121483.0' + REVENUE: '10877254' + YEAR: '2008' + - PROFIT_LOSS: 262632.0> + REVENUE: '9982533' + YEAR: '2007' + - PROFIT_LOSS: "-31467.0" + REVENUE: '9403795' + YEAR: '2006' + - PROFIT_LOSS: "-162620.0" + REVENUE: '8617168' + YEAR: '2005' + - PROFIT_LOSS: "-1281387.0" + REVENUE: '7807393' + YEAR: '2004' '401': description: Unauthorized content: From 942fd6ec8a83573f24d1667e531fa04e7d5e95d8 Mon Sep 17 00:00:00 2001 From: Mohamed Luqman <57977684+mohamedSent@users.noreply.github.com> Date: Tue, 16 Mar 2021 17:19:14 +0530 Subject: [PATCH 741/792] Update d&b_brief_financial_information_sg_v1.0.yaml --- data/d&b_brief_financial_information_sg_v1.0.yaml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/data/d&b_brief_financial_information_sg_v1.0.yaml b/data/d&b_brief_financial_information_sg_v1.0.yaml index c71e575ca..8a0508e87 100644 --- a/data/d&b_brief_financial_information_sg_v1.0.yaml +++ b/data/d&b_brief_financial_information_sg_v1.0.yaml @@ -1573,12 +1573,12 @@ components: default: false subject_idno: type: string - example: "199707714C" + example: 199707714C description: "Subject’s ID Number (individual) or Registration Number (company/business) as captured in DDP" default: true subject_name: type: string - example: "GPS INDUSTRIES PTE LTD" + example: GPS INDUSTRIES PTE LTD description: Subjects Name as captured in DDP default: false versions: From bc859b09d4d415f0942182e3bd1cff8ef46be53f Mon Sep 17 00:00:00 2001 From: Mohamed Luqman <57977684+mohamedSent@users.noreply.github.com> Date: Tue, 16 Mar 2021 17:30:04 +0530 Subject: [PATCH 742/792] Update d&b_brief_financial_information_sg_v1.0.yaml --- data/d&b_brief_financial_information_sg_v1.0.yaml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/data/d&b_brief_financial_information_sg_v1.0.yaml b/data/d&b_brief_financial_information_sg_v1.0.yaml index 8a0508e87..a44eae460 100644 --- a/data/d&b_brief_financial_information_sg_v1.0.yaml +++ b/data/d&b_brief_financial_information_sg_v1.0.yaml @@ -23,7 +23,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/REQUEST' + $ref: '#/components/schemas/input' responses: '200': description: Ok @@ -1563,7 +1563,7 @@ components: status: type: string example: Failure - REQUEST: + input: type: object properties: total_items: From 97189b35af78e6e549f801d8aa4fc5820cc7547a Mon Sep 17 00:00:00 2001 From: Mohamed Luqman <57977684+mohamedSent@users.noreply.github.com> Date: Tue, 16 Mar 2021 18:01:54 +0530 Subject: [PATCH 743/792] Update d&b_brief_financial_information_sg_v1.0.yaml --- data/d&b_brief_financial_information_sg_v1.0.yaml | 13 ++++++------- 1 file changed, 6 insertions(+), 7 deletions(-) diff --git a/data/d&b_brief_financial_information_sg_v1.0.yaml b/data/d&b_brief_financial_information_sg_v1.0.yaml index a44eae460..4a9574e83 100644 --- a/data/d&b_brief_financial_information_sg_v1.0.yaml +++ b/data/d&b_brief_financial_information_sg_v1.0.yaml @@ -345,13 +345,12 @@ components: SYSTEM_ID CREATION_DATE USER_ID - example: |+ - - - - 25/02/2009 17:31:44> - - + example: + META_INFO: + SERVICE: BFE + SYSTEM_ID: DDP + CREATION_DATE: 25/02/2009 17:31:44> + USER_ID: plcust102 properties: SERVICE: type: string From 4e740575a57027dac2008aad14821bd98092f146 Mon Sep 17 00:00:00 2001 From: Mohamed Luqman <57977684+mohamedSent@users.noreply.github.com> Date: Tue, 16 Mar 2021 20:28:12 +0530 Subject: [PATCH 744/792] Update d&b_brief_financial_information_sg_v1.0.yaml --- ...b_brief_financial_information_sg_v1.0.yaml | 448 +++++++++--------- 1 file changed, 221 insertions(+), 227 deletions(-) diff --git a/data/d&b_brief_financial_information_sg_v1.0.yaml b/data/d&b_brief_financial_information_sg_v1.0.yaml index 4a9574e83..976600766 100644 --- a/data/d&b_brief_financial_information_sg_v1.0.yaml +++ b/data/d&b_brief_financial_information_sg_v1.0.yaml @@ -393,28 +393,27 @@ components: AC_RATIOS_YR3 AC_RATIOS_YR4 AC_RATIOS_YR5 - example: |+ - - - - 2009-04-21 10:56:06.716 - - - - 2004 - 2003 - 2002 - 2005 - 2006 - 2007 - 2008 - 2009 - 2008 - 2007 - 2006 - 2005 - 2004 - + example: + FH_SEARCH_INFO: + COMP_NAME: DUN & BRADSTREET (SINGAPORE) PTE. LTD. + REG_NO: 200003058W + REQ_DATE: '2009-04-21 10:56:06.716' + REQ_REG_NO: 200003058W + REQ_NAME: DUN & BRADSTREET (SINGAPORE) PTE. LTD. + REQ_DATE_STR: 21/04/2009 10:56:06 + FH_BEFORE_YR1: '2004' + FH_BEFORE_YR2: '2003' + FH_BEFORE_YR3: '2002' + FH_AFTER_YR1: '2005' + FH_AFTER_YR2: '2006' + FH_AFTER_YR3: '2007' + FH_AFTER_YR4: '2008' + FH_AFTER_YR5: '2009' + AC_RATIOS_YR1: '2008' + AC_RATIOS_YR2: '2007' + AC_RATIOS_YR3: '2006' + AC_RATIOS_YR4: '2005' + AC_RATIOS_YR5: '2004' properties: COMP_NAME : type: string @@ -530,105 +529,104 @@ components: GRP_INDICATOR1 Note: Each tag will consist of maximum 5 sets with suffix 1 to 5. But it is optional, depending on how many years of FH data displayed in the report. - example: |+ - - - - - 9403795.00 - 8617168.00 - 7807393.00 - 31467.00 - 162620.00 - 1281387.00 - 31467.00 - 162620.00 - 1281387.00 - 0.00 - 0.00 - 60318.00> - 31467.00 - 162620.00 - 1341705.00 - 3889213.00 - 3395740.00 - 4374368.00 - 3359007.00 - 2855754.00 - 3546381.00 - 530206.00 - 539986.00 - 827987.00> - 7370430.00 - 6845490.00 - 7661498.00 - 6739073.00 - 6157560.00 - 6435365.00 - 631357.00 - 687930.00 - 122133.00 - -3481217.00 - -3449750.00 - -3287130.00 - 2000000.00 - 2000000.00 - 2000000.00 - 0.00 - 0.00 - 0.00 - 5481217.00 - 5449750.00 - 5287130.00 - 0.00 - 0.00 - 0.00 - 0.00 - 0.00 - 0.00 - 0.00 - 0.00 - 0.00 - 0.00 - 0.00 - 0.00 - 0.00 - 0.00 - 0.00 - 0.00 - 0.00 - 0.00 - 0.00 - 0.00 - 0.00 - 0.00 - 0.00 - 0.00 - 0.00 - 0.00 - 0.00 - 0.00 - 0.00 - 0.00 - 0.00 - 0.00 - 0.00 - 0.00 - 0.00 - 0.00 - 0.00 - 0.00 - 0.00 - 0.00 - 0.00 - 0.00 - 0.00 - 0.00 - 0.00 - - - - + example: + FH_DTL: + FH_YR1_CURR: "(SGD)" + FH_YR2_CURR: "(SGD)" + FH_YR3_CURR: "(SGD)" + TURNOVER1: '9403795.00' + TURNOVER2: '8617168.00' + TURNOVER3: '7807393.00' + PL_BEF_TAX1: '31467.00' + PL_BEF_TAX2: '162620.00' + PL_BEF_TAX3: '1281387.00' + PL_AFT_TAX1: '31467.00' + PL_AFT_TAX2: '162620.00' + PL_AFT_TAX3: '1281387.00' + NETINC_NON_EXT1: '0.00' + NETINC_NON_EXT2: '0.00' + NETINC_NON_EXT3: 60318.00> + PL_AFT_TAX_EXT1: '31467.00' + PL_AFT_TAX_EXT2: '162620.00' + PL_AFT_TAX_EXT3: '1341705.00' + TOT_ASSETS1: '3889213.00' + TOT_ASSETS2: '3395740.00' + TOT_ASSETS3: '4374368.00' + TA_CURRENT1: '3359007.00' + TA_CURRENT2: '2855754.00' + TA_CURRENT3: '3546381.00' + TA_FIXED1: '530206.00' + TA_FIXED2: '539986.00' + TA_FIXED3: 827987.00> + TOT_LIABILITIES1: '7370430.00' + TOT_LIABILITIES2: '6845490.00' + TOT_LIABILITIES3: '7661498.00' + TL_CURRENT1: '6739073.00' + TL_CURRENT2: '6157560.00' + TL_CURRENT3: '6435365.00' + TL_NON_CURRENT1: '631357.00' + TL_NON_CURRENT2: '687930.00' + TL_NON_CURRENT3: '122133.00' + SH_FUNDS1: "-3481217.00" + SH_FUNDS2: "-3449750.00" + SH_FUNDS3: "-3287130.00" + SH_PAIDUP_CAPITAL1: '2000000.00' + SH_PAIDUP_CAPITAL2: '2000000.00' + SH_PAIDUP_CAPITAL3: '2000000.00' + SH_RESERVES1: '0.00' + SH_RESERVES2: '0.00' + SH_RESERVES3: '0.00' + SH_ACCUM_LOSS1: '5481217.00' + SH_ACCUM_LOSS2: '5449750.00' + SH_ACCUM_LOSS3: '5287130.00' + GRP_TURNOVER1: '0.00' + GRP_TURNOVER2: '0.00' + GRP_TURNOVER3: '0.00' + GRP_PL_BEF_TAX1: '0.00' + GRP_PL_BEF_TAX2: '0.00' + GRP_PL_BEF_TAX3: '0.00' + GRP_PL_AFT_TAX1: '0.00' + GRP_PL_AFT_TAX2: '0.00' + GRP_PL_AFT_TAX3: '0.00' + GRP_NETINC_NON_EXT1: '0.00' + GRP_NETINC_NON_EXT2: '0.00' + GRP_NETINC_NON_EXT3: '0.00' + GRP_PL_AFT_TAX_EXT1: '0.00' + GRP_PL_AFT_TAX_EXT2: '0.00' + GRP_PL_AFT_TAX_EXT3: '0.00' + GRP_TOT_ASSETS1: '0.00' + GRP_TOT_ASSETS2: '0.00' + GRP_TOT_ASSETS3: '0.00' + GRP_TA_CURRENT1: '0.00' + GRP_TA_CURRENT2: '0.00' + GRP_TA_CURRENT3: '0.00' + GRP_TA_FIXED1: '0.00' + GRP_TA_FIXED2: '0.00' + GRP_TA_FIXED3: '0.00' + GRP_TOT_LIABILITIES1: '0.00' + GRP_TOT_LIABILITIES2: '0.00' + GRP_TOT_LIABILITIES3: '0.00' + GRP_TL_CURRENT1: '0.00' + GRP_TL_CURRENT2: '0.00' + GRP_TL_CURRENT3: '0.00' + GRP_TL_NON_CURRENT1: '0.00' + GRP_TL_NON_CURRENT2: '0.00' + GRP_TL_NON_CURRENT3: '0.00' + GRP_SH_FUNDS1: '0.00' + GRP_SH_FUNDS2: '0.00' + GRP_SH_FUNDS3: '0.00' + GRP_SH_PAIDUP_CAPITAL1: '0.00' + GRP_SH_PAIDUP_CAPITAL2: '0.00' + GRP_SH_PAIDUP_CAPITAL3: '0.00' + GRP_SH_RESERVES1: '0.00' + GRP_SH_RESERVES2: '0.00' + GRP_SH_RESERVES3: '0.00' + GRP_SH_ACCUM_LOSS1: '0.00' + GRP_SH_ACCUM_LOSS2: '0.00' + GRP_SH_ACCUM_LOSS3: '0.00' + GRP_INDICATOR1: B + GRP_INDICATOR2: B + GRP_INDICATOR3: B properties: FH_YR1_CURR : type: string @@ -984,66 +982,65 @@ components: GRP_INDICATOR1 Note: Each tag will consist of maximum 5 sets with suffix 1 to 5. But it is optional, depending on how many years of XBRL data displayed in the report. - example: |+ - - - - 10877254.00 - 9982533.00 - 1121483.00 - 262632.00 - 1347380.00 - 262632.00 - 6562990.00 - 5424551.00 - 6283449.00 - 4948821.00 - 279541.00 - 475730.00 - 8434195.00 - 8643136.00 - 8434195.00 - 7933013.00 - 0.00 - 710123.00 - -1871205.00 - -3218585.00 - 2000000.00 - 2000000.00 - 0.00 - 0.00 - -3,871,205.00 - -5,218,585.00 - 0.00 - 0.00 - 0.00 - 0.00 - 0.00 - 0.00 - 0.00 - 0.00 - 0.00 - 0.00 - 0.00 - 0.00 - 0.00 - 0.00 - 0.00 - 0.00 - 0.00 - 0.00 - 0.00 - 0.00 - 0.00 - 0.00 - 0.00 - 0.00 - 0.00 - 0.00 - - - - + example: + XBRL_DTL: + XBRL_YR1_CURR: "(SGD)" + XBRL_YR2_CURR: "(SGD)" + REVENUE1: '10877254.00' + REVENUE2: '9982533.00' + PL_BEF_TAX1: '1121483.00' + PL_BEF_TAX2: '262632.00' + PL_AFT_TAX1: '1347380.00' + PL_AFT_TAX2: '262632.00' + TOT_ASSETS1: '6562990.00' + TOT_ASSETS2: '5424551.00' + TA_CURRENT1: '6283449.00' + TA_CURRENT2: '4948821.00' + TA_NON_CURRENT1: '279541.00' + TA_NON_CURRENT2: '475730.00' + TOT_LIABILITIES1: '8434195.00' + TOT_LIABILITIES2: '8643136.00' + TL_CURRENT1: '8434195.00' + TL_CURRENT2: '7933013.00' + TL_NON_CURRENT1: '0.00' + TL_NON_CURRENT2: '710123.00' + TOT_EQUITY1: "-1871205.00" + TOT_EQUITY2: "-3218585.00" + EQ_SH_CAPITAL1: '2000000.00' + EQ_SH_CAPITAL2: '2000000.00' + EQ_RESERVES1: '0.00' + EQ_RESERVES2: '0.00' + EQ_RETAINED_EARN1: "-3,871,205.00" + EQ_RETAINED_EARN2: "-5,218,585.00" + GRP_REVENUE1: '0.00' + GRP_REVENUE2: '0.00' + GRP_PL_BEF_TAX1: '0.00' + GRP_PL_BEF_TAX2: '0.00' + GRP_PL_AFT_TAX1: '0.00' + GRP_PL_AFT_TAX2: '0.00' + GRP_TOT_ASSETS1: '0.00' + GRP_TOT_ASSETS2: '0.00' + GRP_TA_CURRENT1: '0.00' + GRP_TA_CURRENT2: '0.00' + GRP_TA_NON_CURRENT1: '0.00' + GRP_TA_NON_CURRENT2: '0.00' + GRP_TOT_LIABILITIES1: '0.00' + GRP_TOT_LIABILITIES2: '0.00' + GRP_TL_CURRENT1: '0.00' + GRP_TL_CURRENT2: '0.00' + GRP_TL_NON_CURRENT1: '0.00' + GRP_TL_NON_CURRENT2: '0.00' + GRP_TOT_EQUITY1: '0.00' + GRP_TOT_EQUITY2: '0.00' + GRP_SH_CAPITAL1: '0.00' + GRP_SH_CAPITAL2: '0.00' + GRP_RESERVES1: '0.00' + GRP_RESERVES2: '0.00' + GRP_RETAINED_EARN1: '0.00' + GRP_RETAINED_EARN2: '0.00' + GRP_INDICATOR1: B + GRP_INDICATOR2: B + GRP_INDICATOR3: B properties: XBRL_YR1_CURR: type: string @@ -1337,44 +1334,43 @@ components: PROPRIETARY_RATIO1 TOTAL_DEBT_RATIO1 Note: Each tag will consist of maximum 5 sets with suffix 1 to 5. But it is optional, depending on how many years of FH & XBRL data displayed in the report. - example: |+ - - 12.39 - 2.63 - 0.00 - 0.00 - 0.00 - 20.53 - 4.84 - 0.00 - 0.00 - 0.00 - -72.01 - -8.16 - -0.00 - -0.00 - -0.00 - 1.66 - 1.84 - 2.42 - 2.54 - 1.78 - 0.74 - 0.62 - 0.50 - 0.46 - 0.55 - -28.51 - -59.33 - -89.51 - -101.59 - -75.15 - 128.51 - 168.27 - 189.51 - 201.59 - 175.15 - + example: + FH_RATIOS_DTL: + RATE_NET_PROFIT1: '12.39' + RATE_NET_PROFIT2: '2.63' + RATE_NET_PROFIT3: '0.00' + RATE_NET_PROFIT4: '0.00' + RATE_NET_PROFIT5: '0.00' + RET_INVESTMENT1: '20.53' + RET_INVESTMENT2: '4.84' + RET_INVESTMENT3: '0.00' + RET_INVESTMENT4: '0.00' + RET_INVESTMENT5: '0.00' + RET_SH_FUNDS1: "-72.01" + RET_SH_FUNDS2: "-8.16" + RET_SH_FUNDS3: "-0.00" + RET_SH_FUNDS4: "-0.00" + RET_SH_FUNDS5: "-0.00" + TOT_ASSETS_TURNOVER1: '1.66' + TOT_ASSETS_TURNOVER2: '1.84' + TOT_ASSETS_TURNOVER3: '2.42' + TOT_ASSETS_TURNOVER4: '2.54' + TOT_ASSETS_TURNOVER5: '1.78' + CURR_CAPITAL_RATIO1: '0.74' + CURR_CAPITAL_RATIO2: '0.62' + CURR_CAPITAL_RATIO3: '0.50' + CURR_CAPITAL_RATIO4: '0.46' + CURR_CAPITAL_RATIO5: '0.55' + PROPRIETARY_RATIO1: "-28.51" + PROPRIETARY_RATIO2: "-59.33" + PROPRIETARY_RATIO3: "-89.51" + PROPRIETARY_RATIO4: "-101.59" + PROPRIETARY_RATIO5: "-75.15" + TOTAL_DEBT_RATIO1: '128.51' + TOTAL_DEBT_RATIO2: '168.27' + TOTAL_DEBT_RATIO3: '189.51' + TOTAL_DEBT_RATIO4: '201.59' + TOTAL_DEBT_RATIO5: '175.15' properties: RATE_NET_PROFIT1 : type: string @@ -1448,14 +1444,12 @@ components: example: "128.51" LIST_FH_CHART_INFO : type: array - example: |+ - - - 1121483.0 - 10877254 - 2008 - - + example: + LIST_FH_CHART_INFO: + FH_CHART_INFO: + PROFIT_LOSS: '1121483.0' + REVENUE: '10877254' + YEAR: '2008' description: |+ List of chart info with following children: [FH_CHART_INFO] From 4a447718dfaaa65dde4b0ad0a37dd6b69878a489 Mon Sep 17 00:00:00 2001 From: Mohamed Luqman <57977684+mohamedSent@users.noreply.github.com> Date: Wed, 17 Mar 2021 09:09:22 +0530 Subject: [PATCH 745/792] initial commit of version 1 --- data/d&b_basic_individual_search_sg_v1.0.yaml | 1306 +++++++++++++++++ 1 file changed, 1306 insertions(+) create mode 100644 data/d&b_basic_individual_search_sg_v1.0.yaml diff --git a/data/d&b_basic_individual_search_sg_v1.0.yaml b/data/d&b_basic_individual_search_sg_v1.0.yaml new file mode 100644 index 000000000..68c591a46 --- /dev/null +++ b/data/d&b_basic_individual_search_sg_v1.0.yaml @@ -0,0 +1,1306 @@ +openapi: 3.0.1 +info: + title: D&B Basic Individual Search (SG) + description: |+ + This Data microservice provides the information on the (Singapore-registered) business interest of an individual that includes the individual’s actual name, residential address, business and shareholding in businesses, current & previous ownership, litigation against individual and businesses, bankruptcy record and count on the times this individual has been searched on. Updated daily. + x-additionalinfo: |+ + Suggested Use Cases: + - Software solutions that require personal checks, e.g. in the appointment of Board Members, Directorship or C-suite level hiring, where the appointee’s background is paramount to the Company and its reputation. + - Swift pre-employment screening solution - information provided by the microservice can be used to protect one's company's reputation from potential negative publicity by conducting background checks on individuals prior to hiring. + version: '1.0.0' + x-subscribelink: d&b_basic_individual_search_sg +servers: + - url: 'https://dev-apis.sentient.io' +tags: +- name: "v1.0.0" + description: "Published Date - Apr 09, 2021" +paths: + /microservices/data/sbis/v0/getdata: + post: + tags: + - v0 + summary: Adds a new user + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/input' + responses: + '200': + description: Ok + content: + application/json: + schema: + $ref: '#/components/schemas/success' + example: |+ + + 25/02/2009 17:31:44.678 + + + + + + 25/02/2009 17:31:44 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - - S7250163B + + + - - S7250163B + + + + + + 1 1 1 1 1 1 1 1 1 1 1 1 2017 1 + + 0 0 0 0 0 0 0 0 0 0 0 0 2016 1 + + 0 0 0 0 0 0 0 0 0 0 0 0 2015 1 + + 0 0 0 0 0 0 0 0 0 0 0 0 2017 0 + + 0 0 0 0 0 0 0 0 0 0 0 0 2016 0 + + 0 0 0 0 0 0 0 0 0 0 0 + 0 2015 0 + + + '401': + description: Unauthorized + content: + application/json: + schema: + $ref: '#/components/schemas/unauthorized' + '402': + description: Payment Required + content: + application/json: + schema: + $ref: '#/components/schemas/paymentrequired' + '403': + description: Forbidden + content: + application/json: + schema: + $ref: '#/components/schemas/forbidden' + '404': + description: Not Found + content: + application/json: + schema: + $ref: '#/components/schemas/notfound' + '419': + description: Input Field Missing + content: + application/json: + schema: + $ref: '#/components/schemas/inputfieldmissing' + '413': + description: Payload Too Large + content: + application/json: + schema: + $ref: '#/components/schemas/inputlimitexceeded' + '415': + description: Unsupported Media Type + content: + application/json: + schema: + $ref: '#/components/schemas/invalidinput' + '500': + description: Internal Server Error + content: + application/json: + schema: + $ref: '#/components/schemas/servererror' + '504': + description: Gateway Timeout + content: + application/json: + schema: + $ref: '#/components/schemas/gatewaytimeout' + security: + - APIAuthorizer: [] +components: + schemas: + success: + type: object + properties: + REPORT: + type: object + example: + description: |+ + Report details with following children: + [META_INFO] + [BASIC_INFO] + [LIT_SEARCH_INFO] + [LIST_CURRENT_COMP] + [LIST_PREVIOUS_COMP] + [LIST_BANKRUPTCY] + [LIST_LIT] + [LIST_LIT_DTL] + properties: + META_INFO: + type: object + example: |+ + + + + 25/02/2009 17:31:44.678 + + + description: |+ + Meta Information details with following children: + SERVICE + SYSTEM_ID + CREATION_DATE + USER_ID + properties: + SERVICE: + type: string + example: "BIS" + description: Report Requested + SYSTEM_ID : + type: string + example: "DDP" + description: System ID + CREATION_DATE: + type: datetime + example: "25/02/2009 17:31:44.678" + description: Report Request Date + USER_ID : + type: string + example: N/A + description: Valid user id in DDP system. It is for (For internal use) + BASIC_INFO : + type: object + description: |+ + Basic Information with following children: + PA_REG_NO + ADDRESS1 + ADDRESS2 + ADDRESS3 + example: |+ + + + + + + + properties: + PA_REG_NO: + type: string + description: Public Accountant Registration No. + example: "00091" + ADDRESS1: + type: string + description: Address 1 + example: "137" + ADDRESS2: + type: string + description: Address 2 + example: "vvvvv" + ADDRESS3: + type: string + description: Address 3 + example: "470137, SINGAPORE" + LIT_SEARCH_INFO : + type: object + example: |+ + + + + + 25/02/2009 17:31:44 + + + + + description: |+ + Litigation search information with following children: + COMP_NAME + REG_NO + REPORT_TYPE + REQ_DATE + REQ_REG_NO + REQ_NAME + REQ_DATE_STR + properties: + COMP_NAME: + type: string + description: Company Name + example: "ENG YICK HOLDINGS PTE LTD" + REG_NO: + type: string + description: Company Registration No + example: "197803191K" + REPORT_TYPE: + type: string + description: Report Type + example: "BIS" + REQ_DATE: + type: datetime + description: Requested Date + example: "25/02/2009 17:31:44" + REQ_REG_NO: + type: string + description: Request Registration Number + example: "197803191K" + REQ_NAME: + type: string + description: Request Name + example: "LOY KOK TOON" + REQ_DATE_STR: + type: string + description: Request Date String + example: "25/02/2009 15:04:14" + LIST_CURRENT_COMP : + type: array + description: |+ + List of current companies with following children: + [CURRENT_COMP] + example: |+ + + + + + + + + + + + + + + + + + + + items: + properties: + CURRENT_COMP: + type: object + description: |+ + Current companies detail with following children: + POSITION + APPOINTMENT_DATE + COMP_NAME + SEQ_NO + SHARE_VALUE1 + COMP_STATUS + PROFIT_VALUE + SHARE_VALUE + TEL + FAX + SIC + SIC_DESC + example: |+ + + + + + + + + + + + + + + + + + properties: + POSITION: + type: string + description: Position + example: "OWNER" + APPOINTMENT_DATE: + type: string + description: Appointment Date + example: "01/09/1971" + COMP_NAME: + type: string + description: Company Name + example: "BAN HOE LEONG COMPANY" + SEQ_NO: + type: string + description: Company Registration No. + example: "03647300J" + SHARE_VALUE1: + type: string + description: Share Percentage + example: "15.00" + COMP_STATUS: + type: string + description: Company Status + example: "LIVE" + PROFIT_VALUE1: + type: string + description: Profit Making 1 + example: "2008 = -" + PROFIT_VALUE2: + type: string + description: Profit Making 2 + example: "2007 = -" + PROFIT_VALUE3: + type: string + description: Profit Making 3 + example: "2006 = -" + SHARE_VALUE: + type: string + description: Number Of Shares + example: "150000" + TEL: + type: string + description: Telephone Number + example: "62994842" + FAX: + type: string + description: Fax Number + example: "62992797" + SIC: + type: string + description: SIC Code + example: "5012" + SIC_DESC: + type: string + description: SIC Description + example: "Automobiles and other Motor Vehicles" + LIST_PREVIOUS_COMP: + type: array + example: |+ + + + + + + + + + + + + + + + + + description: |+ + List of previous companies with following children: + [PREVIOUS_COMP] + items: + properties: + PREVIOUS_COMP : + type: object + description: |+ + Previous companies detail with following children: + POSITION + APPOINTMENT_DATE + COMP_NAME + SEQ_NO + SHARE_VALUE1 + COMP_STATUS + CESSATION_DATE + SHARE_VALUE + TEL + FAX + SIC + SIC_DESC + example: |+ + + + + + + + + + + + + + + + properties: + POSITION : + type: string + description: Position + example: "SHAREHOLDER" + APPOINTMENT_DATE: + type: string + description: Appointment Date + example: "30/06/1988" + COMP_NAME: + type: string + description: Company Name + example: "ENG YICK INDUSTRIES PTE LTD" + SEQ_NO: + type: string + description: Company Registration No. + example: "198101820Z" + SHARE_VALUE1: + type: string + description: Share Value Percentage + example: "100.00" + COMP_STATUS: + type: string + description: Company Status + example: "DISSOLVED - COMPULSORY WINDING UP (INSOLVENCY)" + CESSATION_DATE : + type: string + description: Cessation Date + example: "22/09/1992" + SHARE_VALUE: + type: string + description: Number Of Shares + example: "390002" + TEL: + type: string + description: Telephone Number + example: "62994842" + FAX: + type: string + description: Fax Number + example: "67467646" + SIC: + type: string + description: SIC Code + example: "2325" + SIC_DESC: + type: string + description: SIC Description + example: "Men’s and Boys’ Separate Trousers and Slacks" + LIST_BANKRUPTCY: + type: array + description: |+ + Bankruptcy/ Winding up with following children: + [BANKRUPTCY] + example: |+ + + + + + + + + + + + + + + + + + + + + + + + + + + + items: + properties: + BANKRUPTCY : + type: object + description: |+ + Bankruptcy/Winding up detail with following children: + SUBJECT_NAME + COURT_CODE + CASE_CODE + CASE_YEAR + ACTION_DATE + BANKRUPTCY_ACT + HEARING_DATE + CURRENCY1 + AMOUNT1 + CURRENCY2 + AMOUNT2 + CURRENCY3 + AMOUNT3 + BANKRUPTCY_TYPE + [LIST_PLAINTIFF] + example: |+ + + + + + + + + + + + + + + + + + + + + + + + + + properties: + SUBJECT_NAME : + type: string + description: Subject Name + example: + COURT_CODE: + type: string + description: Court Code + example: "CWU" + CASE_CODE: + type: string + description: Case Code + example: "381" + CASE_YEAR: + type: string + description: Case Year + example: "2000" + ACTION_DATE: + type: string + description: Action Date + example: "22/12/2000" + BANKRUPTCY_ACT: + type: string + description: Act of Bankruptcy + example: "Petition for Winding Up" + HEARING_DATE : + type: string + description: Hearing Date + example: "26/03/2009" + CURRENCY1: + type: string + description: Currency + example: + AMOUNT1: + type: string + description: Amount + example: "334,616.00" + CURRENCY2: + type: string + description: Currency + example: + AMOUNT2: + type: string + description: Amount + example: "0.00" + CURRENCY3: + type: string + description: Currency + example: + AMOUNT3: + type: string + description: Amount + example: "0.00" + BANKRUPTCY_TYPE: + type: string + description: Bankruptcy Type + example: "COMPANY WINDING UP PETITION" + LIST_PLAINTIFF: + type: array + description: |+ + List of Plaintiff with following children: + [PLAINTIFF] + example: |+ + + + + + + + + + items: + properties: + PLAINTIFF: + type: object + description: |+ + Plaintiff detail with following children: + PLA_NAME + PLA_SOLICITOR + PLA_SOLICITOR_ID + PLA_FILE_REF + example: |+ + + + + + + + properties: + PLA_NAME: + type: string + description: Pla. Name + example: "B 2003 P1" + PLA_SOLICITOR: + type: string + description: Pla. Solicitor + example: "PATRICK KHOO ENG HOCK" + PLA_SOLICITOR_ID: + type: string + description: Pla. Solicitor ID + example: + PLA_FILE_REF: + type: string + description: Pla. File Ref. + example: "RSP/292668/1" + LIST_LIT: + type: array + description: |+ + List of litigation with following children: + [LIT] + example: |+ + + + + + + + + items: + properties: + LIT: + type: object + description: |+ + Basic litigation info with following children: + SUBJECT_NAME + SEQ_NO + FORMATTED_ID + [LIST_LIT_DTL] + example: |+ + + + + + + properties: + SUBJECT_NAME: + type: string + description: Name + example: "ENG YICK HOLDINGS PTE LTD" + SEQ_NO: + type: integer + description: Sequence No. + example: 1 + FORMATTED_ID: + type: string + description: Formatted ID + example: "197803191K" + LIST_LIT_DTL: + type: array + description: |+ + List of litigation detail with following children: + [LIT_DTL] + example: |+ + + + + + + + + + + + + + + + + + + + + + + + + + + + - + - + S7250163B + + + + + + + + + - + - + S7250163B + + + + + + + + + + + + + items: + properties: + LIT_DTL: + type: object + description: |+ + Litigation detail with following children: + NATURE_OF_CLAIM + STATUS_DATE + CASE_NO + FORMATTED_ID + DOC_REMARKS + CURRENCY1 + CURRENCY2 + CURRENCY3 + CURRENCY4 + CURRENCY5 + CASE_STATUS + AMOUNT1 + AMOUNT2 + AMOUNT3 + AMOUNT4 + AMOUNT5 + [LIST_PLAINTIFF] + [LIST_DEFENDANT] + example: |+ + + + + + + + + + + + + + + + + + + + + + + + + + + - + - + S7250163B + + + + + + + + + - + - + S7250163B + + + + + + + + + + + + properties: + NATURE_OF_CLAIM: + type: string + description: Nature of Claim + example: "CONTRACTS-WORK DONE & SERVICES RENDERED" + STATUS_DATE: + type: string + description: Status Date + example: "13/08/2001" + CASE_NO: + type: string + description: Case No. + example: "MC 23631 / 2001" + FORMATTED_ID: + type: string + description: Formatted ID + example: "197803191K" + DOC_REMARKS: + type: string + description: Document Remark + example: "WRIT OF SUMMONS" + CURRENCY1: + type: string + description: Currency 1 + example: "SIN" + CURRENCY2: + type: string + description: Currency 2 + example: + CURRENCY3: + type: string + description: Currency 3 + example: + CURRENCY4: + type: string + description: Currency 4 + example: + CURRENCY5: + type: string + description: Currency 5 + example: + CASE_STATUS: + type: string + description: Status + example: "PENDING AS AT STATUS DATE" + AMOUNT1: + type: string + description: Amount 1 + example: "36,196.00" + AMOUNT2: + type: string + description: Amount 2 + example: "0.00" + AMOUNT3: + type: string + description: Amount 3 + example: "0.00" + AMOUNT4: + type: string + description: Amount 4 + example: "0.00" + AMOUNT5: + type: string + description: Amount 5 + example: "0.00" + LIST_PLAINTIFF: + type: array + description: |+ + List of plaintiff with following children: + [PLAINTIFF] + example: |+ + + + + + + + + + - + - + S7250163B + + + items: + properties: + PLAINTIFF: + type: object + description: |+ + Plaintiff detail with following children: + PLA_NAME + LAW_FIRM + WRITE_DATE + PLA_SOLICITOR + PLA_SOLICITOR_ID + PLA_FILE_REF + PLA_STATUS + PLA_STATUS_DATE + PLA_ID + example: |+ + + + + + + + + - + - + S7250163B + + properties: + PLA_NAME: + type: string + description: Plaintiff Name + example: "ROTARY PILING PTE LTD" + LAW_FIRM: + type: string + description: Pla. Law Firm + example: "JOSEPH HOO MORRIS & KUMAR" + WRITE_DATE: + type: string + description: Writ date + example: "13/08/2001" + PLA_SOLICITOR: + type: string + description: Plaintiff Solicitor + example: "HOO JOSEPH" + PLA_SOLICITOR_ID: + type: string + description: Plaintiff Solicitor ID + example: "ORS" + PLA_FILE_REF: + type: string + description: Pla. File Ref. + example: "CHH 6253 D27" + PLA_STATUS: + type: string + description: Plaintiff Status + example: + PLA_STATUS_DATE: + type: string + description: Plaintiff Status Date + example: + PLA_ID: + type: string + description: Plaintiff ID + example: "S7250163B" + LIST_DEFENDANT: + type: array + description: |+ + List of defendant with following children: + [DEFENDANT] + example: |+ + + + + + + + + + items: + properties: + DEFENDANT: + type: object + description: |+ + Defendant detail with following children: + DEF_SOLICITOR + DEF_SOLICITOR_ID + DEF_LAW_FIRM + DEF_FILE_REF + example: |+ + + + + + + + properties: + DEF_SOLICITOR: + type: string + description: Def. Solicitor + example: + DEF_SOLICITOR_ID: + type: string + description: Def. Solicitor ID + example: N/A + DEF_LAW_FIRM: + type: string + description: Def. Law Firm + example: + DEF_FILE_REF: + type: string + description: Def. File Ref. + example: + LIST_Ddrptcount: + type: array + description: |+ + List of Search By Financial Sectors and Search By Non-Financial Sectors with following children: + [Ddrptcount] + example: |+ + + + 1 + 1 + 1 + 1 + 1 + 1 + 1 + 1 + 1 + 1 + 1 + 1 + 2017 + 1 + + + items: + properties: + Ddrptcount: + type: object + description: |+ + 6 XML tags (open then close) displays Search By Financial Sectors (counts for 3 recent years).Search By Non-Financial Sectors (counts for 3 recent years) with following children: + Rcjan + Rcfeb + Rcmar + Rcapr + Rcmay + Rcjun + Rcjul + Rcaug + Rcsep + Rcoct + Rcnov + Rcdec + Rcyear + Rcsecflag + example: |+ + + 1 + 1 + 1 + 1 + 1 + 1 + 1 + 1 + 1 + 1 + 1 + 1 + 2017 + 1 + + properties: + Rcjan: + type: integer + description: Count for January + example: "1" + Rcfeb: + type: integer + description: Count for February + example: "1" + Rcmar: + type: integer + description: Count for March + example: "1" + Rcapr: + type: integer + description: Count for April + example: "1" + Rcmay: + type: integer + description: Count for May + example: "1" + Rcjun: + type: integer + description: Count for June + example: "1" + Rcjul: + type: integer + description: Count for July + example: "1" + Rcaug: + type: integer + description: Count for August + example: "1" + Rcsep: + type: integer + description: Count for September + example: "1" + Rcoct: + type: integer + description: Count for October + example: "1" + Rcnov: + type: integer + description: Count for November + example: "1" + Rcdec: + type: integer + description: Count for December + example: "1" + Rcyear: + type: integer + description: To show the year + example: "1" + Rcsecflag: + type: integer + description: Differentiate Search By Financial Sectors and Search By Non-Financial Sectors + example: "1" + unauthorized: + type: object + properties: + message: + type: string + example: Missing Authentication Token + status: + type: string + example: Failure + forbidden: + type: object + properties: + message: + type: string + example: Access Denied Unauthorized User + status: + type: string + example: Failure + paymentrequired: + type: object + properties: + message: + type: string + example: Insufficient Credits Kindly Top Up + status: + type: string + example: Failure + notfound: + type: object + properties: + message: + type: string + example: Invalid Request URL + status: + type: string + example: Failure + servererror: + type: object + properties: + message: + type: string + example: Internal Server Error + status: + type: string + example: Failure + gatewaytimeout: + type: object + properties: + message: + type: string + example: Request Timeout + status: + type: string + example: Failure + inputfieldmissing: + type: object + properties: + message: + type: string + example: Input Field Missing + status: + type: string + example: Failure + inputlimitexceeded: + type: object + properties: + message: + type: string + example: Input Limit Exceeded + status: + type: string + example: Failure + invalidinput: + type: object + properties: + message: + type: string + example: Invalid Input + status: + type: string + example: Failure + input: + type: object + properties: + total_items: + type: number + example: 1 + description: Number of subjects being enquired relating to the Run + default: false + subject_idno: + type: string + example: 199707714C + description: "Subject’s ID Number (individual) or Registration Number (company/business) as captured in DDP" + default: true + subject_name: + type: string + example: GPS INDUSTRIES PTE LTD + description: Subjects Name as captured in DDP + default: false + versions: + type: object + properties: + v1.0.0: + type: array + items: + oneOf: + - type: string + example: Published Date - Apr 09, 2021 + description: Optimized and Standardized results in Json Format + v0.1.0: + type: array + items: + oneOf: + - type: string + example: Published Date - Aug 15, 2019 + description: Initial version release + securitySchemes: + APIAuthorizer: + type: apiKey + name: x-api-key + in: header + x-amazon-apigateway-authtype: custom + description: Authentication is done using the x-api-key in the request header From c3ba20b5cd570beb4b33f255aab44b2969a0f235 Mon Sep 17 00:00:00 2001 From: Mohamed Luqman <57977684+mohamedSent@users.noreply.github.com> Date: Wed, 17 Mar 2021 09:10:08 +0530 Subject: [PATCH 746/792] Update index.yaml --- index.yaml | 1 + 1 file changed, 1 insertion(+) diff --git a/index.yaml b/index.yaml index 25000470c..33aa71a9e 100644 --- a/index.yaml +++ b/index.yaml @@ -272,6 +272,7 @@ data: d&b_basic_individual_search_sg: title: D&B Basic Individual Search (SG) versions: + 1.0.0: 'd&b_basic_individual_search_sg_v1.0.yaml' 0.1.0: 'd&b_basic_individual_search_sg.yaml' d&b_business_check_sg: title: D&B Business Check (SG) From b8765c5d8ba10923c5c9fec87b4cdf3afeabd40c Mon Sep 17 00:00:00 2001 From: Mohamed Luqman <57977684+mohamedSent@users.noreply.github.com> Date: Wed, 17 Mar 2021 09:16:36 +0530 Subject: [PATCH 747/792] Update d&b_basic_individual_search_sg.yaml --- data/d&b_basic_individual_search_sg.yaml | 13 ++++++------- 1 file changed, 6 insertions(+), 7 deletions(-) diff --git a/data/d&b_basic_individual_search_sg.yaml b/data/d&b_basic_individual_search_sg.yaml index d651d38ef..642bfee25 100644 --- a/data/d&b_basic_individual_search_sg.yaml +++ b/data/d&b_basic_individual_search_sg.yaml @@ -6,31 +6,30 @@ info: x-additionalinfo: |+ Suggested Use Cases: - Software solutions that require personal checks, e.g. in the appointment of Board Members, Directorship or C-suite level hiring, where the appointee’s background is paramount to the Company and its reputation. - - - Swift pre-employment screening solution - information provided by the microservice can be used to protect one's company's reputation from potential negative publicity by conducting background checks on individuals prior to hiring. + - Swift pre-employment screening solution - information provided by the microservice can be used to protect one's company's reputation from potential negative publicity by conducting background checks on individuals prior to hiring. version: '0.1.0' x-subscribelink: d&b_basic_individual_search_sg servers: - - url: 'https://dev-apis.sentient.io' + - url: 'https://api.sentient.io' tags: - name: "v0.1.0" description: "Published Date - Aug 15, 2019" paths: - /microservices/data/sbis/v0/getdata: + /dnb/prod/sbis: post: tags: - - v0 + - v0.1.0 summary: Adds a new user requestBody: content: - application/json: + application/xml: schema: $ref: '#/components/schemas/REQUEST' responses: '200': description: Ok content: - application/json: + application/xml: schema: $ref: '#/components/schemas/success' example: |+ From b866ef457b31fafee5a1a1c2bd5b039ffc82aa78 Mon Sep 17 00:00:00 2001 From: Mohamed Luqman <57977684+mohamedSent@users.noreply.github.com> Date: Wed, 17 Mar 2021 10:07:52 +0530 Subject: [PATCH 748/792] Update d&b_basic_individual_search_sg_v1.0.yaml --- data/d&b_basic_individual_search_sg_v1.0.yaml | 945 ++++++++++-------- 1 file changed, 521 insertions(+), 424 deletions(-) diff --git a/data/d&b_basic_individual_search_sg_v1.0.yaml b/data/d&b_basic_individual_search_sg_v1.0.yaml index 68c591a46..b2af4a05a 100644 --- a/data/d&b_basic_individual_search_sg_v1.0.yaml +++ b/data/d&b_basic_individual_search_sg_v1.0.yaml @@ -32,74 +32,215 @@ paths: application/json: schema: $ref: '#/components/schemas/success' - example: |+ - - 25/02/2009 17:31:44.678 - - - - - - 25/02/2009 17:31:44 - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - S7250163B - - - - - S7250163B - - - - - - 1 1 1 1 1 1 1 1 1 1 1 1 2017 1 - - 0 0 0 0 0 0 0 0 0 0 0 0 2016 1 - - 0 0 0 0 0 0 0 0 0 0 0 0 2015 1 - - 0 0 0 0 0 0 0 0 0 0 0 0 2017 0 - - 0 0 0 0 0 0 0 0 0 0 0 0 2016 0 - - 0 0 0 0 0 0 0 0 0 0 0 - 0 2015 0 - - + example: + REPORT: + META_INFO: + SERVICE: BIS + SYSTEM_ID: DDP + CREATION_DATE: 25/02/2009 17:31:44.678 + USER_ID: plcust102 + BASIC_INFO: + PA_REG_NO: + "@type": String + "#text": '00091' + ADDRESS1: 137, BEDOK RESERVOIR ROAD, 06 - 1451 + ADDRESS2: "-" + ADDRESS3: 470137, SINGAPORE + LIT_SEARCH_INFO: + COMP_NAME: ENG YICK HOLDINGS PTE LTD + REG_NO: 197803191K + REPORT_TYPE: BIS + REQ_DATE: 25/02/2009 17:31:44 + REQ_REG_NO: 197803191K + REQ_NAME: LOY KOK TOON + REQ_DATE_STR: 25/02/2009 15:04:14 + LIST_CURRENT_COMP: + CURRENT_COMP: + POSITION: OWNER + APPOINTMENT_DATE: 01/09/1971 + COMP_NAME: BAN HOE LEONG COMPANY + SEQ_NO: 03647300J + SHARE_VALUE1: '15.00' + COMP_STATUS: LIVE + PROFIT_VALUE1: 2008 = - + PROFIT_VALUE2: 2007 = - + PROFIT_VALUE3: 2006 = - + SHARE_VALUE: '150000' + TEL: '62994842' + FAX: '62992797' + SIC: '5012' + SIC_DESC: Automobiles and other Motor Vehicles + LIST_PREVIOUS_COMP: + PREVIOUS_COMP: + POSITION: SHAREHOLDER + APPOINTMENT_DATE: 30/06/1988 + COMP_NAME: ENG YICK INDUSTRIES PTE LTD + SEQ_NO: 198101820Z + SHARE_VALUE1: '100.00' + COMP_STATUS: DISSOLVED - COMPULSORY WINDING UP (INSOLVENCY) + CESSATION_DATE: 22/09/1992 + SHARE_VALUE: '390002' + TEL: '62994842' + FAX: '67467646' + SIC: '2325' + SIC_DESC: Menâ€TMs and Boysâ€TM Separate Trousers and Slacks + LIST_BANKRUPTCY: + BANKRUPTCY: + SUBJECT_NAME: "-" + COURT_CODE: CWU + CASE_CODE: '381' + CASE_YEAR: '2000' + ACTION_DATE: 22/12/2000 + BANKRUPTCY_ACT: Petition for Winding Up + HEARING_DATE: 26/03/2009 + CURRENCY1: "-" + AMOUNT1: '334,616.00' + CURRENCY2: "-" + AMOUNT2: '0.00' + CURRENCY3: "-" + AMOUNT3: '0.00' + BANKRUPTCY_TYPE: COMPANY WINDING UP PETITION + LIST_PLAINTIFF: + PLAINTIFF: + PLA_NAME: B 2003 P1 + PLA_SOLICITOR: PATRICK KHOO ENG HOCK + PLA_SOLICITOR_ID: "-" + PLA_FILE_REF: RSP/292668/1 + LIST_LIT: + LIT: + SUBJECT_NAME: ENG YICK HOLDINGS PTE LTD + SEQ_NO: '1' + FORMATTED_ID: 197803191K + LIST_LIT_DTL: + LIT_DTL: + NATURE_OF_CLAIM: CONTRACTS-WORK DONE & SERVICES RENDERED + STATUS_DATE: 13/08/2001 + CASE_NO: MC 23631 / 2001 + FORMATTED_ID: 197803191K + DOC_REMARKS: WRIT OF SUMMONS + CURRENCY1: SIN + CURRENCY2: "-" + CURRENCY3: "-" + CURRENCY4: "-" + CURRENCY5: "-" + CASE_STATUS: PENDING AS AT STATUS DATE + AMOUNT1: '36,196.00' + AMOUNT2: '0.00' + AMOUNT3: '0.00' + AMOUNT4: '0.00' + AMOUNT5: '0.00' + LIST_PLAINTIFF: + PLAINTIFF: + - PLA_NAME: ROTARY PILING PTE LTD + LAW_FIRM: JOSEPH HOO MORRIS & KUMAR + WRITE_DATE: 13/08/2001 + PLA_SOLICITOR: HOO JOSEPH + PLA_SOLICITOR_ID: ORS + PLA_FILE_REF: CHH 6253 D27 + PLA_STATUS: "-" + PLA_STATUS_DATE: "-" + PLA_ID: S7250163B + - PLA_NAME: ABC PTE LTD + LAW_FIRM: JAMES & JOE + WRITE_DATE: 13/08/2001 + PLA_SOLICITOR: KHOO JAMES + PLA_SOLICITOR_ID: ORS + PLA_FILE_REF: CHH 6253 X10 + PLA_STATUS: "-" + PLA_STATUS_DATE: "-" + PLA_ID: S7250163B + LIST_DEFENDANT: + DEFENDANT: + DEF_SOLICITOR: "-" + DEF_SOLICITOR_ID: N/A + DEF_LAW_FIRM: "-" + DEF_FILE_REF: "-" + LIST_Ddrptcount: + Ddrptcount: + - Rcjan: '1' + Rcfeb: '1' + Rcmar: '1' + Rcapr: '1' + Rcmay: '1' + Rcjun: '1' + Rcjul: '1' + Rcaug: '1' + Rcsep: '1' + Rcoct: '1' + Rcnov: '1' + Rcdec: '1' + Rcyear: '2017' + Rcsecflag: '1' + - Rcjan: '0' + Rcfeb: '0' + Rcmar: '0' + Rcapr: '0' + Rcmay: '0' + Rcjun: '0' + Rcjul: '0' + Rcaug: '0' + Rcsep: '0' + Rcoct: '0' + Rcnov: '0' + Rcdec: '0' + Rcyear: '2016' + Rcsecflag: '1' + - Rcjan: '0' + Rcfeb: '0' + Rcmar: '0' + Rcapr: '0' + Rcmay: '0' + Rcjun: '0' + Rcjul: '0' + Rcaug: '0' + Rcsep: '0' + Rcoct: '0' + Rcnov: '0' + Rcdec: '0' + Rcyear: '2015' + Rcsecflag: '1' + - Rcjan: '0' + Rcfeb: '0' + Rcmar: '0' + Rcapr: '0' + Rcmay: '0' + Rcjun: '0' + Rcjul: '0' + Rcaug: '0' + Rcsep: '0' + Rcoct: '0' + Rcnov: '0' + Rcdec: '0' + Rcyear: '2017' + Rcsecflag: '0' + - Rcjan: '0' + Rcfeb: '0' + Rcmar: '0' + Rcapr: '0' + Rcmay: '0' + Rcjun: '0' + Rcjul: '0' + Rcaug: '0' + Rcsep: '0' + Rcoct: '0' + Rcnov: '0' + Rcdec: '0' + Rcyear: '2016' + Rcsecflag: '0' + - Rcjan: '0' + Rcfeb: '0' + Rcmar: '0' + Rcapr: '0' + Rcmay: '0' + Rcjun: '0' + Rcjul: '0' + Rcaug: '0' + Rcsep: '0' + Rcoct: '0' + Rcnov: '0' + Rcdec: '0' + Rcyear: '2015' + Rcsecflag: '0' '401': description: Unauthorized content: @@ -177,13 +318,12 @@ components: properties: META_INFO: type: object - example: |+ - - - - 25/02/2009 17:31:44.678 - - + example: + META_INFO: + SERVICE: BIS + SYSTEM_ID: DDP + CREATION_DATE: 25/02/2009 17:31:44.678 + USER_ID: plcust102 description: |+ Meta Information details with following children: SERVICE @@ -215,13 +355,14 @@ components: ADDRESS1 ADDRESS2 ADDRESS3 - example: |+ - - - - - - + example: + BASIC_INFO: + PA_REG_NO: + "@type": String + "#text": '00091' + ADDRESS1: 137, BEDOK RESERVOIR ROAD, 06 - 1451 + ADDRESS2: "-" + ADDRESS3: 470137, SINGAPORE properties: PA_REG_NO: type: string @@ -241,16 +382,15 @@ components: example: "470137, SINGAPORE" LIT_SEARCH_INFO : type: object - example: |+ - - - - - 25/02/2009 17:31:44 - - - - + example: + LIT_SEARCH_INFO: + COMP_NAME: ENG YICK HOLDINGS PTE LTD + REG_NO: 197803191K + REPORT_TYPE: BIS + REQ_DATE: 25/02/2009 17:31:44 + REQ_REG_NO: 197803191K + REQ_NAME: LOY KOK TOON + REQ_DATE_STR: 25/02/2009 15:04:14 description: |+ Litigation search information with following children: COMP_NAME @@ -294,25 +434,23 @@ components: description: |+ List of current companies with following children: [CURRENT_COMP] - example: |+ - - - - - - - - - - - - - - - - - - + example: + LIST_CURRENT_COMP: + CURRENT_COMP: + POSITION: OWNER + APPOINTMENT_DATE: 01/09/1971 + COMP_NAME: BAN HOE LEONG COMPANY + SEQ_NO: 03647300J + SHARE_VALUE1: '15.00' + COMP_STATUS: LIVE + PROFIT_VALUE1: 2008 = - + PROFIT_VALUE2: 2007 = - + PROFIT_VALUE3: 2006 = - + SHARE_VALUE: '150000' + TEL: '62994842' + FAX: '62992797' + SIC: '5012' + SIC_DESC: Automobiles and other Motor Vehicles items: properties: CURRENT_COMP: @@ -331,23 +469,22 @@ components: FAX SIC SIC_DESC - example: |+ - - - - - - - - - - - - - - - - + example: + CURRENT_COMP: + POSITION: OWNER + APPOINTMENT_DATE: 01/09/1971 + COMP_NAME: BAN HOE LEONG COMPANY + SEQ_NO: 03647300J + SHARE_VALUE1: '15.00' + COMP_STATUS: LIVE + PROFIT_VALUE1: 2008 = - + PROFIT_VALUE2: 2007 = - + PROFIT_VALUE3: 2006 = - + SHARE_VALUE: '150000' + TEL: '62994842' + FAX: '62992797' + SIC: '5012' + SIC_DESC: Automobiles and other Motor Vehicles properties: POSITION: type: string @@ -407,23 +544,21 @@ components: example: "Automobiles and other Motor Vehicles" LIST_PREVIOUS_COMP: type: array - example: |+ - - - - - - - - - - - - - - - - + example: + LIST_PREVIOUS_COMP: + PREVIOUS_COMP: + POSITION: SHAREHOLDER + APPOINTMENT_DATE: 30/06/1988 + COMP_NAME: ENG YICK INDUSTRIES PTE LTD + SEQ_NO: 198101820Z + SHARE_VALUE1: '100.00' + COMP_STATUS: DISSOLVED - COMPULSORY WINDING UP (INSOLVENCY) + CESSATION_DATE: 22/09/1992 + SHARE_VALUE: '390002' + TEL: '62994842' + FAX: '67467646' + SIC: '2325' + SIC_DESC: Men’s and Boys’ Separate Trousers and Slacks description: |+ List of previous companies with following children: [PREVIOUS_COMP] @@ -445,21 +580,20 @@ components: FAX SIC SIC_DESC - example: |+ - - - - - - - - - - - - - - + example: + PREVIOUS_COMP: + POSITION: SHAREHOLDER + APPOINTMENT_DATE: 30/06/1988 + COMP_NAME: ENG YICK INDUSTRIES PTE LTD + SEQ_NO: 198101820Z + SHARE_VALUE1: '100.00' + COMP_STATUS: DISSOLVED - COMPULSORY WINDING UP (INSOLVENCY) + CESSATION_DATE: 22/09/1992 + SHARE_VALUE: '390002' + TEL: '62994842' + FAX: '67467646' + SIC: '2325' + SIC_DESC: Men’s and Boys’ Separate Trousers and Slacks properties: POSITION : type: string @@ -514,33 +648,29 @@ components: description: |+ Bankruptcy/ Winding up with following children: [BANKRUPTCY] - example: |+ - - - - - - - - - - - - - - - - - - - - - - - - - - + example: + LIST_BANKRUPTCY: + BANKRUPTCY: + SUBJECT_NAME: "-" + COURT_CODE: CWU + CASE_CODE: '381' + CASE_YEAR: '2000' + ACTION_DATE: 22/12/2000 + BANKRUPTCY_ACT: Petition for Winding Up + HEARING_DATE: 26/03/2009 + CURRENCY1: "-" + AMOUNT1: '334,616.00' + CURRENCY2: "-" + AMOUNT2: '0.00' + CURRENCY3: "-" + AMOUNT3: '0.00' + BANKRUPTCY_TYPE: COMPANY WINDING UP PETITION + LIST_PLAINTIFF: + PLAINTIFF: + PLA_NAME: B 2003 P1 + PLA_SOLICITOR: PATRICK KHOO ENG HOCK + PLA_SOLICITOR_ID: "-" + PLA_FILE_REF: RSP/292668/1 items: properties: BANKRUPTCY : @@ -562,31 +692,28 @@ components: AMOUNT3 BANKRUPTCY_TYPE [LIST_PLAINTIFF] - example: |+ - - - - - - - - - - - - - - - - - - - - - - - - + example: + BANKRUPTCY: + SUBJECT_NAME: "-" + COURT_CODE: CWU + CASE_CODE: '381' + CASE_YEAR: '2000' + ACTION_DATE: 22/12/2000 + BANKRUPTCY_ACT: Petition for Winding Up + HEARING_DATE: 26/03/2009 + CURRENCY1: "-" + AMOUNT1: '334,616.00' + CURRENCY2: "-" + AMOUNT2: '0.00' + CURRENCY3: "-" + AMOUNT3: '0.00' + BANKRUPTCY_TYPE: COMPANY WINDING UP PETITION + LIST_PLAINTIFF: + PLAINTIFF: + PLA_NAME: B 2003 P1 + PLA_SOLICITOR: PATRICK KHOO ENG HOCK + PLA_SOLICITOR_ID: "-" + PLA_FILE_REF: RSP/292668/1 properties: SUBJECT_NAME : type: string @@ -649,15 +776,13 @@ components: description: |+ List of Plaintiff with following children: [PLAINTIFF] - example: |+ - - - - - - - - + example: + LIST_PLAINTIFF: + PLAINTIFF: + PLA_NAME: B 2003 P1 + PLA_SOLICITOR: PATRICK KHOO ENG HOCK + PLA_SOLICITOR_ID: "-" + PLA_FILE_REF: RSP/292668/1 items: properties: PLAINTIFF: @@ -668,13 +793,12 @@ components: PLA_SOLICITOR PLA_SOLICITOR_ID PLA_FILE_REF - example: |+ - - - - - - + example: + PLAINTIFF: + PLA_NAME: B 2003 P1 + PLA_SOLICITOR: PATRICK KHOO ENG HOCK + PLA_SOLICITOR_ID: "-" + PLA_FILE_REF: RSP/292668/1 properties: PLA_NAME: type: string @@ -697,14 +821,12 @@ components: description: |+ List of litigation with following children: [LIT] - example: |+ - - - - - - - + example: + LIST_LIT: + LIT: + SUBJECT_NAME: ENG YICK HOLDINGS PTE LTD + SEQ_NO: '1' + FORMATTED_ID: 197803191K items: properties: LIT: @@ -715,12 +837,11 @@ components: SEQ_NO FORMATTED_ID [LIST_LIT_DTL] - example: |+ - - - - - + example: + LIT: + SUBJECT_NAME: ENG YICK HOLDINGS PTE LTD + SEQ_NO: '1' + FORMATTED_ID: 197803191K properties: SUBJECT_NAME: type: string @@ -739,59 +860,51 @@ components: description: |+ List of litigation detail with following children: [LIT_DTL] - example: |+ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - S7250163B - - - - - - - - - - - - - S7250163B - - - - - - - - - - - - + example: + LIST_LIT_DTL: + LIT_DTL: + NATURE_OF_CLAIM: CONTRACTS-WORK DONE & SERVICES RENDERED + STATUS_DATE: 13/08/2001 + CASE_NO: MC 23631 / 2001 + FORMATTED_ID: 197803191K + DOC_REMARKS: WRIT OF SUMMONS + CURRENCY1: SIN + CURRENCY2: "-" + CURRENCY3: "-" + CURRENCY4: "-" + CURRENCY5: "-" + CASE_STATUS: PENDING AS AT STATUS DATE + AMOUNT1: '36,196.00' + AMOUNT2: '0.00' + AMOUNT3: '0.00' + AMOUNT4: '0.00' + AMOUNT5: '0.00' + LIST_PLAINTIFF: + PLAINTIFF: + - PLA_NAME: ROTARY PILING PTE LTD + LAW_FIRM: JOSEPH HOO MORRIS & KUMAR + WRITE_DATE: 13/08/2001 + PLA_SOLICITOR: HOO JOSEPH + PLA_SOLICITOR_ID: ORS + PLA_FILE_REF: CHH 6253 D27 + PLA_STATUS: "-" + PLA_STATUS_DATE: "-" + PLA_ID: S7250163B + - PLA_NAME: ABC PTE LTD + LAW_FIRM: JAMES & JOE + WRITE_DATE: 13/08/2001 + PLA_SOLICITOR: KHOO JAMES + PLA_SOLICITOR_ID: ORS + PLA_FILE_REF: CHH 6253 X10 + PLA_STATUS: "-" + PLA_STATUS_DATE: "-" + PLA_ID: S7250163B + LIST_DEFENDANT: + DEFENDANT: + DEF_SOLICITOR: "-" + DEF_SOLICITOR_ID: N/A + DEF_LAW_FIRM: "-" + DEF_FILE_REF: "-" items: properties: LIT_DTL: @@ -816,57 +929,50 @@ components: AMOUNT5 [LIST_PLAINTIFF] [LIST_DEFENDANT] - example: |+ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - S7250163B - - - - - - - - - - - - - S7250163B - - - - - - - - - - - + example: + LIT_DTL: + NATURE_OF_CLAIM: CONTRACTS-WORK DONE & SERVICES RENDERED + STATUS_DATE: 13/08/2001 + CASE_NO: MC 23631 / 2001 + FORMATTED_ID: 197803191K + DOC_REMARKS: WRIT OF SUMMONS + CURRENCY1: SIN + CURRENCY2: "-" + CURRENCY3: "-" + CURRENCY4: "-" + CURRENCY5: "-" + CASE_STATUS: PENDING AS AT STATUS DATE + AMOUNT1: '36,196.00' + AMOUNT2: '0.00' + AMOUNT3: '0.00' + AMOUNT4: '0.00' + AMOUNT5: '0.00' + LIST_PLAINTIFF: + PLAINTIFF: + - PLA_NAME: ROTARY PILING PTE LTD + LAW_FIRM: JOSEPH HOO MORRIS & KUMAR + WRITE_DATE: 13/08/2001 + PLA_SOLICITOR: HOO JOSEPH + PLA_SOLICITOR_ID: ORS + PLA_FILE_REF: CHH 6253 D27 + PLA_STATUS: "-" + PLA_STATUS_DATE: "-" + PLA_ID: S7250163B + - PLA_NAME: ABC PTE LTD + LAW_FIRM: JAMES & JOE + WRITE_DATE: 13/08/2001 + PLA_SOLICITOR: KHOO JAMES + PLA_SOLICITOR_ID: ORS + PLA_FILE_REF: CHH 6253 X10 + PLA_STATUS: "-" + PLA_STATUS_DATE: "-" + PLA_ID: S7250163B + LIST_DEFENDANT: + DEFENDANT: + DEF_SOLICITOR: "-" + DEF_SOLICITOR_ID: N/A + DEF_LAW_FIRM: "-" + DEF_FILE_REF: "-" properties: NATURE_OF_CLAIM: type: string @@ -937,20 +1043,18 @@ components: description: |+ List of plaintiff with following children: [PLAINTIFF] - example: |+ - - - - - - - - - - - - - S7250163B - - + example: + LIST_PLAINTIFF: + PLAINTIFF: + PLA_NAME: ROTARY PILING PTE LTD + LAW_FIRM: JOSEPH HOO MORRIS & KUMAR + WRITE_DATE: 13/08/2001 + PLA_SOLICITOR: HOO JOSEPH + PLA_SOLICITOR_ID: ORS + PLA_FILE_REF: CHH 6253 D27 + PLA_STATUS: "-" + PLA_STATUS_DATE: "-" + PLA_ID: S7250163B items: properties: PLAINTIFF: @@ -966,18 +1070,17 @@ components: PLA_STATUS PLA_STATUS_DATE PLA_ID - example: |+ - - - - - - - - - - - - S7250163B - + example: + PLAINTIFF: + PLA_NAME: ROTARY PILING PTE LTD + LAW_FIRM: JOSEPH HOO MORRIS & KUMAR + WRITE_DATE: 13/08/2001 + PLA_SOLICITOR: HOO JOSEPH + PLA_SOLICITOR_ID: ORS + PLA_FILE_REF: CHH 6253 D27 + PLA_STATUS: "-" + PLA_STATUS_DATE: "-" + PLA_ID: S7250163B properties: PLA_NAME: type: string @@ -1020,15 +1123,13 @@ components: description: |+ List of defendant with following children: [DEFENDANT] - example: |+ - - - - - - - - + example: + LIST_DEFENDANT: + DEFENDANT: + DEF_SOLICITOR: "-" + DEF_SOLICITOR_ID: N/A + DEF_LAW_FIRM: "-" + DEF_FILE_REF: "-" items: properties: DEFENDANT: @@ -1039,13 +1140,12 @@ components: DEF_SOLICITOR_ID DEF_LAW_FIRM DEF_FILE_REF - example: |+ - - - - - - + example: + DEFENDANT: + DEF_SOLICITOR: "-" + DEF_SOLICITOR_ID: N/A + DEF_LAW_FIRM: "-" + DEF_FILE_REF: "-" properties: DEF_SOLICITOR: type: string @@ -1068,25 +1168,23 @@ components: description: |+ List of Search By Financial Sectors and Search By Non-Financial Sectors with following children: [Ddrptcount] - example: |+ - - - 1 - 1 - 1 - 1 - 1 - 1 - 1 - 1 - 1 - 1 - 1 - 1 - 2017 - 1 - - + example: + LIST_Ddrptcount: + Ddrptcount: + Rcjan: '1' + Rcfeb: '1' + Rcmar: '1' + Rcapr: '1' + Rcmay: '1' + Rcjun: '1' + Rcjul: '1' + Rcaug: '1' + Rcsep: '1' + Rcoct: '1' + Rcnov: '1' + Rcdec: '1' + Rcyear: '2017' + Rcsecflag: '1' items: properties: Ddrptcount: @@ -1107,23 +1205,22 @@ components: Rcdec Rcyear Rcsecflag - example: |+ - - 1 - 1 - 1 - 1 - 1 - 1 - 1 - 1 - 1 - 1 - 1 - 1 - 2017 - 1 - + example: + Ddrptcount: + Rcjan: '1' + Rcfeb: '1' + Rcmar: '1' + Rcapr: '1' + Rcmay: '1' + Rcjun: '1' + Rcjul: '1' + Rcaug: '1' + Rcsep: '1' + Rcoct: '1' + Rcnov: '1' + Rcdec: '1' + Rcyear: '2017' + Rcsecflag: '1' properties: Rcjan: type: integer From 3ce6f9683ec69b92c32157a73059c5c7010d721b Mon Sep 17 00:00:00 2001 From: Mohamed Luqman <57977684+mohamedSent@users.noreply.github.com> Date: Wed, 17 Mar 2021 10:23:08 +0530 Subject: [PATCH 749/792] initial commit of version1 --- data/d&b_business_check_sg_v1.0.yaml | 1144 ++++++++++++++++++++++++++ 1 file changed, 1144 insertions(+) create mode 100644 data/d&b_business_check_sg_v1.0.yaml diff --git a/data/d&b_business_check_sg_v1.0.yaml b/data/d&b_business_check_sg_v1.0.yaml new file mode 100644 index 000000000..41f3f6aee --- /dev/null +++ b/data/d&b_business_check_sg_v1.0.yaml @@ -0,0 +1,1144 @@ +openapi: 3.0.1 +info: + title: D&B Business Check (SG) + description: |+ + This Data microservice provides key business information of a Singapore-registered company and includes the business name, registration number, registered address and date of change, company status, registered activities, shareholders details (i.e. date of commencement, residing address) capital amount and shares allocated to each shareholders. Updated daily. + x-additionalinfo: |+ + Suggested Use Cases: + - For software solutions that require general background checks of a company. This microservice can provide a high level of scrutiny of potential business associates, and throw light on the risks that cannot be detected by geopolitical analysis or batch screening levels. + - For example, this microservice can be used to check if a Singapore-registered company meets regulations, such as if the company complies with anti-money laundering, anti-bribery, and corruption regulations by looking at registered activities, shareholders details, and more. + - It can also be used to simplify the due diligence process, by identify risk issues using a range of reports that meet different compliance requirements. + - It can also be used to protect your business – safeguard against reputational risk by avoiding those involved in financial crime. + - It can also be used for finance-related domains such as vehicle leasing, loans, enterprise credit terms and so on. Updated daily. + version: '1.0.0' + x-subscribelink: d&b_business_check_sg +servers: + - url: 'https://dev-apis.sentient.io' +tags: +- name: "v1.0.0" + description: "Published Date - Apr 09, 2021" +paths: + /microservices/data/sbc/v0/getdata: + post: + tags: + - v1.0.0 + summary: Adds a new user + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/input' + responses: + '200': + description: Ok + content: + application/json: + schema: + $ref: '#/components/schemas/success' + example: |+ + string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string 0
string
+ string string string string string string string string string string string string string
string
+ + string string string string string string string string string string string string string string string + '401': + description: Unauthorized + content: + application/json: + schema: + $ref: '#/components/schemas/unauthorized' + '402': + description: Payment Required + content: + application/json: + schema: + $ref: '#/components/schemas/paymentrequired' + '403': + description: Forbidden + content: + application/json: + schema: + $ref: '#/components/schemas/forbidden' + '404': + description: Not Found + content: + application/json: + schema: + $ref: '#/components/schemas/notfound' + '419': + description: Input Field Missing + content: + application/json: + schema: + $ref: '#/components/schemas/inputfieldmissing' + '413': + description: Payload Too Large + content: + application/json: + schema: + $ref: '#/components/schemas/inputlimitexceeded' + '415': + description: Unsupported Media Type + content: + application/json: + schema: + $ref: '#/components/schemas/invalidinput' + '500': + description: Internal Server Error + content: + application/json: + schema: + $ref: '#/components/schemas/servererror' + '504': + description: Gateway Timeout + content: + application/json: + schema: + $ref: '#/components/schemas/gatewaytimeout' + security: + - APIAuthorizer: [] +components: + schemas: + success: + type: object + properties: + REPORT: + type: object + example: + description: |+ + Report details with following children: + [META_INFO] + [REGISTRY_DETAIL] + [REQ_SEARCH_INFO] + [EMPLOYEE_SIZE] + [LIST_BIZ_BRANCH] + [LIST_REG_CHARGES] + [LIST_LIQUIDATOR] + [LIST_SHARE_INTEREST_COMP] + [LIST_NAME_CHANGE] + [LIST_SHAREHOLDER] + [LIST_CAPITAL] + [LIST_OFFICER_OWNER] + [LIST_SALES_REVENUE_AMOUNT] + properties: + META_INFO: + type: object + example: |+ + + + + + + + + description: |+ + Meta Information details with following children: + SERVICE + SYSTEM_ID + CREATION_DATE + USER_ID + CLASS + properties: + SERVICE: + type: string + description: Report requested + example: "BC" + SYSTEM_ID : + type: string + description: System ID + example: "DDP" + CREATION_DATE: + type: datetime + description: Report request date + example: "Wed Apr 08 11:37:51 MYT 2009" + USER_ID : + type: string + description: Valid user id in DDP system. It is for (For internal use) + example: "N/A" + CLASS: + type: string + description: Class location for metabean. It is for (For internal use) + example: "N/A" + REGISTRY_DETAIL : + type: object + example: |+ + + + + + + + + + + + + + + + + + + + + + + + + + + description: |+ + Registry Details with following children: + RENEWAL_DATE + ADDRESS1 + ADDRESS2 + ADDRESS3 + ADDRESS4 + COMP_TYPE_CODE + REG_DATE + REG_ACTIVITY1 + REG_ACTIVITY2 + ACC_DATE + STATUS_EFFECT_DATE + NAME_EFFECT_DATE + EXPIRY_DATE + COMP_TYPE + CHANGE_ADDR_DATE + COMP_STATUS + REG_ACTIVITY_DESC1 + REG_ACTIVITY_DESC2 + AUDITOR + AUDITOR_APPMT_DATE + LAST_AR_DATE + LAST_AGM_DATE + COUNTRY_INCORP + properties: + RENEWAL_DATE: + type: string + description: Renewal Date + example: "23/12/2008" + ADDRESS1: + type: string + description: Address Line 1 + example: "1 HARBOURFRONT AVENUE , 18 - 01" + ADDRESS2: + type: string + description: Address Line 2 + example: "KEPPEL BAY TOWER" + ADDRESS3: + type: string + description: Address Line 3 + example: "098632" + ADDRESS4: + type: string + description: Address Line 4 + example: "SINGAPORE" + COMP_TYPE_CODE: + type: string + example: CP + description: |+ + Report Code. Available values are: + 1. CP Corporate + 2. SP Sole Proprietor + REG_DATE: + type: string + description: Registration Date + example: "14/10/1974" + REG_ACTIVITY1: + type: string + description: Registered Activities 1 + example: "OTHER INVESTMENT HOLDING COMPANIES" + REG_ACTIVITY2: + type: string + description: Registered Activities 2 + example: "SHIP MANAGEMENT SERVICES" + ACC_DATE: + type: string + description: Account Date + example: "31/12/2007" + STATUS_EFFECT_DATE: + type: string + description: Status Effective Date + example: "14/10/1974" + NAME_EFFECT_DATE: + type: string + description: Name Effective Date + example: "14/10/1974" + EXPIRY_DATE: + type: string + description: Expiry Date + example: "25/10/2009" + COMP_TYPE: + type: string + description: Company Type + example: "LIMITED PRIVATE COMPANY" + CHANGE_ADDR_DATE: + type: string + description: Change Address Date + example: "09/05/2003" + COMP_STATUS: + type: string + description: Company Status + example: "Live Company" + REG_ACTIVITY_DESC1: + type: string + description: Registered Activities Description + example: + REG_ACTIVITY_DESC2: + type: string + description: Registered Activities Description + example: + AUDITOR: + type: string + description: Auditor Name + example: + AUDITOR_APPMT_DATE: + type: string + description: Auditor Appointment Date + example: "13/06/1990" + LAST_AR_DATE: + type: string + description: Date of Last AR + example: "30/06/2008" + LAST_AGM_DATE: + type: string + description: Date of Last AGM + example: "11/06/2008" + COUNTRY_INCORP: + type: string + description: Country Incorporated + example: "SINGAPORE" + REQ_SEARCH_INFO : + type: object + example: |+ + + + + + + + + + description: |+ + Request criteria & search record with following children: + COMP_NAME + REG_NO + REQ_DATE + REQ_REG_NO + REQ_NAME + REQ_DATE_STR + properties: + COMP_NAME: + type: string + description: Company Name + example: "KAPAL MANAGEMENT (PRIVATE) LIMITED" + REG_NO: + type: string + description: Subject’s ID Number (individual) or Registration Number (company/business) + example: "197401835M" + REQ_DATE: + type: string + description: Report Requested Date + example: "2009-04-08 11:36:03.611" + REQ_REG_NO: + type: string + description: Request Registration Number + example: "197401835M" + REQ_NAME: + type: string + description: Request Name + example: "KAPAL MANAGEMENT (PRIVATE) LIMITED" + REQ_DATE_STR: + type: string + description: Request Date String + example: "08/04/2009 11:36:03" + EMPLOYEE_SIZE : + type: object + description: |+ + Employee Size details with following children: + ELEMENTS + AMOUNT + example: |+ + + + 300 + + properties: + ELEMENTS: + type: string + description: Description + example: "Employee Size" + AMOUNT: + type: string + description: Number of employee + example: "300" + LIST_BIZ_BRANCH : + type: array + description: |+ + List of Business Branches with following children: + [BIZ_BRANCH] + example: |+ + + + + + + + properties: + BIZ_BRANCH : + type: object + description: |+ + Business Branches with following children: + ADDR_BUILDING + ADDR_POSTCODE + ADDR_ADDRESS1 + example: |+ + + + + + + properties: + ADDR_BUILDING: + type: string + description: Building Name + example: + ADDR_POSTCODE: + type: string + description: Postcode + example: 289848 + ADDR_ADDRESS1: + type: string + description: Address + example: 251A ARCADIA ROAD + LIST_REG_CHARGES: + type: array + description: |+ + List of Registered Charges with following children: + [REG_CHARGES] + example: |+ + + + + + + + + + + + items: + properties: + REG_CHARGES : + type: object + description: |+ + Registered Charges details with following children: + CHARGE_NO + CHARGE_DATE + CHARGEE_COMP + CURRENCY + AMT_SECURED + STATUS_SATISFACTION + example: |+ + + + + + + + + + properties: + CHARGE_NO : + type: string + description: Charge No. + example: 8205117 + CHARGE_DATE: + type: string + description: Charge Date + example: 26/11/1982 + CHARGEE_COMP: + type: string + description: Charges Company + example: UNITED OVERSEAS BANK LIMITED + CURRENCY: + type: string + description: Currency + example: + AMT_SECURED: + type: string + description: Amount Secured + example: 0.00 + STATUS_SATISFACTION: + type: string + description: Status of Satisfaction + example: + LIST_LIQUIDATOR: + type: array + description: |+ + List of Liquidator / Receiver / Judicial Manager with following children: + [LIQUIDATOR] + example: |+ + + + ABUTHAHIR ABDUL GAFOOR S1676216D + Liquidator + EL TICI FINANCIAL ADVISORY SERVICES PTE. LTD. 1 RAFFLES PLACE #20-01 + OUB CENTRE SINGAPORE 048616 30/03/2009 + + + items: + properties: + LIQUIDATOR : + type: object + description: |+ + Liquidator details with following children: + LIQ_POSITION + LIQ_ID + LIQ_NAME + LIQ_COMP + LIQ_ADDRESS1 + LIQ_ADDRESS2 + LIQ_ADDRESS3 + LIQ_ADDRESS4 + LIQ_APPOINTMENT_DATE + example: |+ + + ABUTHAHIR ABDUL GAFOOR + S1676216D + Liquidator + EL TICI FINANCIAL ADVISORY SERVICES PTE. LTD. + 1 RAFFLES PLACE + #20-01 + OUB CENTRE + SINGAPORE 048616 + 30/03/2009 + + properties: + LIQ_POSITION: + type: string + description: Liquidator / Receiver / Judicial Manager Position + example: Liquidator + LIQ_ID: + type: string + description: Liquidator / Receiver / Judicial Manager ID + example: S1676216D + LIQ_NAME : + type: string + description: Liquidator / Receiver / Judicial Manager Name + example: ABUTHAHIR ABDUL GAFOOR + LIQ_COMP: + type: string + description: Liquidator / Receiver / Judicial Manager Company Name + example: EL TICI FINANCIAL ADVISORY SERVICES PTE. LTD. + LIQ_ADDRESS1: + type: string + description: Liquidator / Receiver / Judicial Manager Address 1 + example: 1 RAFFLES PLACE + LIQ_ADDRESS2: + type: string + description: Liquidator / Receiver / Judicial Manager Address 2 + example: #20-01 + LIQ_ADDRESS3: + type: string + description: Liquidator / Receiver / Judicial Manager Address 3 + example: OUB CENTRE + LIQ_ADDRESS4: + type: string + description: Liquidator / Receiver / Judicial Manager Address 4 + example: SINGAPORE 048616 + LIQ_APPOINTMENT_DATE: + type: string + description: Liquidator / Receiver / Judicial Manager Appointment Date + example: 30/03/2009 + LIST_SHARE_INTEREST_COMP : + type: array + description: |+ + List of Share Interest In Companies with following children: + [SHARE_INTEREST_COMP] + example: |+ + + + + + + + + + items: + properties: + SHARE_INTEREST_COMP : + type: object + description: |+ + Share Interest In Companies details with following children: + COMP_NAME + SHARE_OWNED_UNIT + SHARE_OWNED_PERCENT + STATUS + example: |+ + + + + + + + properties: + COMP_NAME : + type: string + description: Company Name + example: ORCHID (HOLDINGS) PTE. LTD. + SHARE_OWNED_UNIT : + type: string + description: Shares Owned Unit + example: 500000 + SHARE_OWNED_PERCENT : + type: string + description: Shares Owned Value (%) + example: 100.00 + STATUS : + type: string + description: Status + example: DISSOLVED - MEMBERS' VOLUNTARY WINDING UP + LIST_NAME_CHANGE : + type: array + description: |+ + List of Change of Company/Business Name(s) with following children: + [NAME_CHANGE] + example: |+ + + + + + + + items: + properties: + NAME_CHANGE : + type: object + description: |+ + Change of Company/Business Name(s) with following children: + PREV_NAME + EFFECT_DATE + example: |+ + + + + + properties: + PREV_NAME : + type: string + description: Previous Name + example: HUA XI EATING HOUSE + EFFECT_DATE : + type: string + description: Effective Date + example: 25/10/1997 00:00:00 + LIST_SHAREHOLDER : + type: array + description: |+ + List of Shareholders with following children: + [SHAREHOLDER] + example: |+ + + +
+ + + + + + + + + + items: + properties: + SHAREHOLDER : + type: object + description: |+ + Shareholders details with following children: + ADDRESS + COMP_ID + NO_OF_SHARE + CURRENCY + SHAREHOLDER_TYPE + SHARE_TYPE + SHAREHOLDER_NAME + CHANGE_ADDR_DATE + ADDR_TYPE + NATIONALITY + example: |+ + +
+ + + + + + + + + + + properties: + ADDRESS : + type: string + description: Address + example: 1 HARBOURFRONT AVENUE , 18 – 01; KEPPEL BAY TOWER; 098632, SINGAPORE + COMP_ID : + type: string + description: Company/ Identity No. + example: 198200406H + NO_OF_SHARE : + type: string + description: No. of Shares + example: 657 + CURRENCY : + type: string + description: Currency + example: UNITED STATES OF AMERICA, DOLLARS + SHAREHOLDER_TYPE : + type: string + description: Indicator for Shareholder type + example: 2 + SHARE_TYPE : + type: string + description: Share Type + example: Preference + SHAREHOLDER_NAME : + type: string + description: Shareholder Name + example: KEPPEL COMMUNICATIONS PTE LTD + CHANGE_ADDR_DATE : + type: string + description: Change Address Date + example: 09/05/2003 + ADDR_TYPE : + type: string + description: Address Type, indicates if it is Singapore or foreign address. + example: + NATIONALITY : + type: string + description: Nationality + example: SINGAPORE + LIST_CAPITAL : + type: array + description: |+ + List of Capital details with following children: + [CAPITAL] + example: |+ + + + + + + + + + + items: + properties: + CAPITAL : + type: object + description: |+ + Capital details with following children: + CAPITAL_CATEGORY + CAPITAL_TYPE + CURRENCY + CAPITAL_AMT + NO_OF_SHARES + example: |+ + + + + + + + + properties: + CAPITAL_CATEGORY : + type: string + description: Capital Category + example: Issued + CAPITAL_TYPE : + type: string + description: Capital Type + example: Ordinary + CURRENCY : + type: string + description: Currency + example: SINGAPORE, DOLLARS + CAPITAL_AMT : + type: string + description: Capital Amount + example: 100,000.00 + NO_OF_SHARES : + type: string + description: Nos. of Shares + example: 100,000 + LIST_OFFICER_OWNER : + type: array + description: |+ + List of Officer(s) / Owner(s) with following children: + [OFFICER_OWNER] + example: |+ + + +
+ + + + + + + + items: + properties: + OFFICER_OWNER : + type: object + description: |+ + Officer(s) / Owner(s) details with following children: + ADDRESS + IDENTITY_ID + PA_REG_NO + POSITION + ADDR_TYPE + CESSATION_DATE + OFFICER_NAME + CHANGE_ADDR_DATE + APPMT_DATE + NATIONALITY + example: |+ + +
+ + + + + + + + + + properties: + ADDRESS : + type: string + description: Address + example: 50A TOH TUCK ROAD, 04 - 08 ; SIGNATURE PARK; 596742, SINGAPORE + IDENTITY_ID : + type: string + description: Identity No. + example: S1674174D + PA_REG_NO : + type: string + description: Public Accountant Registration No. + example: 00091 + POSITION : + type: string + description: Position + example: DIRECTOR + ADDR_TYPE : + type: string + description: Address Type, indicates if it is Singapore or foreign address. + example: S + CESSATION_DATE : + type: string + description: Cessation Date + example: 30/10/2003 + OFFICER_NAME : + type: string + description: Officer Name + example: HENRY GOH + CHANGE_ADDR_DATE : + type: string + description: Change Address Date + example: 30/10/2003 + APPMT_DATE : + type: string + description: Appointment Date + example: 30/10/2003 + NATIONALITY : + type: string + description: Nationality + example: SINGAPORE P.R. + LIST_SALES_REVENUE_AMOUNT : + type: array + description: |+ + List of Sales Revenue Amount with following children: + [SALES_REVENUE_AMOUNT] + example: |+ + + + 30000.00 + + + items: + properties: + SALES_REVENUE_AMOUNT : + type: object + description: |+ + Sales Revenue Amount details with following children: + ELEMENTS + YEAR + CURRENCY + AMOUNT + example: |+ + + + + + 30000.00 + + properties: + ELEMENTS : + type: string + description: Description + example: Sales Revenue Amount + YEAR : + type: integer + description: Year + example: 2008 + CURRENCY : + type: string + description: Currency + example: SGD + AMOUNT : + type: integer + description: Amount + example: 30000.00 + LIST_Ddrptcount : + type: array + description: |+ + List of Search By Financial Sectors and Search By Non- Financial Sectors with following children: + [Ddrptcount] + example: + items: + properties: + Ddrptcount : + type: object + description: |+ + 6 XML tags (open then close) displays + Search By Financial Sectors (counts for 3 recent years) + Search By Non- Financial Sectors (counts for 3 recent years) + Following children are: + Rcyear + RcFlag (only respond for the year exists) + Rcjan + Rcfeb + Rcmar + Rcapr + Rcmay + Rcjun + Rcjul + Rcaug + Rcsep + Rcoct + Rcnov + Rcdec + Rcid (only respond for the year exists) Rcreg (only respond for the year exists) Rcrptyid (only respond for the year exists) + Rcsecflag + LastUpdateDate (only respond for the year exists) + example: + properties: + Rcyear : + type: string + description: To show the year + example: 2017 + RcFlag : + type: string + description: Internal database value + example: N/A + Rcjan : + type: integer + description: Count for January + example: 1 + Rcfeb : + type: integer + description: Count for February + example: 1 + Rcmar : + type: integer + description: Count for March + example: 1 + Rcapr : + type: integer + description: Count for April + example: 1 + Rcmay : + type: integer + description: Count for May + example: 1 + Rcjun : + type: integer + description: Count for June + example: 1 + Rcjul : + type: integer + description: Count for July + example: 1 + Rcaug : + type: integer + description: Count for August + example: 1 + Rcsep : + type: integer + description: Count for September + example: 1 + Rcoct : + type: integer + description: Count for October + example: 1 + Rcnov : + type: integer + description: Count for November + example: 1 + Rcdec : + type: integer + description: Count for December + example: 1 + Rcid : + type: integer + description: Internal database value + example: + Rcreg : + type: string + description: Company Registration Number + example: + Rcrptyid : + type: string + description: Product Type + example: + Rcsecflag : + type: integer + description: Differentiate Search By Financial Sectors and Search By Non- Financial Sectors + example: 1 + LastUpdateDate : + type: string + description: Last update date + example: + unauthorized: + type: object + properties: + message: + type: string + example: Missing Authentication Token + status: + type: string + example: Failure + forbidden: + type: object + properties: + message: + type: string + example: Access Denied Unauthorized User + status: + type: string + example: Failure + paymentrequired: + type: object + properties: + message: + type: string + example: Insufficient Credits Kindly Top Up + status: + type: string + example: Failure + notfound: + type: object + properties: + message: + type: string + example: Invalid Request URL + status: + type: string + example: Failure + servererror: + type: object + properties: + message: + type: string + example: Internal Server Error + status: + type: string + example: Failure + gatewaytimeout: + type: object + properties: + message: + type: string + example: Request Timeout + status: + type: string + example: Failure + inputfieldmissing: + type: object + properties: + message: + type: string + example: Input Field Missing + status: + type: string + example: Failure + inputlimitexceeded: + type: object + properties: + message: + type: string + example: Input Limit Exceeded + status: + type: string + example: Failure + invalidinput: + type: object + properties: + message: + type: string + example: Invalid Input + status: + type: string + example: Failure + input: + type: object + properties: + total_items: + type: number + example: 1 + description: Number of subjects being enquired relating to the Run + default: false + subject_idno: + type: string + example: 199707714C + description: "Subject’s ID Number (individual) or Registration Number (company/business) as captured in DDP" + default: true + subject_name: + type: string + example: GPS INDUSTRIES PTE LTD + description: Subjects Name as captured in DDP + default: false + versions: + type: object + properties: + v1.0.0: + type: array + items: + oneOf: + - type: string + example: Published Date - Apr 09, 2021 + description: Optimized and Standardized results in Json Format + v0.1.0: + type: array + items: + oneOf: + - type: string + example: Published Date - Aug 15, 2019 + description: Initial version release + securitySchemes: + APIAuthorizer: + type: apiKey + name: x-api-key + in: header + x-amazon-apigateway-authtype: custom + description: Authentication is done using the x-api-key in the request header From 1a18845a87c25da78dcaf17b10c5d02b8060ee5d Mon Sep 17 00:00:00 2001 From: rameshsentient <51635015+rameshsentient@users.noreply.github.com> Date: Wed, 17 Mar 2021 10:27:28 +0530 Subject: [PATCH 750/792] Create get_ip.yaml --- utility/get_ip.yaml | 194 ++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 194 insertions(+) create mode 100644 utility/get_ip.yaml diff --git a/utility/get_ip.yaml b/utility/get_ip.yaml new file mode 100644 index 000000000..e461e697d --- /dev/null +++ b/utility/get_ip.yaml @@ -0,0 +1,194 @@ +openapi: 3.0.1 +info: + title: Get IP + description: |+ + Locate and identify website visitors by "IP" address Know where your customers access your website from and + customize user experiences based on IP + x-additionalinfo: |+ + Suggested Use Cases: + - Use this microservice to get public IP of user. + version: '0.0.1' + x-subscribelink: get_ip +servers: + - url: 'https://dev-apis.sentient.io' +tags: +- name: "v0.0.1" + description: "Published Date - Mar 30, 2021" +paths: + /microservices/utility/getip/v0/getdata: + GET: + tags: + - v0.0.1 + responses: + '200': + description: Ok + content: + application/json: + schema: + $ref: '#/components/schemas/success' + example: + message: Successfully Processed + results: 123.123.123.123 + status: Success + '401': + description: Unauthorized + content: + application/json: + schema: + $ref: '#/components/schemas/unauthorized' + '402': + description: Payment Required + content: + application/json: + schema: + $ref: '#/components/schemas/paymentrequired' + '403': + description: Forbidden + content: + application/json: + schema: + $ref: '#/components/schemas/forbidden' + '404': + description: Not Found + content: + application/json: + schema: + $ref: '#/components/schemas/notfound' + '419': + description: Input Field Missing + content: + application/json: + schema: + $ref: '#/components/schemas/inputfieldmissing' + '415': + description: Unsupported Media Type + content: + application/json: + schema: + $ref: '#/components/schemas/invalidinput' + '500': + description: Internal Server Error + content: + application/json: + schema: + $ref: '#/components/schemas/servererror' + '504': + description: Gateway Timeout + content: + application/json: + schema: + $ref: '#/components/schemas/gatewaytimeout' + security: + - APIAuthorizer: [] + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/input' + required: true +components: + schemas: + success: + type: object + properties: + message: + type: string + example: Successfully Processed + description: Response message + results: + type: string + example: 123.123.123.123 + description: User IP + status: + type: string + example: Success + description: API success call. + unauthorized: + type: object + properties: + message: + type: string + example: Missing Authentication Token + status: + type: string + example: Failure + forbidden: + type: object + properties: + message: + type: string + example: Access Denied Unauthorized User + status: + type: string + example: Failure + paymentrequired: + type: object + properties: + message: + type: string + example: Insufficient Credits Kindly Top Up + status: + type: string + example: Failure + invalidinput: + type: object + properties: + message: + type: string + example: Invalid Input + status: + type: string + example: Failure + notfound: + type: object + properties: + message: + type: string + example: Invalid Request URL + status: + type: string + example: Failure + servererror: + type: object + properties: + message: + type: string + example: Internal Server Error + status: + type: string + example: Failure + gatewaytimeout: + type: object + properties: + message: + type: string + example: Request Timeout + status: + type: string + example: Failure + inputfieldmissing: + type: object + properties: + message: + type: string + example: Input Field Missing + status: + type: string + example: Failure + versions: + type: object + properties: + v0.0.1: + type: array + items: + oneOf: + - type: string + example: Published Date - Mar 30, 2021 + description: Initial version release + securitySchemes: + APIAuthorizer: + type: apiKey + name: x-api-key + in: header + x-amazon-apigateway-authtype: custom + description: Authentication is done using the x-api-key in the request header From 81cb41fe11ffa6297cdd11bade9a61a1c4d58c3b Mon Sep 17 00:00:00 2001 From: rameshsentient <51635015+rameshsentient@users.noreply.github.com> Date: Wed, 17 Mar 2021 10:29:44 +0530 Subject: [PATCH 751/792] Update index.yaml --- index.yaml | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/index.yaml b/index.yaml index 33aa71a9e..2d3088bab 100644 --- a/index.yaml +++ b/index.yaml @@ -212,6 +212,10 @@ utility: title: Base64 Decoder versions: 0.1.0: 'base64-decoder.yaml' + get_ip: + title: Get IP + versions: + 0.1.0: 'get_ip.yaml' data: commercial_directories_hdb_sg: title: HDB Commercial Directories (SG) From b9f7a9423f1cade19fd1f38a54a15dd8e9207738 Mon Sep 17 00:00:00 2001 From: rameshsentient <51635015+rameshsentient@users.noreply.github.com> Date: Wed, 17 Mar 2021 10:32:40 +0530 Subject: [PATCH 752/792] Update index.yaml --- index.yaml | 6 +----- 1 file changed, 1 insertion(+), 5 deletions(-) diff --git a/index.yaml b/index.yaml index 2d3088bab..9fdee6929 100644 --- a/index.yaml +++ b/index.yaml @@ -211,11 +211,7 @@ utility: base64_decoder: title: Base64 Decoder versions: - 0.1.0: 'base64-decoder.yaml' - get_ip: - title: Get IP - versions: - 0.1.0: 'get_ip.yaml' + 0.1.0: 'base64-decoder.yaml' data: commercial_directories_hdb_sg: title: HDB Commercial Directories (SG) From 744277b87360dacfb48e10d72bb85171b2a63057 Mon Sep 17 00:00:00 2001 From: rameshsentient <51635015+rameshsentient@users.noreply.github.com> Date: Wed, 17 Mar 2021 10:44:29 +0530 Subject: [PATCH 753/792] Update get_ip.yaml --- utility/get_ip.yaml | 90 +++++++++++++++++++++++++-------------------- 1 file changed, 50 insertions(+), 40 deletions(-) diff --git a/utility/get_ip.yaml b/utility/get_ip.yaml index e461e697d..520d7ddc2 100644 --- a/utility/get_ip.yaml +++ b/utility/get_ip.yaml @@ -1,24 +1,25 @@ openapi: 3.0.1 info: title: Get IP + x-subscribelink: get_ip description: |+ - Locate and identify website visitors by "IP" address Know where your customers access your website from and - customize user experiences based on IP - x-additionalinfo: |+ + Locate and identify website visitors by "IP" address Know where your customers access your website from and + customize user experiences based on IP + + x-additionalinfo : |+ Suggested Use Cases: - - Use this microservice to get public IP of user. - version: '0.0.1' - x-subscribelink: get_ip + - Use this microservice to get public IP of user. + version: '0.1.0' servers: - url: 'https://dev-apis.sentient.io' tags: -- name: "v0.0.1" +- name: "v0.1.0" description: "Published Date - Mar 30, 2021" paths: /microservices/utility/getip/v0/getdata: - GET: + get: tags: - - v0.0.1 + - v0.1.0 responses: '200': description: Ok @@ -29,7 +30,7 @@ paths: example: message: Successfully Processed results: 123.123.123.123 - status: Success + status: Success '401': description: Unauthorized content: @@ -60,6 +61,12 @@ paths: application/json: schema: $ref: '#/components/schemas/inputfieldmissing' + '413': + description: Payload Too Large + content: + application/json: + schema: + $ref: '#/components/schemas/inputlimitexceeded' '415': description: Unsupported Media Type content: @@ -80,29 +87,23 @@ paths: $ref: '#/components/schemas/gatewaytimeout' security: - APIAuthorizer: [] - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/input' - required: true components: schemas: success: type: object properties: - message: - type: string - example: Successfully Processed - description: Response message - results: - type: string - example: 123.123.123.123 - description: User IP - status: - type: string - example: Success - description: API success call. + message: + type: string + example: Successfully Processed + description: Response message + results: + type: string + example: 123.123.123.123 + description: User IP + status: + type: string + example: Success + description: API success call. unauthorized: type: object properties: @@ -130,15 +131,6 @@ components: status: type: string example: Failure - invalidinput: - type: object - properties: - message: - type: string - example: Invalid Input - status: - type: string - example: Failure notfound: type: object properties: @@ -175,20 +167,38 @@ components: status: type: string example: Failure + inputlimitexceeded: + type: object + properties: + message: + type: string + example: Input Limit Exceeded + status: + type: string + example: Failure + invalidinput: + type: object + properties: + message: + type: string + example: Invalid Input + status: + type: string + example: Failure versions: type: object properties: - v0.0.1: + v0.1.0: type: array items: oneOf: - type: string example: Published Date - Mar 30, 2021 - description: Initial version release + description: Initial version release securitySchemes: APIAuthorizer: type: apiKey name: x-api-key in: header x-amazon-apigateway-authtype: custom - description: Authentication is done using the x-api-key in the request header + description: Authentication is done using the x-api-key in the request header. From d55bf8453d9d4effa3bb3893e4215a98772681e0 Mon Sep 17 00:00:00 2001 From: rameshsentient <51635015+rameshsentient@users.noreply.github.com> Date: Wed, 17 Mar 2021 10:45:22 +0530 Subject: [PATCH 754/792] Update index.yaml --- index.yaml | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/index.yaml b/index.yaml index 9fdee6929..025678122 100644 --- a/index.yaml +++ b/index.yaml @@ -212,6 +212,10 @@ utility: title: Base64 Decoder versions: 0.1.0: 'base64-decoder.yaml' + get_ip: + title: Get IP + versions: + 0.1.0: 'get_ip.yaml' data: commercial_directories_hdb_sg: title: HDB Commercial Directories (SG) From 6d20de0b8119a4d2bb5f2679b276a933cbdb3993 Mon Sep 17 00:00:00 2001 From: rameshsentient <51635015+rameshsentient@users.noreply.github.com> Date: Wed, 17 Mar 2021 10:53:08 +0530 Subject: [PATCH 755/792] Update get_ip.yaml --- utility/get_ip.yaml | 45 --------------------------------------------- 1 file changed, 45 deletions(-) diff --git a/utility/get_ip.yaml b/utility/get_ip.yaml index 520d7ddc2..b793c37fd 100644 --- a/utility/get_ip.yaml +++ b/utility/get_ip.yaml @@ -55,24 +55,6 @@ paths: application/json: schema: $ref: '#/components/schemas/notfound' - '419': - description: Input Field Missing - content: - application/json: - schema: - $ref: '#/components/schemas/inputfieldmissing' - '413': - description: Payload Too Large - content: - application/json: - schema: - $ref: '#/components/schemas/inputlimitexceeded' - '415': - description: Unsupported Media Type - content: - application/json: - schema: - $ref: '#/components/schemas/invalidinput' '500': description: Internal Server Error content: @@ -158,33 +140,6 @@ components: status: type: string example: Failure - inputfieldmissing: - type: object - properties: - message: - type: string - example: Input Field Missing - status: - type: string - example: Failure - inputlimitexceeded: - type: object - properties: - message: - type: string - example: Input Limit Exceeded - status: - type: string - example: Failure - invalidinput: - type: object - properties: - message: - type: string - example: Invalid Input - status: - type: string - example: Failure versions: type: object properties: From 36ee814e94e6bf231a1719feae4bcf5fffed3b68 Mon Sep 17 00:00:00 2001 From: Mohamed Luqman <57977684+mohamedSent@users.noreply.github.com> Date: Wed, 17 Mar 2021 11:16:25 +0530 Subject: [PATCH 756/792] Update d&b_business_check_sg_v1.0.yaml --- data/d&b_business_check_sg_v1.0.yaml | 767 +++++++++++++++++++-------- 1 file changed, 548 insertions(+), 219 deletions(-) diff --git a/data/d&b_business_check_sg_v1.0.yaml b/data/d&b_business_check_sg_v1.0.yaml index 41f3f6aee..2cd20fc1c 100644 --- a/data/d&b_business_check_sg_v1.0.yaml +++ b/data/d&b_business_check_sg_v1.0.yaml @@ -35,11 +35,120 @@ paths: application/json: schema: $ref: '#/components/schemas/success' - example: |+ - string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string 0
string
- string string string string string string string string string string string string string
string
- - string string string string string string string string string string string string string string string + example: + success: + report: + meta_info: + service: string + system_id: string + creation_date: string + user_id: string + class: string + req_search_info: + comp_name: string + reg_no: string + req_date: string + req_reg_no: string + req_name: string + req_date_str: string + registry_detail: + comp_name: string + renewal_date: string + address1: string + address2: string + address3: string + address4: string + comp_type_code: string + reg_date: string + reg_activity1: string + reg_activity2: string + acc_date: string + status_effect_date: string + name_effect_date: string + expiry_date: string + comp_type: string + change_addr_date: string + comp_status: string + reg_activity_desc1: string + reg_activity_desc2: string + auditor: string + auditor_appmt_date: string + last_ar_date: string + last_agm_date: string + country_incorp: string + employee_size: + elements: string + amount: string + list_biz_branch: + biz_branch: + addr_building: string + addr_postcode: string + addr_address1: string + list_reg_charges: + reg_charges: + charge_no: string + charge_date: string + chargee_comp: string + currency: string + amt_secured: string + status_satisfaction: string + list_liquidator: + liquidator: + liq_name: string + liq_id: string + liq_position: string + liq_comp: string + liq_address1: string + liq_address2: string + liq_address3: string + liq_address4: string + liq_appointment_date: string + list_sales_revenue_amount: + sales_revenue_amount: + elements: string + year: string + currency: string + amount: '0' + list_shareholder: + shareholder: + address: string + comp_id: string + no_of_share: string + currency: string + shareholder_type: string + share_type: string + shareholder_name: string + change_addr_date: string + addr_type: string + nationality: string + list_share_interest_comp: + share_interest_comp: + comp_name: string + share_owned_unit: string + share_owned_percent: string + status: string + list_officer_owner: + officer_owner: + address: string + identity_id: string + position: string + addr_type: string + cessation_date: string + officer_name: string + change_addr_date: string + appmt_date: string + nationality: string + list_capital: + capital: + capital_category: string + capital_type: string + currency: string + capital_amt: string + no_of_shares: string + list_name_change: + name_change: + prev_name: string + effect_date: string '401': description: Unauthorized content: @@ -122,14 +231,23 @@ components: properties: META_INFO: type: object - example: |+ - - - - - - - + example: + META_INFO: + SERVICE: + "@type": String + "#text": BC + SYSTEM_ID: + "@type": String + "#text": DDP + CREATION_DATE: + "@type": Date + "#text": Wed Apr 08 11:37:51 MYT 2009 + USER_ID: + "@type": String + "#text": plcust102 + CLASS: + "@type": String + "#text": class com.technodex.ddp.xmlbean.MetaBean description: |+ Meta Information details with following children: SERVICE @@ -160,33 +278,78 @@ components: example: "N/A" REGISTRY_DETAIL : type: object - example: |+ - - - - - - - - - - - - - - - - - - - - - - - - - + example: + REGISTRY_DETAIL: + "@className": com.technodex.ddp.report.bean.CommercialBizRegistryBean + RENEWAL_DATE: + "@type": String + "#text": 23/12/2008 + ADDRESS1: + "@type": String + "#text": 1 HARBOURFRONT AVENUE , 18 - 01 + ADDRESS2: + "@type": String + "#text": KEPPEL BAY TOWER + ADDRESS3: + "@type": String + "#text": '098632' + ADDRESS4: + "@type": String + "#text": SINGAPORE + COMP_TYPE_CODE: + "@type": String + "#text": CP + REG_DATE: + "@type": String + "#text": 14/10/1974 + REG_ACTIVITY1: + "@type": String + "#text": OTHER INVESTMENT HOLDING COMPANIES + REG_ACTIVITY2: + "@type": String + "#text": SHIP MANAGEMENT SERVICES + ACC_DATE: + "@type": String + "#text": 31/12/2007 + STATUS_EFFECT_DATE: + "@type": String + "#text ": 14/10/1974 + NAME_EFFECT_DATE: + "@type": String + "#text": 14/10/1974 + EXPIRY_DATE: + "@type": String + "#text": 25/10/2009 + COMP_TYPE: + "@type": String + "#text": LIMITED PRIVATE COMPANY + CHANGE_ADDR_DATE: + "@type": String + "#text": '09 / 05 / 2003' + COMP_STATUS: + "@type": String + "#text": Live Company + REG_ACTIVITY_DESC1: + "@type": String + "#text": " - " + REG_ACTIVITY_DESC2: + "@type": String + "#text": " - " + AUDITOR: + "@type": String + "#text": " - " + AUDITOR_APPMT_DATE: + "@type": String + "#text": 13/06/1990 + LAST_AR_DATE: + "@type": String + "#text": 30/06/2008 + LAST_AGM_DATE: + "@type": String + "#text": 11/06/2008 + COUNTRY_INCORP: + "@type": String + "#text": SINGAPORE description: |+ Registry Details with following children: RENEWAL_DATE @@ -310,15 +473,27 @@ components: example: "SINGAPORE" REQ_SEARCH_INFO : type: object - example: |+ - - - - - - - - + example: + REQ_SEARCH_INFO: + "@className": com.technodex.ddp.report.bean.LitigationSearchInfoBean + COMP_NAME: + "@type": String + "#text": KAPAL MANAGEMENT (PRIVATE) LIMITED + REG_NO: + "@type": String + "#text": 197401835M + REQ_DATE: + "@type": Date + "#text": '2009-04-08 11:36:03.611' + REQ_REG_NO: + "@type": String + "#text": 197401835M + REQ_NAME: + "@type": String + "#text": KAPAL MANAGEMENT (PRIVATE) LIMITED + REQ_DATE_STR: + "@type": String + "#text": '08/04/2009 11:36:03' description: |+ Request criteria & search record with following children: COMP_NAME @@ -358,11 +533,10 @@ components: Employee Size details with following children: ELEMENTS AMOUNT - example: |+ - - - 300 - + example: + EMPLOYEE_SIZE: + ELEMENTS: Employee Size + AMOUNT: '300' properties: ELEMENTS: type: string @@ -377,13 +551,19 @@ components: description: |+ List of Business Branches with following children: [BIZ_BRANCH] - example: |+ - - - - - - + example: + LIST_BIZ_BRANCH: + "@className": com.technodex.ddp.report.bean.CommercialBizBranchBean + BIZ_BRANCH: + ADDR_BUILDING: + "@type": String + "#text": "-" + ADDR_POSTCODE: + "@type": String + "#text": '289848' + ADDR_ADDRESS1: + "@type": String + "#text": 251A ARCADIA ROAD , - - - properties: BIZ_BRANCH : type: object @@ -392,12 +572,17 @@ components: ADDR_BUILDING ADDR_POSTCODE ADDR_ADDRESS1 - example: |+ - - - - - + example: + BIZ_BRANCH: + ADDR_BUILDING: + "@type": String + "#text": "-" + ADDR_POSTCODE: + "@type": String + "#text": '289848' + ADDR_ADDRESS1: + "@type": String + "#text": 251A ARCADIA ROAD , - - - properties: ADDR_BUILDING: type: string @@ -416,17 +601,28 @@ components: description: |+ List of Registered Charges with following children: [REG_CHARGES] - example: |+ - - - - - - - - - - + example: + LIST_REG_CHARGES: + "@className": com.technodex.ddp.report.bean.CommercialBizChgRegBean + REG_CHARGES: + CHARGE_NO: + "@type": String + "#text": '8205117' + CHARGE_DATE: + "@type": String + "#text": 26/11/1982 + CHARGEE_COMP: + "@type": String + "#text": UNITED OVERSEAS BANK LIMITED + CURRENCY: + "@type": String + "#text": "-" + AMT_SECURED: + "@type": String + "#text": '0.00' + STATUS_SATISFACTION: + "@type": String + "#text": "-" items: properties: REG_CHARGES : @@ -439,15 +635,26 @@ components: CURRENCY AMT_SECURED STATUS_SATISFACTION - example: |+ - - - - - - - - + example: + REG_CHARGES: + CHARGE_NO: + "@type": String + "#text": '8205117' + CHARGE_DATE: + "@type": String + "#text": 26/11/1982 + CHARGEE_COMP: + "@type": String + "#text": UNITED OVERSEAS BANK LIMITED + CURRENCY: + "@type": String + "#text": "-" + AMT_SECURED: + "@type": String + "#text": '0.00' + STATUS_SATISFACTION: + "@type": String + "#text": "-" properties: CHARGE_NO : type: string @@ -478,15 +685,18 @@ components: description: |+ List of Liquidator / Receiver / Judicial Manager with following children: [LIQUIDATOR] - example: |+ - - - ABUTHAHIR ABDUL GAFOOR S1676216D - Liquidator - EL TICI FINANCIAL ADVISORY SERVICES PTE. LTD. 1 RAFFLES PLACE #20-01 - OUB CENTRE SINGAPORE 048616 30/03/2009 - - + example: + LIST_LIQUIDATOR: + LIQUIDATOR: + LIQ_NAME: ABUTHAHIR ABDUL GAFOOR + LIQ_ID: S1676216D + LIQ_POSITION: Liquidator + LIQ_COMP: EL TICI FINANCIAL ADVISORY SERVICES PTE. LTD. + LIQ_ADDRESS1: 1 RAFFLES PLACE + LIQ_ADDRESS2: "#20-01" + LIQ_ADDRESS3: OUB CENTRE + LIQ_ADDRESS4: SINGAPORE 048616 + LIQ_APPOINTMENT_DATE: 30/03/2009 items: properties: LIQUIDATOR : @@ -502,18 +712,17 @@ components: LIQ_ADDRESS3 LIQ_ADDRESS4 LIQ_APPOINTMENT_DATE - example: |+ - - ABUTHAHIR ABDUL GAFOOR - S1676216D - Liquidator - EL TICI FINANCIAL ADVISORY SERVICES PTE. LTD. - 1 RAFFLES PLACE - #20-01 - OUB CENTRE - SINGAPORE 048616 - 30/03/2009 - + example: + LIQUIDATOR: + LIQ_NAME: ABUTHAHIR ABDUL GAFOOR + LIQ_ID: S1676216D + LIQ_POSITION: Liquidator + LIQ_COMP: EL TICI FINANCIAL ADVISORY SERVICES PTE. LTD. + LIQ_ADDRESS1: 1 RAFFLES PLACE + LIQ_ADDRESS2: "#20-01" + LIQ_ADDRESS3: OUB CENTRE + LIQ_ADDRESS4: SINGAPORE 048616 + LIQ_APPOINTMENT_DATE: 30/03/2009 properties: LIQ_POSITION: type: string @@ -556,15 +765,22 @@ components: description: |+ List of Share Interest In Companies with following children: [SHARE_INTEREST_COMP] - example: |+ - - - - - - - - + example: + LIST_SHARE_INTEREST_COMP: + "@className": com.technodex.ddp.report.bean.CommercialShareInterestBean + SHARE_INTEREST_COMP: + COMP_NAME: + "@type": String + "#text": ORCHID (HOLDINGS) PTE. LTD. + SHARE_OWNED_UNIT: + "@type": String + "#text": '500000' + SHARE_OWNED_PERCENT: + "@type": String + "#text": '100.00' + STATUS: + "@type": String + "#text": DISSOLVED - MEMBERS' VOLUNTARY WINDING UP items: properties: SHARE_INTEREST_COMP : @@ -575,13 +791,20 @@ components: SHARE_OWNED_UNIT SHARE_OWNED_PERCENT STATUS - example: |+ - - - - - - + example: + SHARE_INTEREST_COMP: + COMP_NAME: + "@type": String + "#text": ORCHID (HOLDINGS) PTE. LTD. + SHARE_OWNED_UNIT: + "@type": String + "#text": '500000' + SHARE_OWNED_PERCENT: + "@type": String + "#text": '100.00' + STATUS: + "@type": String + "#text": DISSOLVED - MEMBERS' VOLUNTARY WINDING UP properties: COMP_NAME : type: string @@ -604,13 +827,16 @@ components: description: |+ List of Change of Company/Business Name(s) with following children: [NAME_CHANGE] - example: |+ - - - - - - + example: + LIST_NAME_CHANGE: + "@className": com.technodex.ddp.report.bean.CommercialBizChgCmpBean + NAME_CHANGE: + PREV_NAME: + "@type": String + "#text": HUA XI EATING HOUSE + EFFECT_DATE: + "@type": String + "#text": 25/10/1997 00:00:00 items: properties: NAME_CHANGE : @@ -619,11 +845,14 @@ components: Change of Company/Business Name(s) with following children: PREV_NAME EFFECT_DATE - example: |+ - - - - + example: + NAME_CHANGE: + PREV_NAME: + "@type": String + "#text": HUA XI EATING HOUSE + EFFECT_DATE: + "@type": String + "#text": 25/10/1997 00:00:00 properties: PREV_NAME : type: string @@ -638,21 +867,44 @@ components: description: |+ List of Shareholders with following children: [SHAREHOLDER] - example: |+ - - -
- - - - - - - - - + example: + LIST_SHAREHOLDER: + "@className": com.technodex.ddp.report.bean.CommercialShareHoldersBean + SHAREHOLDER: + ADDRESS: + "@type": String + "#text": |- + 1 HARBOURFRONT AVENUE , 18 – 01; KEPPEL BAY TOWER; 098632, + SINGAPORE + COMP_ID: + "@type": String + "#text": 198200406H + NO_OF_SHARE: + "@type": String + "#text": '657' + CURRENCY: + "@type": String + "#text": UNITED STATES OF AMERICA, DOLLARS + SHAREHOLDER_TYPE: + "@type": String + "#text": '2' + SHARE_TYPE: + "@type": String + "#text": Preference + SHAREHOLDER_NAME: + "@type": String + "#text": |- + KEPPEL COMMUNICATIONS PTE + LTD + CHANGE_ADDR_DATE: + "@type": String + "#text": '09/05/2003' + ADDR_TYPE: + "@type": String + "#text": "-" + NATIONALITY: + "@type": String + "#text": SINGAPORE items: properties: SHAREHOLDER : @@ -669,19 +921,38 @@ components: CHANGE_ADDR_DATE ADDR_TYPE NATIONALITY - example: |+ - -
- - - - - - - - - - + example: + SHAREHOLDER: + ADDRESS: + "@type": String + "#text": 1 HARBOURFRONT AVENUE , 18 – 01; KEPPEL BAY TOWER; 098632, SINGAPORE + COMP_ID: + "@type": String + "#text": 198200406H + NO_OF_SHARE: + "@type": String + "#text": '657' + CURRENCY: + "@type": String + "#text": UNITED STATES OF AMERICA, DOLLARS + SHAREHOLDER_TYPE: + "@type": String + "#text": '2' + SHARE_TYPE: + "@type": String + "#text": Preference + SHAREHOLDER_NAME: + "@type": String + "#text": KEPPEL COMMUNICATIONS PTE LTD + CHANGE_ADDR_DATE: + "@type": String + "#text": '09/05/2003' + ADDR_TYPE: + "@type": String + "#text": "-" + NATIONALITY: + "@type": String + "#text": SINGAPORE properties: ADDRESS : type: string @@ -728,16 +999,25 @@ components: description: |+ List of Capital details with following children: [CAPITAL] - example: |+ - - - - - - - - - + example: + LIST_CAPITAL: + "@className": com.technodex.ddp.report.bean.CommercialBizCapitalBean + CAPITAL: + CAPITAL_CATEGORY: + "@type": String + "#text": Issued + CAPITAL_TYPE: + "@type": String + "#text": Ordinary + CURRENCY: + "@type": String + "#text": SINGAPORE, DOLLARS + CAPITAL_AMT: + "@type": String + "#text": '100,000.00' + NO_OF_SHARES: + "@type": String + "#text": '100,000' items: properties: CAPITAL : @@ -749,14 +1029,23 @@ components: CURRENCY CAPITAL_AMT NO_OF_SHARES - example: |+ - - - - - - - + example: + CAPITAL: + CAPITAL_CATEGORY: + "@type": String + "#text": Issued + CAPITAL_TYPE: + "@type": String + "#text": Ordinary + CURRENCY: + "@type": String + "#text": SINGAPORE, DOLLARS + CAPITAL_AMT: + "@type": String + "#text": '100,000.00' + NO_OF_SHARES: + "@type": String + "#text": '100,000' properties: CAPITAL_CATEGORY : type: string @@ -783,18 +1072,39 @@ components: description: |+ List of Officer(s) / Owner(s) with following children: [OFFICER_OWNER] - example: |+ - - -
- - - - - - - + example: + LIST_OFFICER_OWNER: + "@className": com.technodex.ddp.report.bean.CommercialBizOfficeOwerBean + OFFICER_OWNER: + ADDRESS: + "@type": String + "#text": |- + 50A TOH TUCK ROAD, 04 - 08 ; SIGNATURE PARK; 596742, + SINGAPORE + IDENTITY_ID: + "@type": String + "#text": S1674174D + POSITION: + "@type": String + "#text": DIRECTOR + ADDR_TYPE: + "@type": String + "#text": S + CESSATION_DATE: + "@type": String + "#text": "-" + OFFICER_NAME: + "@type": String + "#text": NGIAM SHARE CHING + CHANGE_ADDR_DATE: + "@type": String + "#text": 25/10/2008 + APPMT_DATE: + "@type": String + "#text": 30/09/2008 + NATIONALITY: + "@type": String + "#text": SINGAPORE CITIZEN items: properties: OFFICER_OWNER : @@ -811,18 +1121,37 @@ components: CHANGE_ADDR_DATE APPMT_DATE NATIONALITY - example: |+ - -
- - - - - - - - - + example: + OFFICER_OWNER: + ADDRESS: + "@type": String + "#text": |- + 50A TOH TUCK ROAD, 04 - 08 ; SIGNATURE PARK; 596742, + SINGAPORE + IDENTITY_ID: + "@type": String + "#text": S1674174D + POSITION: + "@type": String + "#text": DIRECTOR + ADDR_TYPE: + "@type": String + "#text": S + CESSATION_DATE: + "@type": String + "#text": "-" + OFFICER_NAME: + "@type": String + "#text": NGIAM SHARE CHING + CHANGE_ADDR_DATE: + "@type": String + "#text": 25/10/2008 + APPMT_DATE: + "@type": String + "#text": 30/09/2008 + NATIONALITY: + "@type": String + "#text": SINGAPORE CITIZEN properties: ADDRESS : type: string @@ -869,12 +1198,13 @@ components: description: |+ List of Sales Revenue Amount with following children: [SALES_REVENUE_AMOUNT] - example: |+ - - - 30000.00 - - + example: + LIST_SALES_REVENUE_AMOUNT: + SALES_REVENUE_AMOUNT: + ELEMENTS: Sales Revenue Amount + YEAR: '2008' + CURRENCY: SGD + AMOUNT: '30000.00' items: properties: SALES_REVENUE_AMOUNT : @@ -885,13 +1215,12 @@ components: YEAR CURRENCY AMOUNT - example: |+ - - - - - 30000.00 - + example: + SALES_REVENUE_AMOUNT: + ELEMENTS: Sales Revenue Amount + YEAR: '2008' + CURRENCY: SGD + AMOUNT: '30000.00' properties: ELEMENTS : type: string From b5479c0a2e92ee71197a2333be41241ee32f162f Mon Sep 17 00:00:00 2001 From: Mohamed Luqman <57977684+mohamedSent@users.noreply.github.com> Date: Wed, 17 Mar 2021 11:18:32 +0530 Subject: [PATCH 757/792] Update index.yaml --- index.yaml | 1 + 1 file changed, 1 insertion(+) diff --git a/index.yaml b/index.yaml index 025678122..62a770b4f 100644 --- a/index.yaml +++ b/index.yaml @@ -281,6 +281,7 @@ data: d&b_business_check_sg: title: D&B Business Check (SG) versions: + 1.0.0: 'd&b_business_check_sg_v1.0.yaml' 0.1.0: 'd&b_business_check_sg.yaml' d&b_brief_financial_information_sg: title: D&B Brief Financial Information (SG) From f1dce7148010b895905e89fd061f51313e8b5f9d Mon Sep 17 00:00:00 2001 From: Mohamed Luqman <57977684+mohamedSent@users.noreply.github.com> Date: Wed, 17 Mar 2021 11:44:22 +0530 Subject: [PATCH 758/792] Update d&b_business_check_plus_sg.yaml --- data/d&b_business_check_plus_sg.yaml | 9 ++++----- 1 file changed, 4 insertions(+), 5 deletions(-) diff --git a/data/d&b_business_check_plus_sg.yaml b/data/d&b_business_check_plus_sg.yaml index d94713cd9..ccdf9f248 100644 --- a/data/d&b_business_check_plus_sg.yaml +++ b/data/d&b_business_check_plus_sg.yaml @@ -5,20 +5,19 @@ info: x-additionalinfo: |+ Suggested Use Cases: - Software solutions targeted at corporate finance and legal domains, e.g. in cases of mergers, joint ventures or partnerships. - - - Aside from being able to protect your business via litigation checks to safeguard against reputational risk by avoiding companies potentially involved in financial crimes, the information from this microservice can serve as a quick solution for analysts or lawyers in a company whom are looking to draft documents related to cooperate finance or legal domains with one quick search. + - Aside from being able to protect your business via litigation checks to safeguard against reputational risk by avoiding companies potentially involved in financial crimes, the information from this microservice can serve as a quick solution for analysts or lawyers in a company whom are looking to draft documents related to cooperate finance or legal domains with one quick search. version: '0.1.0' x-subscribelink: d&b_business_check_plus_sg servers: - - url: 'https://dev-apis.sentient.io' + - url: 'https://api.sentient.io' tags: - name: "v0.1.0" description: "Published Date - Aug 15, 2019" paths: - /microservices/data/sbcp/v0/getdata: + /dnb/prod/sbcp: post: tags: - - v0 + - v0.1.0 summary: Adds a new user requestBody: content: From e91b94ee701e041c1763982094ee55b1862b0cde Mon Sep 17 00:00:00 2001 From: Mohamed Luqman <57977684+mohamedSent@users.noreply.github.com> Date: Wed, 17 Mar 2021 11:49:56 +0530 Subject: [PATCH 759/792] initial commit of version1 --- data/d&b_business_check_plus_sg_v1.0.yaml | 1704 +++++++++++++++++++++ 1 file changed, 1704 insertions(+) create mode 100644 data/d&b_business_check_plus_sg_v1.0.yaml diff --git a/data/d&b_business_check_plus_sg_v1.0.yaml b/data/d&b_business_check_plus_sg_v1.0.yaml new file mode 100644 index 000000000..fe9523f43 --- /dev/null +++ b/data/d&b_business_check_plus_sg_v1.0.yaml @@ -0,0 +1,1704 @@ +openapi: 3.0.1 +info: + title: D&B Business Check Plus (SG) + description: The Data microservice provides key business information, litigation information (High and Subordinate Courts) and Winding Up Trace of a company including the Business name, registration number, registered address and date of change, company status, registered activities, shareholders details (i.e. date of commencement, residing address) capital amount and shares allocated to each shareholder, litigation information. Updated daily. + x-additionalinfo: |+ + Suggested Use Cases: + - Software solutions targeted at corporate finance and legal domains, e.g. in cases of mergers, joint ventures or partnerships. + - Aside from being able to protect your business via litigation checks to safeguard against reputational risk by avoiding companies potentially involved in financial crimes, the information from this microservice can serve as a quick solution for analysts or lawyers in a company whom are looking to draft documents related to cooperate finance or legal domains with one quick search. + version: '1.0.0' + x-subscribelink: d&b_business_check_plus_sg +servers: + - url: 'https://dev-apis.sentient.io' +tags: +- name: "v1.0.0" + description: "Published Date - Apr 09, 2021" +paths: + /microservices/data/sbcp/v0/getdata: + post: + tags: + - v1.0.0 + summary: Adds a new user + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/input' + responses: + '200': + description: Ok + content: + application/json: + schema: + $ref: '#/components/schemas/success' + example: |+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + 300 + + + + + + + + + + + + + + + + + + + + + + + ABUTHAHIR ABDUL GAFOOR S1676216D + Liquidator + EL TICI FINANCIAL ADVISORY SERVICES PTE. LTD. 1 RAFFLES PLACE #20-01 + OUB CENTRE SINGAPORE 048616 30/03/2009 + + ANGELA ANG + S1633336D + Liquidator + KING FINANCIAL ADVISORY SERVICES LEVEL 17 MLC CENTRE 19029 MARTIN PLACE SYDNEY NSW 2000 AUSTRALIA 18/02/2009 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + +
+ + + + + + +
+ + + + + + + + + 30000.00 + + 28000.00 + + 27,000.00 + + + '401': + description: Unauthorized + content: + application/json: + schema: + $ref: '#/components/schemas/unauthorized' + '402': + description: Payment Required + content: + application/json: + schema: + $ref: '#/components/schemas/paymentrequired' + '403': + description: Forbidden + content: + application/json: + schema: + $ref: '#/components/schemas/forbidden' + '404': + description: Not Found + content: + application/json: + schema: + $ref: '#/components/schemas/notfound' + '419': + description: Input Field Missing + content: + application/json: + schema: + $ref: '#/components/schemas/inputfieldmissing' + '413': + description: Payload Too Large + content: + application/json: + schema: + $ref: '#/components/schemas/inputlimitexceeded' + '415': + description: Unsupported Media Type + content: + application/json: + schema: + $ref: '#/components/schemas/invalidinput' + '500': + description: Internal Server Error + content: + application/json: + schema: + $ref: '#/components/schemas/servererror' + '504': + description: Gateway Timeout + content: + application/json: + schema: + $ref: '#/components/schemas/gatewaytimeout' + security: + - APIAuthorizer: [] +components: + schemas: + success: + type: object + properties: + REPORT: + type: object + example: + description: |+ + Report details with following children: + [META_INFO] + [REGISTRY_DETAIL] + [REQ_SEARCH_INFO] + [EMPLOYEE_SIZE] + [LIST_BIZ_BRANCH] + [LIST_REG_CHARGES] + [LIST_LIQUIDATOR] + [LIST_WINDING_UP] + [LIST_LITIGATION] + [LIST_SHARE_INTEREST_COMP] + [LIST_NAME_CHANGE] + [LIST_SHAREHOLDER] + [LIST_CAPITAL] + [LIST_OFFICER_OWNER] + [LIST_SALES_REVENUE_AMOUNT] + properties: + META_INFO: + type: object + example: |+ + + + + + + + description: |+ + Meta Information details with following children: + SERVICE + SYSTEM_ID + CREATION_DATE + USER_ID + CLASS + properties: + SERVICE: + type: string + description: Report requested + example: "BCP" + SYSTEM_ID : + type: string + description: System ID + example: "DDP" + CREATION_DATE: + type: datetime + description: Report request date + example: Wed Apr 08 11:37:51 MYT 2009 + USER_ID : + type: string + description: Valid user id in DDP system. It is for (For internal use) + example: N/A + CLASS: + type: string + description: Class location for metabean. It is for (For internal use) + example: N/A + REGISTRY_DETAIL : + type: object + example: |+ + + + + + + + + + + + + + + + + + + + + + + description: |+ + Registry Details with following children: + RENEWAL_DATE + ADDRESS1 + ADDRESS2 + ADDRESS3 + ADDRESS4 + COMP_TYPE_CODE + REG_DATE + REG_ACTIVITY1 + REG_ACTIVITY2 + ACC_DATE + STATUS_EFFECT_DATE + NAME_EFFECT_DATE + EXPIRY_DATE + COMP_TYPE + CHANGE_ADDR_DATE + COMP_STATUS + REG_ACTIVITY_DESC1 + REG_ACTIVITY_DESC2 + AUDITOR + AUDITOR_APPMT_DATE + LAST_AR_DATE + LAST_AGM_DATE + COUNTRY_INCORP + properties: + RENEWAL_DATE: + type: string + description: Renewal Date + example: "23/12/2008" + ADDRESS1: + type: string + description: Address Line 1 + example: "1 HARBOURFRONT AVENUE , 18 - 01" + ADDRESS2: + type: string + description: Address Line 2 + example: "KEPPEL BAY TOWER" + ADDRESS3: + type: string + description: Address Line 3 + example: "098632" + ADDRESS4: + type: string + description: Address Line 4 + example: "SINGAPORE" + COMP_TYPE_CODE: + type: string + example: CP + description: |+ + Report Code. Available values are: + 1. CP Corporate + 2. SP Sole Proprietor + REG_DATE: + type: string + description: Registration Date + example: "14/10/1974" + REG_ACTIVITY1: + type: string + description: Registered Activities 1 + example: "OTHER INVESTMENT HOLDING COMPANIES" + REG_ACTIVITY2: + type: string + description: Registered Activities 2 + example: "SHIP MANAGEMENT SERVICES" + ACC_DATE: + type: string + description: Account Date + example: "31/12/2007" + STATUS_EFFECT_DATE: + type: string + description: Status Effective Date + example: "14/10/1974" + NAME_EFFECT_DATE: + type: string + description: Name Effective Date + example: "14/10/1974" + EXPIRY_DATE: + type: string + description: Expiry Date + example: "25/10/2009" + COMP_TYPE: + type: string + description: Company Type + example: "LIMITED PRIVATE COMPANY" + CHANGE_ADDR_DATE: + type: string + description: Change Address Date + example: "09/05/2003" + COMP_STATUS: + type: string + description: Company Status + example: "Live Company" + REG_ACTIVITY_DESC1: + type: string + description: Registered Activities Description + example: + REG_ACTIVITY_DESC2: + type: string + description: Registered Activities Description + example: + AUDITOR: + type: string + description: Auditor Name + example: + AUDITOR_APPMT_DATE: + type: string + description: Auditor Appointment Date + example: "13/06/1990" + LAST_AR_DATE: + type: string + description: Date of Last AR + example: "30/06/2008" + LAST_AGM_DATE: + type: string + description: Date of Last AGM + example: "11/06/2008" + COUNTRY_INCORP: + type: string + description: Country Incorporated + example: "SINGAPORE" + REQ_SEARCH_INFO : + type: object + example: |+ + + + + + + + description: |+ + Request criteria & search record with following children: + COMP_NAME + REG_NO + REQ_DATE + REQ_REG_NO + REQ_NAME + REQ_DATE_STR + properties: + COMP_NAME: + type: string + description: Company Name + example: "KAPAL MANAGEMENT (PRIVATE) LIMITED" + REG_NO: + type: string + description: Subject’s ID Number (individual) or Registration Number (company/business) + example: "197401835M" + REQ_DATE: + type: datetime + description: Report Requested Date + example: 2009-04-08 11:36:03.611 + REQ_REG_NO: + type: string + description: Request Registration Number + example: "197401835M" + REQ_NAME: + type: string + description: Request Name + example: "KAPAL MANAGEMENT (PRIVATE) LIMITED" + REQ_DATE_STR: + type: string + description: Request Date String + example: "08/04/2009 11:36:03" + EMPLOYEE_SIZE : + type: object + description: |+ + Employee Size details with following children: + ELEMENTS + AMOUNT + example: |+ + + + 300 + + properties: + ELEMENTS: + type: string + description: Description + example: "Employee Size" + AMOUNT: + type: integer + description: Number of employee + example: 300 + LIST_BIZ_BRANCH : + type: array + description: |+ + List of Business Branches with following children: + [BIZ_BRANCH] + example: |+ + + + + + + + items: + properties: + BIZ_BRANCH : + type: object + description: |+ + Business Branches with following children: + ADDR_BUILDING + ADDR_POSTCODE + ADDR_ADDRESS1 + example: |+ + + + + + + properties: + ADDR_BUILDING: + type: string + description: Building Name + example: + ADDR_POSTCODE: + type: string + description: Postcode + example: 289848 + ADDR_ADDRESS1: + type: string + description: Address + example: 251A ARCADIA ROAD + LIST_REG_CHARGES: + type: array + description: |+ + List of Registered Charges with following children: + [REG_CHARGES] + example: |+ + + + + + + + + + + items: + properties: + REG_CHARGES : + type: object + description: |+ + Registered Charges details with following children: + CHARGE_NO + CHARGE_DATE + CHARGEE_COMP + CURRENCY + AMT_SECURED + STATUS_SATISFACTION + example: |+ + + + + + + + + + properties: + CHARGE_NO : + type: string + description: Charge No. + example: 8205117 + CHARGE_DATE: + type: string + description: Charge Date + example: 26/11/1982 + CHARGEE_COMP: + type: string + description: Charges Company + example: UNITED OVERSEAS BANK LIMITED + CURRENCY: + type: string + description: Currency + example: + AMT_SECURED: + type: string + description: Amount Secured + example: 1000.00 + STATUS_SATISFACTION: + type: string + description: Status of Satisfaction + example: + LIST_LIQUIDATOR: + type: array + description: |+ + List of Liquidator / Receiver / Judicial Manager with following children: + [LIQUIDATOR] + example: |+ + + + ABUTHAHIR ABDUL GAFOOR S1676216D + Liquidator + EL TICI FINANCIAL ADVISORY SERVICES PTE. LTD. 1 RAFFLES PLACE #20-01 + OUB CENTRE SINGAPORE 048616 30/03/2009 + + + items: + properties: + LIQUIDATOR : + type: object + description: |+ + Liquidator details with following children: + LIQ_POSITION + LIQ_ID + LIQ_NAME + LIQ_COMP + LIQ_ADDRESS1 + LIQ_ADDRESS2 + LIQ_ADDRESS3 + LIQ_ADDRESS4 + LIQ_APPOINTMENT_DATE + example: |+ + + ABUTHAHIR ABDUL GAFOOR + S1676216D + Liquidator + EL TICI FINANCIAL ADVISORY SERVICES PTE. LTD. + 1 RAFFLES PLACE + #20-01 + OUB CENTRE + SINGAPORE 048616 + 30/03/2009 + + properties: + LIQ_POSITION: + type: string + description: Liquidator / Receiver / Judicial Manager Position + example: Liquidator + LIQ_ID: + type: string + description: Liquidator / Receiver / Judicial Manager ID + example: S1676216D + LIQ_NAME : + type: string + description: Liquidator / Receiver / Judicial Manager Name + example: ABUTHAHIR ABDUL GAFOOR + LIQ_COMP: + type: string + description: Liquidator / Receiver / Judicial Manager Company Name + example: EL TICI FINANCIAL ADVISORY SERVICES PTE. LTD. + LIQ_ADDRESS1: + type: string + description: Liquidator / Receiver / Judicial Manager Address 1 + example: 1 RAFFLES PLACE + LIQ_ADDRESS2: + type: string + description: Liquidator / Receiver / Judicial Manager Address 2 + example: #20-01 + LIQ_ADDRESS3: + type: string + description: Liquidator / Receiver / Judicial Manager Address 3 + example: OUB CENTRE + LIQ_ADDRESS4: + type: string + description: Liquidator / Receiver / Judicial Manager Address 4 + example: SINGAPORE 048616 + LIQ_APPOINTMENT_DATE: + type: string + description: Liquidator / Receiver / Judicial Manager Appointment Date + example: 30/03/2009 + LIST_WINDING_UP : + type: array + description: |+ + List of Winding Up with following children: + [WINDING_UP] + example: |+ + + + + + + + + + + + + + + + + + + + + + items: + properties: + WINDING_UP : + type: object + description: |+ + Winding Up details with following children: + CASE_CODE + CASE_YEAR + PLAINTIFF + PLA_SOLICITOR_ID + PLA_FILE_REF + PLA_LAW_FIRM + SUBJECT_NAME + COURT_CODE + CASE_TYPE + CURRENCY1 + AMOUNT1 + CURRENCY2 + AMOUNT2 + CURRENCY3 + AMOUNT3 + ACTION_DATE + BANKRUPTCY_ACT + HEARING_DATE + PLA_SOLICITOR + example: |+ + + + + + + + + + + + + + + + + + + + + properties: + CASE_CODE : + type: string + description: Case Code + example: 40000 + CASE_YEAR : + type: string + description: Case Year + example: 1999 + PLAINTIFF : + type: string + description: Plaintiff Name + example: + PLA_SOLICITOR_ID : + type: string + description: Pla. Solicitor ID + example: + PLA_FILE_REF : + type: string + description: Pla. File Ref. + example: + PLA_LAW_FIRM : + type: string + description: Pla. Law Firm + example: NAME2 + SUBJECT_NAME : + type: string + description: Subject Name + example: PROACTIVE BUILDERS + COURT_CODE : + type: string + description: Court Code + example: CWU + CASE_TYPE : + type: string + description: Case Type + example: COMPANY WINDING UP PETITION + CURRENCY1 : + type: string + description: Currency 1 + example: SGD + AMOUNT1 : + type: string + description: Amount 1 + example: 41,424.52 + CURRENCY2 : + type: string + description: Currency 2 + example: MYR + AMOUNT2 : + type: string + description: Amount 2 + example: 0.00 + CURRENCY3 : + type: string + description: Currency 3 + example: + AMOUNT3 : + type: string + description: Amount 3 + example: 0.00 + ACTION_DATE : + type: string + description: Action Date + example: 11/05/2007 + BANKRUPTCY_ACT : + type: string + description: Act of Bankruptcy + example: Petition for Winding Up + HEARING_DATE : + type: string + description: Hearing Date + example: 15/12/2007 + PLA_SOLICITOR : + type: string + description: Pla. Solicitor + example: + LIST_LITIGATION : + type: array + description: |+ + List of Winding Up with following children: + [LITIGATION] + example: |+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + items: + properties: + LITIGATION : + type: object + description: |+ + List of Winding Up with following children: + SUBJECT_NAME + NATURE_OF_CLAIM + STATUS_DATE + CASE_NO + DOC_REMARK + CURRENCY1 + CURRENCY2 + CURRENCY3 + CURRENCY4 + CURRENCY5 + DEF_SOLICITOR + DEF_SOLICITOR_ID + DEF_LAW_FIRM + DEF_FILE_REF + DATE_OF_WRIT + STATUS + AMOUNT1 + AMOUNT2 + AMOUNT3 + AMOUNT4 + AMOUNT5 + PLAINTIFF + PLA_SOLICITOR + PLA_SOLICITOR_ID + PLA_LAW_FIRM + PLA_FILE_REF + PLA_ID + PLA_STATUS + PLA_STATUS_DATE + example: |+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + properties: + SUBJECT_NAME : + type: string + description: Subject Name + example: "SOON SOON SEAFOOD" + NATURE_OF_CLAIM : + type: string + example: "CONTRACT 3" + description: Nature of Claim + STATUS_DATE : + type: string + example: "01/05/2008" + description: Status Date + CASE_NO : + type: string + example: "MC 40001 / 1999" + description: Case No + DOC_REMARKS : + type: string + example: "NOTICE OF DISCONTINUANCE/WITHDRAWAL 3" + description: Document Remark + CURRENCY1 : + type: string + example: "SGD" + description: Currency 1 + CURRENCY2 : + type: string + example: "MYR" + description: Currency 2 + CURRENCY3 : + type: string + example: "USD" + description: Currency 3 + CURRENCY4 : + type: string + example: "-" + description: Currency 4 + CURRENCY5 : + type: string + example: "-" + description: Currency 5 + DEF_SOLICITOR : + type: string + example: "SOL2" + description: Def. Solicitor + DEF_SOLICITOR_ID : + type: string + example: "20000000" + description: Def. Solicitor ID + DEF_LAW_FIRM : + type: string + example: "NAME2" + description: Def. Law Firm + DEF_FILE_REF : + type: string + example: "FILE2" + description: Def. File Ref. + DATE_OF_WRIT : + type: string + example: "01/01/2008" + description: Date Writ + STATUS : + type: string + example: "CONCLUDED 3" + description: Status + AMOUNT1 : + type: string + example: "100.00" + description: Amount 1 + AMOUNT2 : + type: string + example: "200.00" + description: Amount 2 + AMOUNT3 : + type: string + example: "0.00" + description: Amount 3 + AMOUNT4 : + type: string + example: "400.00" + description: Amount 4 + AMOUNT5 : + type: string + example: "0.00" + description: Amount 5 + PLAINTIFF : + type: string + example: "MC 40001" + description: Plaintiff Name + PLA_SOLICITOR: + type: string + example: "SOL2" + description: plantiff Solicitor + PLA_SOLICITOR_ID: + type: string + example: "20000000" + description: plantiff Solicitor ID + PLA_LAW_FIRM : + type: string + example: "NAME2" + description: Pla. Law Firm + PLA_FILE_REF : + type: string + example: "FILE2" + description: Pla. File Ref. + PLA_ID: + type: string + example: "S0739038F" + description: Plaintiff ID + PLA_STATUS: + type: string + example: "SETTLED - BEFORE SET DOWN" + description: Plaintiff Status + PLA_STATUS_DATE : + type: string + example: "17/10/2016" + description: Plaintiff Status Date + LIST_SHARE_INTEREST_COMP : + type: array + description: |+ + List of Share Interest In Companies with following children: + [SHARE_INTEREST_COMP] + example: |+ + + + + + + + + + items: + properties: + SHARE_INTEREST_COMP : + type: object + description: |+ + Share Interest In Companies details with following children: + COMP_NAME + SHARE_OWNED_UNIT + SHARE_OWNED_PERCENT + STATUS + example: |+ + + + + + + + properties: + COMP_NAME : + type: string + description: Company Name + example: ORCHID (HOLDINGS) PTE. LTD. + SHARE_OWNED_UNIT : + type: string + description: Shares Owned Unit + example: 500000 + SHARE_OWNED_PERCENT : + type: string + description: Shares Owned Value (%) + example: 100.00 + STATUS : + type: string + description: Status + example: DISSOLVED - MEMBERS' VOLUNTARY WINDING UP + LIST_NAME_CHANGE : + type: array + description: |+ + List of Change of Company/Business Name(s) with following children: + [NAME_CHANGE] + example: |+ + + + + + + + items: + properties: + NAME_CHANGE : + type: object + description: |+ + Change of Company/Business Name(s) with following children: + PREV_NAME + EFFECT_DATE + example: |+ + + + + + properties: + PREV_NAME : + type: string + description: Previous Name + example: HUA XI EATING HOUSE + EFFECT_DATE : + type: string + description: Effective Date + example: 25/10/1997 00:00:00 + LIST_SHAREHOLDER : + type: array + description: |+ + List of Shareholders with following children: + [SHAREHOLDER] + example: |+ + + +
+ + + + + + + + + + items: + properties: + SHAREHOLDER : + type: object + description: |+ + Shareholders details with following children: + ADDRESS + COMP_ID + NO_OF_SHARE + CURRENCY + SHAREHOLDER_TYPE + SHARE_TYPE + SHAREHOLDER_NAME + CHANGE_ADDR_DATE + ADDR_TYPE + NATIONALITY + example: |+ + +
+ + + + + + + + + + + properties: + ADDRESS : + type: string + description: Address + example: 1 HARBOURFRONT AVENUE , 18 – 01; KEPPEL BAY TOWER; 098632, SINGAPORE + COMP_ID : + type: string + description: Company/ Identity No. + example: 198200406H + NO_OF_SHARE : + type: string + description: No. of Shares + example: 657 + CURRENCY : + type: string + description: Currency + example: UNITED STATES OF AMERICA, DOLLARS + SHAREHOLDER_TYPE : + type: string + description: |+ + Indicator for Shareholder type. + Possible values are: + 1 Individual + 2 Company + 3 Unregistered foreign company + 4 Unregistered local company + example: 2 + SHARE_TYPE : + type: string + description: Share Type + example: Preference + SHAREHOLDER_NAME : + type: string + description: Shareholder Name + example: KEPPEL COMMUNICATIONS PTE LTD + CHANGE_ADDR_DATE : + type: string + description: Change Address Date + example: 09/05/2003 + ADDR_TYPE : + type: string + description: |+ + Address Type, indicates if it is Singapore or foreign address. + Possible values are: + S Indicates Singapore address + - Indicates foreign address + example: S + NATIONALITY : + type: string + description: Nationality + example: SINGAPORE + LIST_CAPITAL : + type: array + description: |+ + List of Capital details with following children: + [CAPITAL] + example: |+ + + + + + + + + + + items: + properties: + CAPITAL : + type: object + description: |+ + Capital details with following children: + CAPITAL_CATEGORY + CAPITAL_TYPE + CURRENCY + CAPITAL_AMT + NO_OF_SHARES + example: |+ + + + + + + + + properties: + CAPITAL_CATEGORY : + type: string + description: Capital Category + example: Issued + CAPITAL_TYPE : + type: string + description: Capital Type + example: Ordinary + CURRENCY : + type: string + description: Currency + example: SINGAPORE, DOLLARS + CAPITAL_AMT : + type: string + description: Capital Amount + example: 100,000.00 + NO_OF_SHARES : + type: string + description: Nos. of Shares + example: 100,000 + LIST_OFFICER_OWNER : + type: array + description: |+ + List of Officer(s) / Owner(s) with following children: + [OFFICER_OWNER] + example: |+ + + +
+ + + + + + + + items: + properties: + OFFICER_OWNER : + type: object + description: |+ + Officer(s) / Owner(s) details with following children: + ADDRESS + IDENTITY_ID + PA_REG_NO + POSITION + ADDR_TYPE + CESSATION_DATE + OFFICER_NAME + CHANGE_ADDR_DATE + APPMT_DATE + NATIONALITY + example: |+ + +
+ + + + + + + + + + properties: + ADDRESS : + type: string + description: Address + example: 50A TOH TUCK ROAD, 04 - 08 ; SIGNATURE PARK; 596742, SINGAPORE + IDENTITY_ID : + type: string + description: Identity No. + example: S1674174D + PA_REG_NO : + type: string + description: Public Accountant Registration No. + example: 00091 + POSITION : + type: string + description: Position + example: DIRECTOR + ADDR_TYPE : + type: string + description: |+ + Address Type, indicates if it is Singapore or foreign address. + Possible values are: + S Indicates Singapore address + - Indicates foreign address + example: S + CESSATION_DATE : + type: string + description: Cessation Date + example: 30/10/2003 + OFFICER_NAME : + type: string + description: Officer Name + example: HENRY GOH + CHANGE_ADDR_DATE : + type: string + description: Change Address Date + example: 30/10/2003 + APPMT_DATE : + type: string + description: Appointment Date + example: 30/10/2003 + NATIONALITY : + type: string + description: Nationality + example: SINGAPORE P.R. + LIST_SALES_REVENUE_AMOUNT : + type: array + description: |+ + List of Sales Revenue Amount with following children: + [SALES_REVENUE_AMOUNT] + example: |+ + + + 30000.00 + + + items: + properties: + SALES_REVENUE_AMOUNT : + type: object + description: |+ + Sales Revenue Amount details with following children: + ELEMENTS + YEAR + CURRENCY + AMOUNT + example: |+ + + + + + 30000.00 + + properties: + ELEMENTS : + type: string + description: Description + example: Sales Revenue Amount + YEAR : + type: string + description: Year + example: 2008 + CURRENCY : + type: string + description: Currency + example: SGD + AMOUNT : + type: string + description: Amount. Amount values that higher than 1000 have a comma to delimit every 3 digits of the amount value. + example: 30000.00 + LIST_Ddrptcount : + type: array + description: |+ + List of Search By Financial Sectors and Search By Non- Financial Sectors with following children: + [Ddrptcount] + example: + items: + properties: + Ddrptcount : + type: object + description: |+ + 6 XML tags (open then close) displays + Search By Financial Sectors (counts for 3 recent years) + Search By Non- Financial Sectors (counts for 3 recent years) + Following children are: + Rcyear + RcFlag (only respond for the year exists) + Rcjan + Rcfeb + Rcmar + Rcapr + Rcmay + Rcjun + Rcjul + Rcaug + Rcsep + Rcoct + Rcnov + Rcdec + Rcid (only respond for the year exists) Rcreg (only respond for the year exists) Rcrptyid (only respond for the year exists) + Rcsecflag + LastUpdateDate (only respond for the year exists) + example: + properties: + Rcyear : + type: string + description: To show the year + example: 2017 + RcFlag : + type: string + description: Internal database value + example: N/A + Rcjan : + type: integer + description: Count for January + example: 1 + Rcfeb : + type: integer + description: Count for February + example: 1 + Rcmar : + type: integer + description: Count for March + example: 1 + Rcapr : + type: integer + description: Count for April + example: 1 + Rcmay : + type: integer + description: Count for May + example: 1 + Rcjun : + type: integer + description: Count for June + example: 1 + Rcjul : + type: integer + description: Count for July + example: 1 + Rcaug : + type: integer + description: Count for August + example: 1 + Rcsep : + type: integer + description: Count for September + example: 1 + Rcoct : + type: integer + description: Count for October + example: 1 + Rcnov : + type: integer + description: Count for November + example: 1 + Rcdec : + type: integer + description: Count for December + example: 1 + Rcid : + type: string + description: |+ + Internal database value, respond value from table Primary Key ID + It is for (For internal use) + example: N/A + Rcreg : + type: string + description: Company Registration Number + example: + Rcrptyid : + type: string + description: |+ + Product Type. Possible values are: + 1. Biz Check: 0001 + 2. Biz Check Plus: 0002 + example: 0001 + Rcsecflag : + type: integer + description: Differentiate Search By Financial Sectors and Search By Non- Financial Sectors + example: 1 + LastUpdateDate : + type: datetime + description: Last update date + example: YYYY-MM-DD 00:00:00.0 + unauthorized: + type: object + properties: + message: + type: string + example: Missing Authentication Token + status: + type: string + example: Failure + forbidden: + type: object + properties: + message: + type: string + example: Access Denied Unauthorized User + status: + type: string + example: Failure + paymentrequired: + type: object + properties: + message: + type: string + example: Insufficient Credits Kindly Top Up + status: + type: string + example: Failure + notfound: + type: object + properties: + message: + type: string + example: Invalid Request URL + status: + type: string + example: Failure + servererror: + type: object + properties: + message: + type: string + example: Internal Server Error + status: + type: string + example: Failure + gatewaytimeout: + type: object + properties: + message: + type: string + example: Request Timeout + status: + type: string + example: Failure + inputfieldmissing: + type: object + properties: + message: + type: string + example: Input Field Missing + status: + type: string + example: Failure + inputlimitexceeded: + type: object + properties: + message: + type: string + example: Input Limit Exceeded + status: + type: string + example: Failure + invalidinput: + type: object + properties: + message: + type: string + example: Invalid Input + status: + type: string + example: Failure + input: + type: object + properties: + total_items: + type: number + example: 1 + description: Number of subjects being enquired relating to the Run + default: false + subject_idno: + type: string + example: 199707714C + description: "Subject’s ID Number (individual) or Registration Number (company/business) as captured in DDP" + default: true + subject_name: + type: string + example: GPS INDUSTRIES PTE LTD + description: Subjects Name as captured in DDP + default: false + versions: + type: object + properties: + v1.0.0: + type: array + items: + oneOf: + - type: string + example: Published Date - Apr 09, 2021 + description: Optimized and Standardized results in Json Format + v0.1.0: + type: array + items: + oneOf: + - type: string + example: Published Date - Aug 15, 2019 + description: Initial version release + securitySchemes: + APIAuthorizer: + type: apiKey + name: x-api-key + in: header + x-amazon-apigateway-authtype: custom + description: Authentication is done using the x-api-key in the request header From 28c7d184575cd83a13cb37fc3970ff3843dfd0f9 Mon Sep 17 00:00:00 2001 From: Mohamed Luqman <57977684+mohamedSent@users.noreply.github.com> Date: Wed, 17 Mar 2021 11:50:51 +0530 Subject: [PATCH 760/792] Update index.yaml --- index.yaml | 1 + 1 file changed, 1 insertion(+) diff --git a/index.yaml b/index.yaml index 62a770b4f..b338aebb4 100644 --- a/index.yaml +++ b/index.yaml @@ -272,6 +272,7 @@ data: d&b_business_check_plus_sg: title: D&B Business Check Plus (SG) versions: + 1.0.0: 'd&b_business_check_plus_sg_v1.0.yaml' 0.1.0: 'd&b_business_check_plus_sg.yaml' d&b_basic_individual_search_sg: title: D&B Basic Individual Search (SG) From 655809ed2c050c4fb6fad6941907012a009ae696 Mon Sep 17 00:00:00 2001 From: Mohamed Luqman <57977684+mohamedSent@users.noreply.github.com> Date: Wed, 17 Mar 2021 12:41:10 +0530 Subject: [PATCH 761/792] Update d&b_business_check_plus_sg_v1.0.yaml --- data/d&b_business_check_plus_sg_v1.0.yaml | 1776 +++++++++++++++------ 1 file changed, 1279 insertions(+), 497 deletions(-) diff --git a/data/d&b_business_check_plus_sg_v1.0.yaml b/data/d&b_business_check_plus_sg_v1.0.yaml index fe9523f43..f1126ecc7 100644 --- a/data/d&b_business_check_plus_sg_v1.0.yaml +++ b/data/d&b_business_check_plus_sg_v1.0.yaml @@ -31,199 +31,548 @@ paths: application/json: schema: $ref: '#/components/schemas/success' - example: |+ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - 300 - - - - - - - - - - - - - - - - - - - - - - - ABUTHAHIR ABDUL GAFOOR S1676216D - Liquidator - EL TICI FINANCIAL ADVISORY SERVICES PTE. LTD. 1 RAFFLES PLACE #20-01 - OUB CENTRE SINGAPORE 048616 30/03/2009 - - ANGELA ANG - S1633336D - Liquidator - KING FINANCIAL ADVISORY SERVICES LEVEL 17 MLC CENTRE 19029 MARTIN PLACE SYDNEY NSW 2000 AUSTRALIA 18/02/2009 - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - -
- - - - - - - - - - - - - - - - - - - - - -
- - - - - - -
- - - - - - - - - 30000.00 - - 28000.00 - - 27,000.00 - - + example: + REPORT: + META_INFO: + SERVICE: + "@type": String + "#text": BCP + SYSTEM_ID: + "@type": String + "#text": DDP + CREATION_DATE: + "@type": Date + "#text": Wed Apr 08 11:37:51 MYT 2009 + USER_ID: + "@type": String + CLASS: + "@type": String + "#text": class com.technodex.ddp.xmlbean.MetaBean + REGISTRY_DETAIL: + "@className": com.technodex.ddp.report.bean.CommercialBizRegistryBean + RENEWAL_DATE: + "@type": String + "#text": 23/12/2008 + ADDRESS1: + "@type": String + "#text": 1 HARBOURFRONT AVENUE , 18 - 01 + ADDRESS2: + "@type": String + "#text": KEPPEL BAY TOWER + ADDRESS3: + "@type": String + "#text": '098632' + ADDRESS4: + "@type": String + "#text": SINGAPORE + COMP_TYPE_CODE: + "@type": String + "#text": CP + REG_DATE: + "@type": String + "#text": 14/10/1974 + REG_ACTIVITY1: + "@type": String + "#text": OTHER INVESTMENT HOLDING COMPANIES + REG_ACTIVITY2: + "@type": String + "#text": SHIP MANAGEMENT SERVICES + ACC_DATE: + "@type": String + "#text": 31/12/2007 + STATUS_EFFECT_DATE: + "@type": String + "#text": 14/10/1974 + NAME_EFFECT_DATE: + "@type": String + "#text": 14/10/1974 + EXPIRY_DATE: + "@type": String + "#text": 25/10/2009 + COMP_TYPE: + "@type": String + "#text": LIMITED PRIVATE COMPANY + CHANGE_ADDR_DATE: + "@type": String + "#text": '09/05/2003' + COMP_STATUS: + "@type": String + "#text": Live Company + REG_ACTIVITY_DESC1: + "@type": String + "#text": "-" + REG_ACTIVITY_DESC2: + "@type": String + "#text": "-" + AUDITOR: + "@type": String + "#text": "-" + AUDITOR_APPMT_DATE: + "@type": String + "#text": 13/06/1990 + LAST_AR_DATE: + "@type": String + "#text": 30/06/2008 + LAST_AGM_DATE: + "@type": String + "#text": 11/06/2008 + COUNTRY_INCORP: + "@type": String + "#text": SINGAPORE + REQ_SEARCH_INFO: + "@className": com.technodex.ddp.report.bean.LitigationSearchInfoBean + COMP_NAME: + "@type": String + "#text": KAPAL MANAGEMENT (PRIVATE) LIMITED + REG_NO: + "@type": String + "#text": 197401835M + REQ_DATE: + "@type": Date + "#text": '2009-04-08 11:36:03.611' + REQ_REG_NO: + "@type": String + "#text": 197401835M + REQ_NAME: + "@type": String + "#text": KAPAL MANAGEMENT (PRIVATE) LIMITED + REQ_DATE_STR: + "@type": String + "#text": '08/04/2009 11:36:03' + EMPLOYEE_SIZE: + ELEMENTS: Employee Size + AMOUNT: '300' + LIST_BIZ_BRANCH: + "@className": com.technodex.ddp.report.bean.CommercialBizBranchBean + BIZ_BRANCH: + ADDR_BUILDING: + "@type": String + "#text": "-" + ADDR_POSTCODE: + "@type": String + "#text": '289848' + ADDR_ADDRESS1: + "@type": String + "#text": 251A ARCADIA ROAD , - - - + LIST_REG_CHARGES: + "@className": com.technodex.ddp.report.bean.CommercialBizChgRegBean + REG_CHARGES: + - CHARGE_NO: + "@type": String + "#text": '8205117' + CHARGE_DATE: + "@type": String + "#text": 26/11/1982 + CHARGEE_COMP: + "@type": String + "#text": UNITED OVERSEAS BANK LIMITED + CURRENCY: + "@type": String + "#text": "-" + AMT_SECURED: + "@type": String + "#text": '1000.00' + STATUS_SATISFACTION: + "@type": String + "#text": "-" + - CHARGE_NO: + "@type": String + "#text": '8000976' + CHARGE_DATE: + "@type": String + "#text": 21/04/1980 + CHARGEE_COMP: + "@type": String + "#text": THE DEVELOPMENT BANK OF SINGAPORE LIMITED + CURRENCY: + "@type": String + "#text": "-" + AMT_SECURED: + "@type": String + "#text": All Monies + STATUS_SATISFACTION: + "@type": String + "#text": "-" + LIST_LIQUIDATOR: + LIQUIDATOR: + - LIQ_NAME: ABUTHAHIR ABDUL GAFOOR + LIQ_ID: S1676216D + LIQ_POSITION: Liquidator + LIQ_COMP: EL TICI FINANCIAL ADVISORY SERVICES PTE. LTD. + LIQ_ADDRESS1: 1 RAFFLES PLACE + LIQ_ADDRESS2: "#20-01" + LIQ_ADDRESS3: OUB CENTRE + LIQ_ADDRESS4: SINGAPORE 048616 + LIQ_APPOINTMENT_DATE: 30/03/2009 + - LIQ_NAME: ANGELA ANG + LIQ_ID: S1633336D + LIQ_POSITION: Liquidator + LIQ_COMP: KING FINANCIAL ADVISORY SERVICES + LIQ_ADDRESS1: LEVEL 17 MLC CENTRE 19029 + LIQ_ADDRESS2: MARTIN PLACE SYDNEY NSW 2000 AUSTRALIA + LIQ_APPOINTMENT_DATE: 18/02/2009 + LIST_WINDING_UP: + "@className": com.technodex.ddp.report.bean.CommercialBizWindingupBean + WINDING_UP: + CASE_CODE: + "@type": String + "#text": '40000' + CASE_YEAR: + "@type": String + "#text": '1999' + PLAINTIFF: + "@type": String + "#text": "-" + PLA_SOLICITOR_ID: + "@type": String + "#text": "-" + PLA_FILE_REF: + "@type": String + "#text": "-" + COURT_CODE: + "@type": String + "#text": CWU + CASE_TYPE: + "@type": String + "#text": COMPANY WINDING UP PETITION + CURRENCY1: + "@type": String + "#text": SGD + AMOUNT1: + "@type": String + "#text": '41,424.52' + CURRENCY2: + "@type": String + "#text": MYR + AMOUNT2: + "@type": String + "#text": '0.00' + CURRENCY3: + "@type": String + "#text": "-" + AMOUNT3: + "@type": String + "#text": '0.00' + BANKRUPTCY_ACT: + "@type": String + "#text": Petition for Winding Up + HEARING_DATE: + "@type": String + "#text": 15/12/2007 + ACTION_DATE: + "@type": String + "#text": 11/05/2007 + SUBJECT_NAME: + "@type": String + "#text": PROACTIVE BUILDERS + PLA_SOLICITOR: + "@type": String + "#text": "-" + PLA_LAW_FIRM: + "@type": String + "#text": NAME2 + LIST_LITIGATION: + "@className": com.technodex.ddp.report.bean.CommercialBizLitigationBean + LITIGATION: + SUBJECT_NAME: + "@type": String + "#text": SOON SOON SEAFOOD + NATURE_OF_CLAIM: + "@type": String + "#text": CONTRACT 3 + STATUS_DATE: + "@type": String + "#text": 01/05/2008 + CASE_NO: + "@type": String + "#text": MC 40001 / 1999 + DOC_REMARKS: + "@type": String + "#text": NOTICE OF DISCONTINUANCE/WITHDRAWAL 3 + CURRENCY1: + "@type": String + "#text": SGD + CURRENCY2: + "@type": String + "#text": MYR + CURRENCY3: + "@type": String + "#text": USD + CURRENCY4: + "@type": String + "#text": "-" + CURRENCY5: + "@type": String + "#text": "-" + DEF_SOLICITOR: + "@type": String + "#text": SOL2 + DEF_SOLICITOR_ID: + "@type": String + "#text": '20000000' + DEF_LAW_FIRM: + "@type": String + "#text": NAME2 + DEF_FILE_REF: + "@type": String + "#text": FILE2 + DATE_OF_WRIT: + "@type": String + "#text": 01/01/2008 + STATUS: + "@type": String + "#text": CONCLUDED 3 + AMOUNT1: + "@type": String + "#text": '100.00' + AMOUNT2: + "@type": String + "#text": '200.00' + AMOUNT3: + "@type": String + "#text": '0.00' + AMOUNT4: + "@type": String + "#text": '400.00' + AMOUNT5: + "@type": String + "#text": '0.00' + PLAINTIFF: + "@type": String + "#text": MC 40001 + PLA_SOLICITOR: + "@type": String + "#text": SOL2 + PLA_SOLICITOR_ID: + "@type": String + "#text": '20000000' + PLA_LAW_FIRM: + "@type": String + "#text": NAME2 + PLA_FILE_REF: + "@type": String + "#text": FILE2 + PLA_ID: + "@type": String + "#text": S0739038F + PLA_STATUS: + "@type": String + "#text": SETTLED - BEFORE SET DOWN + PLA_STATUS_DATE: + "@type": String + "#text": 17/10/2016 + LIST_SHARE_INTEREST_COMP: + "@className": com.technodex.ddp.report.bean.CommercialShareInterestBean + SHARE_INTEREST_COMP: + - COMP_NAME: + "@type": String + "#text": ORCHID (HOLDINGS) PTE. LTD. + SHARE_OWNED_UNIT: + "@type": String + "#text": '500000' + SHARE_OWNED_PERCENT: + "@type": String + "#text": '100.00' + STATUS: + "@type": String + "#text": DISSOLVED - MEMBERS' VOLUNTARY WINDING UP + - COMP_NAME: + "@type": String + "#text": ORCHID (HOLDINGS) PTE. LTD. + SHARE_OWNED_UNIT: + "@type": String + "#text": '436' + SHARE_OWNED_PERCENT: + "@type": String + "#text": '100.00' + STATUS: + "@type": String + "#text": DISSOLVED - MEMBERS' VOLUNTARY WINDING UP + LIST_NAME_CHANGE: + "@className": com.technodex.ddp.report.bean.CommercialBizChgCmpBean + NAME_CHANGE: + - PREV_NAME: + "@type": String + "#text": HUA XI EATING HOUSE + EFFECT_DATE: + "@type": String + "#text": 25/10/1997 00:00:00 + - PREV_NAME: + "@type": String + "#text": SOON-SOON FISH-HEAD CURRY + EFFECT_DATE: + "@type": String + "#text": 10/06/1991 00:00:00 + LIST_SHAREHOLDER: + "@className": com.technodex.ddp.report.bean.CommercialShareHoldersBean + SHAREHOLDER: + - ADDRESS: + "@type": String + "#text": 1 HARBOURFRONT AVENUE , 18 - 01; KEPPEL BAY TOWER; 098632,SINGAPORE + COMP_ID: + "@type": String + "#text": 198200406H + NO_OF_SHARE: + "@type": String + "#text": '657' + CURRENCY: + "@type": String + "#text": UNITED STATES OF AMERICA, DOLLARS + SHAREHOLDER_TYPE: + "@type": String + "#text": '2' + SHARE_TYPE: + "@type": String + "#text": Preference + SHAREHOLDER_NAME: + "@type": String + "#text": KEPPEL COMMUNICATIONS PTE LTD + CHANGE_ADDR_DATE: + "@type": String + "#text": '09/05/2003' + ADDR_TYPE: + "@type": String + "#text": "-" + NATIONALITY: + "@type": String + "#text": SINGAPORE + - ADDRESS: + "@type": String + "#text": 1 HARBOURFRONT AVENUE , 18 - 01; KEPPEL BAY TOWER; 098632, SINGAPORE + COMP_ID: + "@type": String + "#text": 196500115G + NO_OF_SHARE: + "@type": String + "#text": '100,000' + CURRENCY: + "@type": String + "#text": SINGAPORE, DOLLARS + SHAREHOLDER_TYPE: + "@type": String + "#text": '2' + SHARE_TYPE: + "@type": String + "#text": Ordinary + SHAREHOLDER_NAME: + "@type": String + "#text": KEPPEL TELECOMMUNICATIONS & TRANSPORTATION LTD + CHANGE_ADDR_DATE: + "@type": String + "#text": '09/05/2003' + ADDR_TYPE: + "@type": String + "#text": "-" + NATIONALITY: + "@type": String + "#text": SINGAPORE + LIST_CAPITAL: + "@className": com.technodex.ddp.report.bean.CommercialBizCapitalBean + CAPITAL: + - CAPITAL_CATEGORY: + "@type": String + "#text": Issued + CAPITAL_TYPE: + "@type": String + "#text": Ordinary + CURRENCY: + "@type": String + "#text": SINGAPORE, DOLLARS + CAPITAL_AMT: + "@type": String + "#text": '100,000.00' + NO_OF_SHARES: + "@type": String + "#text": '100,000' + - CAPITAL_CATEGORY: + "@type": String + "#text": Issued + CAPITAL_TYPE: + "@type": String + "#text": Preference + CURRENCY: + "@type": String + "#text": UNITED STATES OF AMERICA, DOLLARS + CAPITAL_AMT: + "@type": String + "#text": '14,600,511.00' + NO_OF_SHARES: + "@type": String + "#text": '657' + LIST_OFFICER_OWNER: + "@className": com.technodex.ddp.report.bean.CommercialBizOfficeOwerBean + OFFICER_OWNER: + - ADDRESS: + "@type": String + "#text": 50A TOH TUCK ROAD, 04 - 08 ; SIGNATURE PARK; 596742,SINGAPORE + IDENTITY_ID: + "@type": String + "#text": S1674174D + POSITION: + "@type": String + "#text": DIRECTOR + ADDR_TYPE: + "@type": String + "#text": S + CESSATION_DATE: + "@type": String + "#text": "-" + OFFICER_NAME: + "@type": String + "#text": NGIAM SHARE CHING + CHANGE_ADDR_DATE: + "@type": String + "#text": 25/10/2008 + APPMT_DATE: + "@type": String + "#text": 30/09/2008 + NATIONALITY: + "@type": String + "#text": SINGAPORE CITIZEN + - ADDRESS: + "@type": String + "#text": 52 HUME AVENUE, 05 - 10 ; SUMMERHILL; 596230, SINGAPORE + IDENTITY_ID: + "@type": String + "#text": S2504825C + PA_REG_NO: + "@type": String + "#text": '00091' + POSITION: + "@type": String + "#text": DIRECTOR + ADDR_TYPE: + "@type": String + "#text": S + CESSATION_DATE: + "@type": String + "#text": "-" + OFFICER_NAME: + "@type": String + "#text": HENRY GOH + CHANGE_ADDR_DATE: + "@type": String + "#text": 30/10/2003 + APPMT_DATE: + "@type": String + "#text": 07/03/2006 + NATIONALITY: + "@type": String + "#text": SINGAPORE P.R. + LIST_SALES_REVENUE_AMOUNT: + SALES_REVENUE_AMOUNT: + - ELEMENTS: Sales Revenue Amount + YEAR: '2008' + CURRENCY: SGD + AMOUNT: '30000.00' + - ELEMENTS: Sales Revenue Amount + YEAR: '2007' + CURRENCY: SGD + AMOUNT: '28000.00' + - ELEMENTS: Sales Revenue Amount + YEAR: '2006' + CURRENCY: SGD + AMOUNT: '27,000.00' '401': description: Unauthorized content: @@ -308,13 +657,22 @@ components: properties: META_INFO: type: object - example: |+ - - - - - - + example: + META_INFO: + SERVICE: + "@type": String + "#text": BCP + SYSTEM_ID: + "@type": String + "#text": DDP + CREATION_DATE: + "@type": Date + "#text": Wed Apr 08 11:37:51 MYT 2009 + USER_ID: + "@type": String + CLASS: + "@type": String + "#text": class com.technodex.ddp.xmlbean.MetaBean description: |+ Meta Information details with following children: SERVICE @@ -345,28 +703,78 @@ components: example: N/A REGISTRY_DETAIL : type: object - example: |+ - - - - - - - - - - - - - - - - - - - - - + example: + REGISTRY_DETAIL: + "@className": com.technodex.ddp.report.bean.CommercialBizRegistryBean + RENEWAL_DATE: + "@type": String + "#text": 23/12/2008 + ADDRESS1: + "@type": String + "#text": 1 HARBOURFRONT AVENUE , 18 - 01 + ADDRESS2: + "@type": String + "#text": KEPPEL BAY TOWER + ADDRESS3: + "@type": String + "#text": '098632' + ADDRESS4: + "@type": String + "#text": SINGAPORE + COMP_TYPE_CODE: + "@type": String + "#text": CP + REG_DATE: + "@type": String + "#text": 14/10/1974 + REG_ACTIVITY1: + "@type": String + "#text": OTHER INVESTMENT HOLDING COMPANIES + REG_ACTIVITY2: + "@type": String + "#text": SHIP MANAGEMENT SERVICES + ACC_DATE: + "@type": String + "#text": 31/12/2007 + STATUS_EFFECT_DATE: + "@type": String + "#text": 14/10/1974 + NAME_EFFECT_DATE: + "@type": String + "#text": 14/10/1974 + EXPIRY_DATE: + "@type": String + "#text": 25/10/2009 + COMP_TYPE: + "@type": String + "#text": LIMITED PRIVATE COMPANY + CHANGE_ADDR_DATE: + "@type": String + "#text": '09/05/2003' + COMP_STATUS: + "@type": String + "#text": Live Company + REG_ACTIVITY_DESC1: + "@type": String + "#text": "-" + REG_ACTIVITY_DESC2: + "@type": String + "#text": "-" + AUDITOR: + "@type": String + "#text": "-" + AUDITOR_APPMT_DATE: + "@type": String + "#text": 13/06/1990 + LAST_AR_DATE: + "@type": String + "#text": 30/06/2008 + LAST_AGM_DATE: + "@type": String + "#text": 11/06/2008 + COUNTRY_INCORP: + "@type": String + "#text": SINGAPORE description: |+ Registry Details with following children: RENEWAL_DATE @@ -490,13 +898,27 @@ components: example: "SINGAPORE" REQ_SEARCH_INFO : type: object - example: |+ - - - - - - + example: + REQ_SEARCH_INFO: + "@className": com.technodex.ddp.report.bean.LitigationSearchInfoBean + COMP_NAME: + "@type": String + "#text": KAPAL MANAGEMENT (PRIVATE) LIMITED + REG_NO: + "@type": String + "#text": 197401835M + REQ_DATE: + "@type": Date + "#text": '2009-04-08 11:36:03.611' + REQ_REG_NO: + "@type": String + "#text": 197401835M + REQ_NAME: + "@type": String + "#text": KAPAL MANAGEMENT (PRIVATE) LIMITED + REQ_DATE_STR: + "@type": String + "#text": '08/04/2009 11:36:03' description: |+ Request criteria & search record with following children: COMP_NAME @@ -536,11 +958,10 @@ components: Employee Size details with following children: ELEMENTS AMOUNT - example: |+ - - - 300 - + example: + EMPLOYEE_SIZE: + ELEMENTS: Employee Size + AMOUNT: '300' properties: ELEMENTS: type: string @@ -555,13 +976,19 @@ components: description: |+ List of Business Branches with following children: [BIZ_BRANCH] - example: |+ - - - - - - + example: + LIST_BIZ_BRANCH: + "@className": com.technodex.ddp.report.bean.CommercialBizBranchBean + BIZ_BRANCH: + ADDR_BUILDING: + "@type": String + "#text": "-" + ADDR_POSTCODE: + "@type": String + "#text": '289848' + ADDR_ADDRESS1: + "@type": String + "#text": 251A ARCADIA ROAD , - - - items: properties: BIZ_BRANCH : @@ -571,12 +998,17 @@ components: ADDR_BUILDING ADDR_POSTCODE ADDR_ADDRESS1 - example: |+ - - - - - + example: + BIZ_BRANCH: + ADDR_BUILDING: + "@type": String + "#text": "-" + ADDR_POSTCODE: + "@type": String + "#text": '289848' + ADDR_ADDRESS1: + "@type": String + "#text": 251A ARCADIA ROAD , - - - properties: ADDR_BUILDING: type: string @@ -595,16 +1027,28 @@ components: description: |+ List of Registered Charges with following children: [REG_CHARGES] - example: |+ - - - - - - - - - + example: + LIST_REG_CHARGES: + "@className": com.technodex.ddp.report.bean.CommercialBizChgRegBean + REG_CHARGES: + CHARGE_NO: + "@type": String + "#text": '8205117' + CHARGE_DATE: + "@type": String + "#text": 26/11/1982 + CHARGEE_COMP: + "@type": String + "#text": UNITED OVERSEAS BANK LIMITED + CURRENCY: + "@type": String + "#text": "-" + AMT_SECURED: + "@type": String + "#text": '1000.00' + STATUS_SATISFACTION: + "@type": String + "#text": "-" items: properties: REG_CHARGES : @@ -617,15 +1061,26 @@ components: CURRENCY AMT_SECURED STATUS_SATISFACTION - example: |+ - - - - - - - - + example: + REG_CHARGES: + CHARGE_NO: + "@type": String + "#text": '8205117' + CHARGE_DATE: + "@type": String + "#text": 26/11/1982 + CHARGEE_COMP: + "@type": String + "#text": UNITED OVERSEAS BANK LIMITED + CURRENCY: + "@type": String + "#text": "-" + AMT_SECURED: + "@type": String + "#text": '1000.00' + STATUS_SATISFACTION: + "@type": String + "#text": "-" properties: CHARGE_NO : type: string @@ -656,15 +1111,18 @@ components: description: |+ List of Liquidator / Receiver / Judicial Manager with following children: [LIQUIDATOR] - example: |+ - - - ABUTHAHIR ABDUL GAFOOR S1676216D - Liquidator - EL TICI FINANCIAL ADVISORY SERVICES PTE. LTD. 1 RAFFLES PLACE #20-01 - OUB CENTRE SINGAPORE 048616 30/03/2009 - - + example: + LIST_LIQUIDATOR: + LIQUIDATOR: + LIQ_NAME: ABUTHAHIR ABDUL GAFOOR + LIQ_ID: S1676216D + LIQ_POSITION: Liquidator + LIQ_COMP: EL TICI FINANCIAL ADVISORY SERVICES PTE. LTD. + LIQ_ADDRESS1: 1 RAFFLES PLACE + LIQ_ADDRESS2: "#20-01" + LIQ_ADDRESS3: OUB CENTRE + LIQ_ADDRESS4: SINGAPORE 048616 + LIQ_APPOINTMENT_DATE: 30/03/2009 items: properties: LIQUIDATOR : @@ -680,18 +1138,17 @@ components: LIQ_ADDRESS3 LIQ_ADDRESS4 LIQ_APPOINTMENT_DATE - example: |+ - - ABUTHAHIR ABDUL GAFOOR - S1676216D - Liquidator - EL TICI FINANCIAL ADVISORY SERVICES PTE. LTD. - 1 RAFFLES PLACE - #20-01 - OUB CENTRE - SINGAPORE 048616 - 30/03/2009 - + example: + LIQUIDATOR: + LIQ_NAME: ABUTHAHIR ABDUL GAFOOR + LIQ_ID: S1676216D + LIQ_POSITION: Liquidator + LIQ_COMP: EL TICI FINANCIAL ADVISORY SERVICES PTE. LTD. + LIQ_ADDRESS1: 1 RAFFLES PLACE + LIQ_ADDRESS2: "#20-01" + LIQ_ADDRESS3: OUB CENTRE + LIQ_ADDRESS4: SINGAPORE 048616 + LIQ_APPOINTMENT_DATE: 30/03/2009 properties: LIQ_POSITION: type: string @@ -734,27 +1191,67 @@ components: description: |+ List of Winding Up with following children: [WINDING_UP] - example: |+ - - - - - - - - - - - - - - - - - - - - + example: + LIST_WINDING_UP: + "@className": com.technodex.ddp.report.bean.CommercialBizWindingupBean + WINDING_UP: + CASE_CODE: + "@type": String + "#text": '40000' + CASE_YEAR: + "@type": String + "#text": '1999' + PLAINTIFF: + "@type": String + "#text": "-" + PLA_SOLICITOR_ID: + "@type": String + "#text": "-" + PLA_FILE_REF: + "@type": String + "#text": "-" + COURT_CODE: + "@type": String + "#text": CWU + CASE_TYPE: + "@type": String + "#text": COMPANY WINDING UP PETITION + CURRENCY1: + "@type": String + "#text": SGD + AMOUNT1: + "@type": String + "#text": '41,424.52' + CURRENCY2: + "@type": String + "#text": MYR + AMOUNT2: + "@type": String + "#text": '0.00' + CURRENCY3: + "@type": String + "#text": "-" + AMOUNT3: + "@type": String + "#text": '0.00' + BANKRUPTCY_ACT: + "@type": String + "#text": Petition for Winding Up + HEARING_DATE: + "@type": String + "#text": 15/12/2007 + ACTION_DATE: + "@type": String + "#text": 11/05/2007 + SUBJECT_NAME: + "@type": String + "#text": PROACTIVE BUILDERS + PLA_SOLICITOR: + "@type": String + "#text": "-" + PLA_LAW_FIRM: + "@type": String + "#text": NAME2 items: properties: WINDING_UP : @@ -780,26 +1277,65 @@ components: BANKRUPTCY_ACT HEARING_DATE PLA_SOLICITOR - example: |+ - - - - - - - - - - - - - - - - - - - + example: + WINDING_UP: + CASE_CODE: + "@type": String + "#text": '40000' + CASE_YEAR: + "@type": String + "#text": '1999' + PLAINTIFF: + "@type": String + "#text": "-" + PLA_SOLICITOR_ID: + "@type": String + "#text": "-" + PLA_FILE_REF: + "@type": String + "#text": "-" + COURT_CODE: + "@type": String + "#text": CWU + CASE_TYPE: + "@type": String + "#text": COMPANY WINDING UP PETITION + CURRENCY1: + "@type": String + "#text": SGD + AMOUNT1: + "@type": String + "#text": '41,424.52' + CURRENCY2: + "@type": String + "#text": MYR + AMOUNT2: + "@type": String + "#text": '0.00' + CURRENCY3: + "@type": String + "#text": "-" + AMOUNT3: + "@type": String + "#text": '0.00' + BANKRUPTCY_ACT: + "@type": String + "#text": Petition for Winding Up + HEARING_DATE: + "@type": String + "#text": 15/12/2007 + ACTION_DATE: + "@type": String + "#text": 11/05/2007 + SUBJECT_NAME: + "@type": String + "#text": PROACTIVE BUILDERS + PLA_SOLICITOR: + "@type": String + "#text": "-" + PLA_LAW_FIRM: + "@type": String + "#text": NAME2 properties: CASE_CODE : type: string @@ -882,36 +1418,97 @@ components: description: |+ List of Winding Up with following children: [LITIGATION] - example: |+ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + example: + LIST_LITIGATION: + "@className": com.technodex.ddp.report.bean.CommercialBizLitigationBean + LITIGATION: + SUBJECT_NAME: + "@type": String + "#text": SOON SOON SEAFOOD + NATURE_OF_CLAIM: + "@type": String + "#text": CONTRACT 3 + STATUS_DATE: + "@type": String + "#text": 01/05/2008 + CASE_NO: + "@type": String + "#text": MC 40001 / 1999 + DOC_REMARKS: + "@type": String + "#text": NOTICE OF DISCONTINUANCE/WITHDRAWAL 3 + CURRENCY1: + "@type": String + "#text": SGD + CURRENCY2: + "@type": String + "#text": MYR + CURRENCY3: + "@type": String + "#text": USD + CURRENCY4: + "@type": String + "#text": "-" + CURRENCY5: + "@type": String + "#text": "-" + DEF_SOLICITOR: + "@type": String + "#text": SOL2 + DEF_SOLICITOR_ID: + "@type": String + "#text": '20000000' + DEF_LAW_FIRM: + "@type": String + "#text": NAME2 + DEF_FILE_REF: + "@type": String + "#text": FILE2 + DATE_OF_WRIT: + "@type": String + "#text": 01/01/2008 + STATUS: + "@type": String + "#text": CONCLUDED 3 + AMOUNT1: + "@type": String + "#text": '100.00' + AMOUNT2: + "@type": String + "#text": '200.00' + AMOUNT3: + "@type": String + "#text": '0.00' + AMOUNT4: + "@type": String + "#text": '400.00' + AMOUNT5: + "@type": String + "#text": '0.00' + PLAINTIFF: + "@type": String + "#text": MC 40001 + PLA_SOLICITOR: + "@type": String + "#text": SOL2 + PLA_SOLICITOR_ID: + "@type": String + "#text": '20000000' + PLA_LAW_FIRM: + "@type": String + "#text": NAME2 + PLA_FILE_REF: + "@type": String + "#text": FILE2 + PLA_ID: + "@type": String + "#text": S0739038F + PLA_STATUS: + "@type": String + "#text": SETTLED - BEFORE SET DOWN + PLA_STATUS_DATE: + "@type": String + "#text": 17/10/2016 items: properties: LITIGATION : @@ -947,34 +1544,95 @@ components: PLA_ID PLA_STATUS PLA_STATUS_DATE - example: |+ - - - - - - - - - - - - - - - - - - - - - - - - - - - + example: + LITIGATION: + SUBJECT_NAME: + "@type": String + "#text": SOON SOON SEAFOOD + NATURE_OF_CLAIM: + "@type": String + "#text": CONTRACT 3 + STATUS_DATE: + "@type": String + "#text": 01/05/2008 + CASE_NO: + "@type": String + "#text": MC 40001 / 1999 + DOC_REMARKS: + "@type": String + "#text": NOTICE OF DISCONTINUANCE/WITHDRAWAL 3 + CURRENCY1: + "@type": String + "#text": SGD + CURRENCY2: + "@type": String + "#text": MYR + CURRENCY3: + "@type": String + "#text": USD + CURRENCY4: + "@type": String + "#text": "-" + CURRENCY5: + "@type": String + "#text": "-" + DEF_SOLICITOR: + "@type": String + "#text": SOL2 + DEF_SOLICITOR_ID: + "@type": String + "#text": '20000000' + DEF_LAW_FIRM: + "@type": String + "#text": NAME2 + DEF_FILE_REF: + "@type": String + "#text": FILE2 + DATE_OF_WRIT: + "@type": String + "#text": 01/01/2008 + STATUS: + "@type": String + "#text": CONCLUDED 3 + AMOUNT1: + "@type": String + "#text": '100.00' + AMOUNT2: + "@type": String + "#text": '200.00' + AMOUNT3: + "@type": String + "#text": '0.00' + AMOUNT4: + "@type": String + "#text": '400.00' + AMOUNT5: + "@type": String + "#text": '0.00' + PLAINTIFF: + "@type": String + "#text": MC 40001 + PLA_SOLICITOR: + "@type": String + "#text": SOL2 + PLA_SOLICITOR_ID: + "@type": String + "#text": '20000000' + PLA_LAW_FIRM: + "@type": String + "#text": NAME2 + PLA_FILE_REF: + "@type": String + "#text": FILE2 + PLA_ID: + "@type": String + "#text": S0739038F + PLA_STATUS: + "@type": String + "#text": SETTLED - BEFORE SET DOWN + PLA_STATUS_DATE: + "@type": String + "#text": 17/10/2016 properties: SUBJECT_NAME : type: string @@ -1097,15 +1755,22 @@ components: description: |+ List of Share Interest In Companies with following children: [SHARE_INTEREST_COMP] - example: |+ - - - - - - - - + example: + LIST_SHARE_INTEREST_COMP: + "@className": com.technodex.ddp.report.bean.CommercialShareInterestBean + SHARE_INTEREST_COMP: + COMP_NAME: + "@type": String + "#text": ORCHID (HOLDINGS) PTE. LTD. + SHARE_OWNED_UNIT: + "@type": String + "#text": '500000' + SHARE_OWNED_PERCENT: + "@type": String + "#text": '100.00' + STATUS: + "@type": String + "#text": DISSOLVED - MEMBERS' VOLUNTARY WINDING UP items: properties: SHARE_INTEREST_COMP : @@ -1116,13 +1781,20 @@ components: SHARE_OWNED_UNIT SHARE_OWNED_PERCENT STATUS - example: |+ - - - - - - + example: + SHARE_INTEREST_COMP: + COMP_NAME: + "@type": String + "#text": ORCHID (HOLDINGS) PTE. LTD. + SHARE_OWNED_UNIT: + "@type": String + "#text": '500000' + SHARE_OWNED_PERCENT: + "@type": String + "#text": '100.00' + STATUS: + "@type": String + "#text": DISSOLVED - MEMBERS' VOLUNTARY WINDING UP properties: COMP_NAME : type: string @@ -1145,13 +1817,16 @@ components: description: |+ List of Change of Company/Business Name(s) with following children: [NAME_CHANGE] - example: |+ - - - - - - + example: + LIST_NAME_CHANGE: + "@className": com.technodex.ddp.report.bean.CommercialBizChgCmpBean + NAME_CHANGE: + PREV_NAME: + "@type": String + "#text": HUA XI EATING HOUSE + EFFECT_DATE: + "@type": String + "#text": 25/10/1997 00:00:00 items: properties: NAME_CHANGE : @@ -1160,11 +1835,14 @@ components: Change of Company/Business Name(s) with following children: PREV_NAME EFFECT_DATE - example: |+ - - - - + example: + NAME_CHANGE: + PREV_NAME: + "@type": String + "#text": HUA XI EATING HOUSE + EFFECT_DATE: + "@type": String + "#text": 25/10/1997 00:00:00 properties: PREV_NAME : type: string @@ -1179,21 +1857,44 @@ components: description: |+ List of Shareholders with following children: [SHAREHOLDER] - example: |+ - - -
- - - - - - - - - + example: + LIST_SHAREHOLDER: + "@className": com.technodex.ddp.report.bean.CommercialShareHoldersBean + SHAREHOLDER: + ADDRESS: + "@type": String + "#text": |- + 1 HARBOURFRONT AVENUE , 18 – 01; KEPPEL BAY TOWER; 098632, + SINGAPORE + COMP_ID: + "@type": String + "#text": 198200406H + NO_OF_SHARE: + "@type": String + "#text": '657' + CURRENCY: + "@type": String + "#text": UNITED STATES OF AMERICA, DOLLARS + SHAREHOLDER_TYPE: + "@type": String + "#text": '2' + SHARE_TYPE: + "@type": String + "#text": Preference + SHAREHOLDER_NAME: + "@type": String + "#text": |- + KEPPEL COMMUNICATIONS PTE + LTD + CHANGE_ADDR_DATE: + "@type": String + "#text": '09/05/2003' + ADDR_TYPE: + "@type": String + "#text": "-" + NATIONALITY: + "@type": String + "#text": SINGAPORE items: properties: SHAREHOLDER : @@ -1210,19 +1911,42 @@ components: CHANGE_ADDR_DATE ADDR_TYPE NATIONALITY - example: |+ - -
- - - - - - - - - - + example: + SHAREHOLDER: + ADDRESS: + "@type": String + "#text": |- + 1 HARBOURFRONT AVENUE , 18 – 01; KEPPEL BAY TOWER; 098632, + SINGAPORE + COMP_ID: + "@type": String + "#text": 198200406H + NO_OF_SHARE: + "@type": String + "#text": '657' + CURRENCY: + "@type": String + "#text": UNITED STATES OF AMERICA, DOLLARS + SHAREHOLDER_TYPE: + "@type": String + "#text": '2' + SHARE_TYPE: + "@type": String + "#text": Preference + SHAREHOLDER_NAME: + "@type": String + "#text": |- + KEPPEL COMMUNICATIONS PTE + LTD + CHANGE_ADDR_DATE: + "@type": String + "#text": '09/05/2003' + ADDR_TYPE: + "@type": String + "#text": "-" + NATIONALITY: + "@type": String + "#text": SINGAPORE properties: ADDRESS : type: string @@ -1279,16 +2003,25 @@ components: description: |+ List of Capital details with following children: [CAPITAL] - example: |+ - - - - - - - - - + example: + LIST_CAPITAL: + "@className": com.technodex.ddp.report.bean.CommercialBizCapitalBean + CAPITAL: + CAPITAL_CATEGORY: + "@type": String + "#text": Issued + CAPITAL_TYPE: + "@type": String + "#text": Ordinary + CURRENCY: + "@type": String + "#text": SINGAPORE, DOLLARS + CAPITAL_AMT: + "@type": String + "#text": '100,000.00' + NO_OF_SHARES: + "@type": String + "#text": '100,000' items: properties: CAPITAL : @@ -1300,14 +2033,23 @@ components: CURRENCY CAPITAL_AMT NO_OF_SHARES - example: |+ - - - - - - - + example: + CAPITAL: + CAPITAL_CATEGORY: + "@type": String + "#text": Issued + CAPITAL_TYPE: + "@type": String + "#text": Ordinary + CURRENCY: + "@type": String + "#text": SINGAPORE, DOLLARS + CAPITAL_AMT: + "@type": String + "#text": '100,000.00' + NO_OF_SHARES: + "@type": String + "#text": '100,000' properties: CAPITAL_CATEGORY : type: string @@ -1334,18 +2076,39 @@ components: description: |+ List of Officer(s) / Owner(s) with following children: [OFFICER_OWNER] - example: |+ - - -
- - - - - - - + example: + LIST_OFFICER_OWNER: + "@className": com.technodex.ddp.report.bean.CommercialBizOfficeOwerBean + OFFICER_OWNER: + ADDRESS: + "@type": String + "#text": |- + 50A TOH TUCK ROAD, 04 - 08 ; SIGNATURE PARK; 596742, + SINGAPORE + IDENTITY_ID: + "@type": String + "#text": S1674174D + POSITION: + "@type": String + "#text": DIRECTOR + ADDR_TYPE: + "@type": String + "#text": S + CESSATION_DATE: + "@type": String + "#text": "-" + OFFICER_NAME: + "@type": String + "#text": NGIAM SHARE CHING + CHANGE_ADDR_DATE: + "@type": String + "#text": 25/10/2008 + APPMT_DATE: + "@type": String + "#text": 30/09/2008 + NATIONALITY: + "@type": String + "#text": SINGAPORE CITIZEN items: properties: OFFICER_OWNER : @@ -1362,18 +2125,37 @@ components: CHANGE_ADDR_DATE APPMT_DATE NATIONALITY - example: |+ - -
- - - - - - - - - + example: + OFFICER_OWNER: + ADDRESS: + "@type": String + "#text": |- + 50A TOH TUCK ROAD, 04 - 08 ; SIGNATURE PARK; 596742, + SINGAPORE + IDENTITY_ID: + "@type": String + "#text": S1674174D + POSITION: + "@type": String + "#text": DIRECTOR + ADDR_TYPE: + "@type": String + "#text": S + CESSATION_DATE: + "@type": String + "#text": "-" + OFFICER_NAME: + "@type": String + "#text": NGIAM SHARE CHING + CHANGE_ADDR_DATE: + "@type": String + "#text": 25/10/2008 + APPMT_DATE: + "@type": String + "#text": 30/09/2008 + NATIONALITY: + "@type": String + "#text": SINGAPORE CITIZEN properties: ADDRESS : type: string @@ -1424,12 +2206,13 @@ components: description: |+ List of Sales Revenue Amount with following children: [SALES_REVENUE_AMOUNT] - example: |+ - - - 30000.00 - - + example: + LIST_SALES_REVENUE_AMOUNT: + SALES_REVENUE_AMOUNT: + ELEMENTS: Sales Revenue Amount + YEAR: '2008' + CURRENCY: SGD + AMOUNT: '30000.00' items: properties: SALES_REVENUE_AMOUNT : @@ -1440,13 +2223,12 @@ components: YEAR CURRENCY AMOUNT - example: |+ - - - - - 30000.00 - + example: + SALES_REVENUE_AMOUNT: + ELEMENTS: Sales Revenue Amount + YEAR: '2008' + CURRENCY: SGD + AMOUNT: '30000.00' properties: ELEMENTS : type: string From 5fea8dd01707ec7fc117e2e97917b1a914fd0b9f Mon Sep 17 00:00:00 2001 From: rameshsentient <51635015+rameshsentient@users.noreply.github.com> Date: Tue, 23 Mar 2021 14:51:06 +0530 Subject: [PATCH 762/792] Update newspaper_article_scraper.yaml --- utility/newspaper_article_scraper.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/utility/newspaper_article_scraper.yaml b/utility/newspaper_article_scraper.yaml index 4739c06ea..2965644aa 100644 --- a/utility/newspaper_article_scraper.yaml +++ b/utility/newspaper_article_scraper.yaml @@ -313,7 +313,7 @@ components: properties: url: type: string - example: https://www.bangkokpost.com/learning/news/1272315/study-and-work-in-australia-%E2%80%93-many-opportunities-ahead + example: https://www.bangkokpost.com/ default: true description: The absolute input url, i.e exact, full address (URL) to the page. securitySchemes: From 461f6d899d6c00a5f5accac1e9f14bf2db675a7b Mon Sep 17 00:00:00 2001 From: Mohamed Luqman <57977684+mohamedSent@users.noreply.github.com> Date: Tue, 23 Mar 2021 15:36:52 +0530 Subject: [PATCH 763/792] Update amenities_hardcourts_hdb_sg_v1.0.yaml --- data/amenities_hardcourts_hdb_sg_v1.0.yaml | 45 ---------------------- 1 file changed, 45 deletions(-) diff --git a/data/amenities_hardcourts_hdb_sg_v1.0.yaml b/data/amenities_hardcourts_hdb_sg_v1.0.yaml index 2f67e7cc0..8d31810f3 100644 --- a/data/amenities_hardcourts_hdb_sg_v1.0.yaml +++ b/data/amenities_hardcourts_hdb_sg_v1.0.yaml @@ -82,24 +82,6 @@ paths: application/json: schema: $ref: '#/components/schemas/notfound' - '419': - description: Input Field Missing - content: - application/json: - schema: - $ref: '#/components/schemas/inputfieldmissing' - '413': - description: Payload Too Large - content: - application/json: - schema: - $ref: '#/components/schemas/inputlimitexceeded' - '415': - description: Unsupported Media Type - content: - application/json: - schema: - $ref: '#/components/schemas/invalidinput' '500': description: Internal Server Error content: @@ -190,33 +172,6 @@ components: status: type: string example: Failure - inputfieldmissing: - type: object - properties: - message: - type: string - example: Input Field Missing - status: - type: string - example: Failure - inputlimitexceeded: - type: object - properties: - message: - type: string - example: Input Limit Exceeded - status: - type: string - example: Failure - invalidinput: - type: object - properties: - message: - type: string - example: Invalid Input - status: - type: string - example: Failure versions: type: object properties: From bff75d4b4e1fd7e038903791a95c4dc9fc3fc337 Mon Sep 17 00:00:00 2001 From: Mohamed Luqman <57977684+mohamedSent@users.noreply.github.com> Date: Tue, 23 Mar 2021 15:43:57 +0530 Subject: [PATCH 764/792] Update amenities_lamp_posts_hdb_sg_v1.0.yaml --- data/amenities_lamp_posts_hdb_sg_v1.0.yaml | 18 ------------------ 1 file changed, 18 deletions(-) diff --git a/data/amenities_lamp_posts_hdb_sg_v1.0.yaml b/data/amenities_lamp_posts_hdb_sg_v1.0.yaml index 5506ad54c..bd94dfdfa 100644 --- a/data/amenities_lamp_posts_hdb_sg_v1.0.yaml +++ b/data/amenities_lamp_posts_hdb_sg_v1.0.yaml @@ -84,24 +84,6 @@ paths: application/json: schema: $ref: '#/components/schemas/notfound' - '419': - description: Input Field Missing - content: - application/json: - schema: - $ref: '#/components/schemas/inputfieldmissing' - '413': - description: Payload Too Large - content: - application/json: - schema: - $ref: '#/components/schemas/inputlimitexceeded' - '415': - description: Unsupported Media Type - content: - application/json: - schema: - $ref: '#/components/schemas/invalidinput' '500': description: Internal Server Error content: From 017c92f52ef9964f5d43c094dfb7dbb026930583 Mon Sep 17 00:00:00 2001 From: Mohamed Luqman <57977684+mohamedSent@users.noreply.github.com> Date: Tue, 23 Mar 2021 15:50:33 +0530 Subject: [PATCH 765/792] Update amenities_shelters_hdb_sg_v1.0.yaml --- data/amenities_shelters_hdb_sg_v1.0.yaml | 27 ------------------------ 1 file changed, 27 deletions(-) diff --git a/data/amenities_shelters_hdb_sg_v1.0.yaml b/data/amenities_shelters_hdb_sg_v1.0.yaml index c0c339c4e..3781da3de 100644 --- a/data/amenities_shelters_hdb_sg_v1.0.yaml +++ b/data/amenities_shelters_hdb_sg_v1.0.yaml @@ -193,33 +193,6 @@ components: status: type: string example: Failure - inputfieldmissing: - type: object - properties: - message: - type: string - example: Input Field Missing - status: - type: string - example: Failure - inputlimitexceeded: - type: object - properties: - message: - type: string - example: Input Limit Exceeded - status: - type: string - example: Failure - invalidinput: - type: object - properties: - message: - type: string - example: Invalid Input - status: - type: string - example: Failure versions: type: object properties: From 8989e82ab06d7a8abc5e4a8b348c798102ff209d Mon Sep 17 00:00:00 2001 From: Mohamed Luqman <57977684+mohamedSent@users.noreply.github.com> Date: Tue, 23 Mar 2021 16:18:34 +0530 Subject: [PATCH 766/792] Update amenities_lamp_posts_hdb_sg_v1.0.yaml --- data/amenities_lamp_posts_hdb_sg_v1.0.yaml | 27 ---------------------- 1 file changed, 27 deletions(-) diff --git a/data/amenities_lamp_posts_hdb_sg_v1.0.yaml b/data/amenities_lamp_posts_hdb_sg_v1.0.yaml index bd94dfdfa..eacab3662 100644 --- a/data/amenities_lamp_posts_hdb_sg_v1.0.yaml +++ b/data/amenities_lamp_posts_hdb_sg_v1.0.yaml @@ -174,33 +174,6 @@ components: status: type: string example: Failure - inputfieldmissing: - type: object - properties: - message: - type: string - example: Input Field Missing - status: - type: string - example: Failure - inputlimitexceeded: - type: object - properties: - message: - type: string - example: Input Limit Exceeded - status: - type: string - example: Failure - invalidinput: - type: object - properties: - message: - type: string - example: Invalid Input - status: - type: string - example: Failure versions: type: object properties: From 692c443c2d79f4deff3c6ada3d889ae20e5c8f75 Mon Sep 17 00:00:00 2001 From: rameshsentient <51635015+rameshsentient@users.noreply.github.com> Date: Wed, 7 Apr 2021 11:14:59 +0530 Subject: [PATCH 767/792] Update automatic_speech_recognition_chi_sg_V1.0.yaml --- voice/automatic_speech_recognition_chi_sg_V1.0.yaml | 1 + 1 file changed, 1 insertion(+) diff --git a/voice/automatic_speech_recognition_chi_sg_V1.0.yaml b/voice/automatic_speech_recognition_chi_sg_V1.0.yaml index d8e19c07a..c71dc9532 100644 --- a/voice/automatic_speech_recognition_chi_sg_V1.0.yaml +++ b/voice/automatic_speech_recognition_chi_sg_V1.0.yaml @@ -111,6 +111,7 @@ components: results: type: object description: output object + example: {""} properties: output: type: string From 71403e71513977ff0a5b9ad12c4b0ca9f2eaa2ed Mon Sep 17 00:00:00 2001 From: rameshsentient <51635015+rameshsentient@users.noreply.github.com> Date: Wed, 7 Apr 2021 11:46:34 +0530 Subject: [PATCH 768/792] Update index.yaml --- index.yaml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/index.yaml b/index.yaml index b338aebb4..7b442db0b 100644 --- a/index.yaml +++ b/index.yaml @@ -25,7 +25,7 @@ voice: automatic_speech_recognition_eng_sg: - title: Automatic Speech Recognition ENG (SG) + title: Automatic Speech Recognition ENG versions: 1.1.0: 'automatic_speech_recognition_eng_sg_v1.0.yaml' 0.1.0: 'automatic_speech_recognition_eng_sg.yaml' @@ -51,7 +51,7 @@ voice: versions: 0.1.0: 'text-to-speech_chi.yaml' asr_with_voice_activity_detection_eng_sg: - title: ASR with Voice Activity Detection ENG (SG) + title: ASR with Voice Activity Detection ENG versions: 1.1.0: 'asr_with_voice_activity_detection_eng_sg_v1.0.yaml' 0.1.0: 'asr_with_voice_activity_detection_eng_sg.yaml' From 67b76699cb4693deec0796cfab40ccdd78611bba Mon Sep 17 00:00:00 2001 From: karunakarv <76933934+karunakarv@users.noreply.github.com> Date: Thu, 22 Jun 2023 11:29:57 +0530 Subject: [PATCH 769/792] Add alfred files --- D:/New folder/decorators.py | 50 +++++++++++++++++++++++++++++++++++++ 1 file changed, 50 insertions(+) create mode 100644 D:/New folder/decorators.py diff --git a/D:/New folder/decorators.py b/D:/New folder/decorators.py new file mode 100644 index 000000000..4ffe4ea70 --- /dev/null +++ b/D:/New folder/decorators.py @@ -0,0 +1,50 @@ + +# def parent(func): +# def inner(a,b): +# if b==0: +# return False +# else: +# return func(a,b) +# return inner + +# @parent +# def decod(a,b): +# dev= a/b +# return dev + +# print(decod(10,0)) + +# def parent(func): +# def child(): +# data=func() +# result=data.upper() +# return result +# return child + +# def main(): +# return "I am the main function " + +# Result=parent(main) +# print(Result()) + +def grandfather(strg): + def parent(func): + def child(a,b): + if b !=0: + result=func(a,b) + print(result) + return str(result) +strg + else: + return "Can't divide by zero"+strg + return child + return parent +@grandfather(" i am a granfather ") +def div(a,b): + result=a/b + return result + +result=div(100,0) +print(result) + + + \ No newline at end of file From fb6fc7a0729f7c31d81bb6ebf4b1daca2ac390e9 Mon Sep 17 00:00:00 2001 From: karunakarv <76933934+karunakarv@users.noreply.github.com> Date: Thu, 22 Jun 2023 11:41:14 +0530 Subject: [PATCH 770/792] Add yaml files --- D:/New folder/docsfile.yaml | 1 + 1 file changed, 1 insertion(+) create mode 100644 D:/New folder/docsfile.yaml diff --git a/D:/New folder/docsfile.yaml b/D:/New folder/docsfile.yaml new file mode 100644 index 000000000..eb50da306 --- /dev/null +++ b/D:/New folder/docsfile.yaml @@ -0,0 +1 @@ +https://cdn.sentient.io//63f448f2ea50d_sample_ai_docs.yaml \ No newline at end of file From 79f73030299ba89cb75acfc2561b89dccf41f69c Mon Sep 17 00:00:00 2001 From: karunakarv <76933934+karunakarv@users.noreply.github.com> Date: Thu, 22 Jun 2023 11:48:16 +0530 Subject: [PATCH 771/792] Add yaml files From 551d9ea0b8fe347634a604bb138151b2a2aeac8b Mon Sep 17 00:00:00 2001 From: karunakarv <76933934+karunakarv@users.noreply.github.com> Date: Thu, 22 Jun 2023 11:50:31 +0530 Subject: [PATCH 772/792] Add yaml files From 840ae0564e551711b257aafbaf6068f64b2b2a31 Mon Sep 17 00:00:00 2001 From: karunakarv <76933934+karunakarv@users.noreply.github.com> Date: Thu, 22 Jun 2023 11:56:28 +0530 Subject: [PATCH 773/792] Add alfred files --- D:/New folder/sample_ai_docs.yaml | 271 ++++++++++++++++++++++++++++++ 1 file changed, 271 insertions(+) create mode 100644 D:/New folder/sample_ai_docs.yaml diff --git a/D:/New folder/sample_ai_docs.yaml b/D:/New folder/sample_ai_docs.yaml new file mode 100644 index 000000000..91e77ac5b --- /dev/null +++ b/D:/New folder/sample_ai_docs.yaml @@ -0,0 +1,271 @@ +openapi: 3.0.1 +info: + title: <> + description: |+ + <> + version: '<>' + x-additionalinfo: |+ + << additional details about the microservice eg:use case, suggestions, model details>> + x-subscribelink: <> + x-apitype: <> + x-apitypedescription: |+ + <<50 characters api description eg: FAST, REST, small files. Displayed also in platform microservice detail page>> + x-inputfilelimit: |+ + <> + x-responsetime: |+ + <> + x-billingmethod: |+ + <> + x-notes: |+ + <> + x-apidetailsdesc: |+ + <> +servers: + - url: 'https://apis.sentient.io' +tags: +- name: "v<>" + description: "Published Date - <>" +paths: + /microservices/ts<>/v<>/: + post: + tags: + - v<> + responses: + '200': + description: Ok + content: + application/json: + schema: + $ref: '#/components/schemas/success' + example: + results: + output: + - <> + message: Successfully Processed + status: Success + '401': ## Add all supported error response + description: Unauthorized + content: + application/json: + schema: + $ref: '#/components/schemas/unauthorized' + '402': + description: Payment Required + content: + application/json: + schema: + $ref: '#/components/schemas/paymentrequired' + '403': + description: Forbidden + content: + application/json: + schema: + $ref: '#/components/schemas/forbidden' + '404': + description: Not Found + content: + application/json: + schema: + $ref: '#/components/schemas/notfound' + '419': + description: Input Field Missing + content: + application/json: + schema: + $ref: '#/components/schemas/inputfieldmissing' + '413': + description: Payload Too Large + content: + application/json: + schema: + $ref: '#/components/schemas/inputlimitexceeded' + '415': + description: Unsupported Media Type + content: + application/json: + schema: + $ref: '#/components/schemas/invalidinput' + '500': + description: Internal Server Error + content: + application/json: + schema: + $ref: '#/components/schemas/servererror' + '504': + description: Gateway Timeout + content: + application/json: + schema: + $ref: '#/components/schemas/gatewaytimeout' + security: + - APIAuthorizer: [] + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/input' + required: true +components: + schemas: + success: + type: object + properties: + results: + type: object + description: The result of the API call. + example: { "" } + properties: + output: ## sample output + type: <> ### verify types for the input type https://swagger.io/specification/ + example: > + description: <> + items: + oneOf: + - type: object + properties: + <>: + type: <> ### verify types for the input type https://swagger.io/specification/ + format: <> + example: <> + description: <> + <>: + type: <> ### verify types for the input type https://swagger.io/specification/ + format: <> + example: <> + description: <> + message: + type: string + example: Successfully Processed + description: Description of the API status + status: + type: string + example: Success + description: The status of the API call - success/failure + unauthorized: + type: object + properties: + message: + type: string + example: Missing Authentication Token + status: + type: string + example: Failure + forbidden: + type: object + properties: + message: + type: string + example: Access Denied Unauthorized User + status: + type: string + example: Failure + paymentrequired: + type: object + properties: + message: + type: string + example: Insufficient Credits Kindly Top Up + status: + type: string + example: Failure + notfound: + type: object + properties: + message: + type: string + example: Invalid Request URL + status: + type: string + example: Failure + servererror: + type: object + properties: + message: + type: string + example: Internal Server Error + status: + type: string + example: Failure + gatewaytimeout: + type: object + properties: + message: + type: string + example: Request Timeout + status: + type: string + example: Failure + inputfieldmissing: + type: object + properties: + message: + type: string + example: Input Field Missing + status: + type: string + example: Failure + inputlimitexceeded: + type: object + properties: + message: + type: string + example: Input Limit Exceeded + status: + type: string + example: Failure + invalidinput: + type: object + properties: + message: + type: string + example: Invalid Input + status: + type: string + example: Failure + input: + type: object + required: + - <> + - <> + properties: + <>: + x-name: <> + type: <> ### verify types for the input type https://swagger.io/specification/ + default: <> + example: <> + description: |+ + <> + + <>: + x-name: <> + type: <> ### verify types for the input type https://swagger.io/specification/ + default: <> + example: <> + description: |+ + <> + versions: + type: object + properties: + v<>: + type: array + items: + oneOf: + - type: string + example: 'Published Date - <>' + x-details: <> + description: <> + v<>: + type: array + items: + oneOf: + - type: string + example: 'Published Date - <>' + x-details: <> + description: <> + securitySchemes: ## DO NOT change of the details here + APIAuthorizer: + type: apiKey + name: x-api-key + in: header + x-amazon-apigateway-authtype: custom + description: Authentication is done using the x-api-key in the request header \ No newline at end of file From d2e91ffd40bc95143ed191c9be1d442f8ce641a6 Mon Sep 17 00:00:00 2001 From: karunakarv <76933934+karunakarv@users.noreply.github.com> Date: Thu, 22 Jun 2023 15:13:28 +0530 Subject: [PATCH 774/792] Add yaml files --- D:/New folder/test_file.zip | 0 1 file changed, 0 insertions(+), 0 deletions(-) create mode 100644 D:/New folder/test_file.zip diff --git a/D:/New folder/test_file.zip b/D:/New folder/test_file.zip new file mode 100644 index 000000000..e69de29bb From 3f0efe7e94266f9a5ab7569d153b8f484df0bff6 Mon Sep 17 00:00:00 2001 From: karunakarv <76933934+karunakarv@users.noreply.github.com> Date: Thu, 22 Jun 2023 15:15:55 +0530 Subject: [PATCH 775/792] Add yaml files --- D:/New folder/docsfile (1).yaml | 0 1 file changed, 0 insertions(+), 0 deletions(-) create mode 100644 D:/New folder/docsfile (1).yaml diff --git a/D:/New folder/docsfile (1).yaml b/D:/New folder/docsfile (1).yaml new file mode 100644 index 000000000..e69de29bb From 44cf68e0d612d1ec188b3b2a5f7c7e75aaa22643 Mon Sep 17 00:00:00 2001 From: karunakarv <76933934+karunakarv@users.noreply.github.com> Date: Thu, 22 Jun 2023 15:23:52 +0530 Subject: [PATCH 776/792] Add yaml files --- D:/New folder/docsfile (2).yaml | 1 + 1 file changed, 1 insertion(+) create mode 100644 D:/New folder/docsfile (2).yaml diff --git a/D:/New folder/docsfile (2).yaml b/D:/New folder/docsfile (2).yaml new file mode 100644 index 000000000..993bab987 --- /dev/null +++ b/D:/New folder/docsfile (2).yaml @@ -0,0 +1 @@ +"docsfile (2).yaml" \ No newline at end of file From b775081b37cf31eb7adcd9ac42df16227686c3df Mon Sep 17 00:00:00 2001 From: karunakarv <76933934+karunakarv@users.noreply.github.com> Date: Thu, 22 Jun 2023 15:52:42 +0530 Subject: [PATCH 777/792] Add yaml files From d201945d8fb0b8ad4a84e8c5dc523a79f6ff2a6b Mon Sep 17 00:00:00 2001 From: karunakarv <76933934+karunakarv@users.noreply.github.com> Date: Thu, 22 Jun 2023 15:58:39 +0530 Subject: [PATCH 778/792] Add yaml files --- D:/New folder/docsfile.yaml | 1 - 1 file changed, 1 deletion(-) diff --git a/D:/New folder/docsfile.yaml b/D:/New folder/docsfile.yaml index eb50da306..e69de29bb 100644 --- a/D:/New folder/docsfile.yaml +++ b/D:/New folder/docsfile.yaml @@ -1 +0,0 @@ -https://cdn.sentient.io//63f448f2ea50d_sample_ai_docs.yaml \ No newline at end of file From d97bcbe1770c547bfa2392a4ab448fd0f6cec139 Mon Sep 17 00:00:00 2001 From: karunakarv <76933934+karunakarv@users.noreply.github.com> Date: Thu, 22 Jun 2023 16:01:00 +0530 Subject: [PATCH 779/792] Add yaml files --- D:/New folder/docsfile.yaml | 1 + 1 file changed, 1 insertion(+) diff --git a/D:/New folder/docsfile.yaml b/D:/New folder/docsfile.yaml index e69de29bb..965d57b72 100644 --- a/D:/New folder/docsfile.yaml +++ b/D:/New folder/docsfile.yaml @@ -0,0 +1 @@ +"https://cdn.sentient.io//63f448f2ea50d_sample_ai_docs.yaml" \ No newline at end of file From a323e88212d5807024a1a65efae59c61a9e6b59d Mon Sep 17 00:00:00 2001 From: karunakarv <76933934+karunakarv@users.noreply.github.com> Date: Thu, 22 Jun 2023 16:05:38 +0530 Subject: [PATCH 780/792] Add yaml files --- New folder/docsfile (3).yaml | 1 + 1 file changed, 1 insertion(+) create mode 100644 New folder/docsfile (3).yaml diff --git a/New folder/docsfile (3).yaml b/New folder/docsfile (3).yaml new file mode 100644 index 000000000..eb50da306 --- /dev/null +++ b/New folder/docsfile (3).yaml @@ -0,0 +1 @@ +https://cdn.sentient.io//63f448f2ea50d_sample_ai_docs.yaml \ No newline at end of file From 75e3a3a8f96bc4f9e841a7d3251a07955e1e41b8 Mon Sep 17 00:00:00 2001 From: karunakarv <76933934+karunakarv@users.noreply.github.com> Date: Thu, 22 Jun 2023 16:07:37 +0530 Subject: [PATCH 781/792] Add yaml files --- D:/New folder/docsfile (3).yaml | 1 + 1 file changed, 1 insertion(+) create mode 100644 D:/New folder/docsfile (3).yaml diff --git a/D:/New folder/docsfile (3).yaml b/D:/New folder/docsfile (3).yaml new file mode 100644 index 000000000..965d57b72 --- /dev/null +++ b/D:/New folder/docsfile (3).yaml @@ -0,0 +1 @@ +"https://cdn.sentient.io//63f448f2ea50d_sample_ai_docs.yaml" \ No newline at end of file From 217da13304b96b7aa68fa23995a80e752fd68ae0 Mon Sep 17 00:00:00 2001 From: karunakarv <76933934+karunakarv@users.noreply.github.com> Date: Thu, 22 Jun 2023 16:12:47 +0530 Subject: [PATCH 782/792] Add yaml files --- D:/New folder/new.yaml | 1 + 1 file changed, 1 insertion(+) create mode 100644 D:/New folder/new.yaml diff --git a/D:/New folder/new.yaml b/D:/New folder/new.yaml new file mode 100644 index 000000000..e2bb6b4a2 --- /dev/null +++ b/D:/New folder/new.yaml @@ -0,0 +1 @@ +"openapi: 3.0.1\r\ninfo:\r\n title: <>\r\n description: |+\r\n <>\r\n version: '<>'\r\n x-additionalinfo: |+\r\n << additional details about the microservice eg:use case, suggestions, model details>>\r\n x-subscribelink: <>\r\n x-apitype: <>\r\n x-apitypedescription: |+\r\n <<50 characters api description eg: FAST, REST, small files. Displayed also in platform microservice detail page>>\r\n x-inputfilelimit: |+\r\n <>\r\n x-responsetime: |+\r\n <>\r\n x-billingmethod: |+\r\n <>\r\n x-notes: |+\r\n <>\r\n x-apidetailsdesc: |+\r\n <>\r\nservers:\r\n - url: 'https://apis.sentient.io'\r\ntags:\r\n- name: \"v<>\"\r\n description: \"Published Date - <>\"\r\npaths:\r\n /microservices/ts<>/v<>/:\r\n post:\r\n tags:\r\n - v<>\r\n responses:\r\n '200':\r\n description: Ok\r\n content:\r\n application/json:\r\n schema:\r\n $ref: '#/components/schemas/success'\r\n example:\r\n results:\r\n output:\r\n - <>\r\n message: Successfully Processed\r\n status: Success\r\n '401': ## Add all supported error response\r\n description: Unauthorized\r\n content:\r\n application/json:\r\n schema:\r\n $ref: '#/components/schemas/unauthorized'\r\n '402':\r\n description: Payment Required\r\n content:\r\n application/json:\r\n schema:\r\n $ref: '#/components/schemas/paymentrequired'\r\n '403':\r\n description: Forbidden\r\n content:\r\n application/json:\r\n schema:\r\n $ref: '#/components/schemas/forbidden'\r\n '404':\r\n description: Not Found\r\n content:\r\n application/json:\r\n schema:\r\n $ref: '#/components/schemas/notfound'\r\n '419':\r\n description: Input Field Missing\r\n content:\r\n application/json:\r\n schema:\r\n $ref: '#/components/schemas/inputfieldmissing'\r\n '413':\r\n description: Payload Too Large\r\n content:\r\n application/json:\r\n schema:\r\n $ref: '#/components/schemas/inputlimitexceeded'\r\n '415':\r\n description: Unsupported Media Type\r\n content:\r\n application/json:\r\n schema:\r\n $ref: '#/components/schemas/invalidinput'\r\n '500':\r\n description: Internal Server Error\r\n content:\r\n application/json:\r\n schema:\r\n $ref: '#/components/schemas/servererror'\r\n '504':\r\n description: Gateway Timeout\r\n content:\r\n application/json:\r\n schema:\r\n $ref: '#/components/schemas/gatewaytimeout'\r\n security:\r\n - APIAuthorizer: []\r\n requestBody:\r\n content:\r\n application/json:\r\n schema:\r\n $ref: '#/components/schemas/input'\r\n required: true\r\ncomponents:\r\n schemas:\r\n success:\r\n type: object\r\n properties:\r\n results: \r\n type: object\r\n description: The result of the API call.\r\n example: { \"\" }\r\n properties:\r\n output: ## sample output\r\n type: <> ### verify types for the input type https://swagger.io/specification/\r\n example: >\r\n description: <>\r\n items:\r\n oneOf:\r\n - type: object \r\n properties:\r\n <>:\r\n type: <> ### verify types for the input type https://swagger.io/specification/\r\n format: <>\r\n example: <>\r\n description: <>\r\n <>:\r\n type: <> ### verify types for the input type https://swagger.io/specification/\r\n format: <>\r\n example: <>\r\n description: <>\r\n message:\r\n type: string\r\n example: Successfully Processed\r\n description: Description of the API status\r\n status:\r\n type: string\r\n example: Success\r\n description: The status of the API call - success/failure\r\n unauthorized:\r\n type: object\r\n properties:\r\n message:\r\n type: string\r\n example: Missing Authentication Token\r\n status:\r\n type: string\r\n example: Failure\r\n forbidden:\r\n type: object\r\n properties:\r\n message:\r\n type: string\r\n example: Access Denied Unauthorized User\r\n status:\r\n type: string\r\n example: Failure\r\n paymentrequired:\r\n type: object\r\n properties:\r\n message:\r\n type: string\r\n example: Insufficient Credits Kindly Top Up\r\n status:\r\n type: string\r\n example: Failure\r\n notfound:\r\n type: object\r\n properties:\r\n message:\r\n type: string\r\n example: Invalid Request URL\r\n status:\r\n type: string\r\n example: Failure\r\n servererror:\r\n type: object\r\n properties:\r\n message:\r\n type: string\r\n example: Internal Server Error\r\n status:\r\n type: string\r\n example: Failure\r\n gatewaytimeout:\r\n type: object\r\n properties:\r\n message:\r\n type: string\r\n example: Request Timeout\r\n status:\r\n type: string\r\n example: Failure\r\n inputfieldmissing:\r\n type: object\r\n properties:\r\n message:\r\n type: string\r\n example: Input Field Missing\r\n status:\r\n type: string\r\n example: Failure\r\n inputlimitexceeded:\r\n type: object\r\n properties:\r\n message:\r\n type: string\r\n example: Input Limit Exceeded\r\n status:\r\n type: string\r\n example: Failure\r\n invalidinput:\r\n type: object\r\n properties:\r\n message:\r\n type: string\r\n example: Invalid Input\r\n status:\r\n type: string\r\n example: Failure\r\n input: \r\n type: object\r\n required:\r\n - <>\r\n - <>\r\n properties:\r\n <>:\r\n x-name: <>\r\n type: <> ### verify types for the input type https://swagger.io/specification/\r\n default: <>\r\n example: <>\r\n description: |+\r\n <>\r\n \r\n <>:\r\n x-name: <>\r\n type: <> ### verify types for the input type https://swagger.io/specification/\r\n default: <>\r\n example: <>\r\n description: |+\r\n <>\r\n versions:\r\n type: object\r\n properties: \r\n v<>:\r\n type: array\r\n items:\r\n oneOf:\r\n - type: string\r\n example: 'Published Date - <>'\r\n x-details: <>\r\n description: <>\r\n v<>:\r\n type: array\r\n items:\r\n oneOf:\r\n - type: string\r\n example: 'Published Date - <>'\r\n x-details: <>\r\n description: <>\r\n securitySchemes: ## DO NOT change of the details here\r\n APIAuthorizer:\r\n type: apiKey\r\n name: x-api-key\r\n in: header\r\n x-amazon-apigateway-authtype: custom\r\n description: Authentication is done using the x-api-key in the request header" \ No newline at end of file From 2afc8d38c3d98fdf5e7d7552b03577d48b637af3 Mon Sep 17 00:00:00 2001 From: karunakarv <76933934+karunakarv@users.noreply.github.com> Date: Thu, 22 Jun 2023 16:18:52 +0530 Subject: [PATCH 783/792] Add yaml files From 9ae49cfa487b00b3cebe3e8b092eda4b7187b09c Mon Sep 17 00:00:00 2001 From: karunakarv <76933934+karunakarv@users.noreply.github.com> Date: Thu, 22 Jun 2023 16:33:27 +0530 Subject: [PATCH 784/792] Add yaml files --- D:/New folder/new1.yaml | 1 + 1 file changed, 1 insertion(+) create mode 100644 D:/New folder/new1.yaml diff --git a/D:/New folder/new1.yaml b/D:/New folder/new1.yaml new file mode 100644 index 000000000..c2a530589 --- /dev/null +++ b/D:/New folder/new1.yaml @@ -0,0 +1 @@ +"b'openapi: 3.0.1\\r\\ninfo:\\r\\n title: <>\\r\\n description: |+\\r\\n <>\\r\\n version: \\'<>\\'\\r\\n x-additionalinfo: |+\\r\\n << additional details about the microservice eg:use case, suggestions, model details>>\\r\\n x-subscribelink: <>\\r\\n x-apitype: <>\\r\\n x-apitypedescription: |+\\r\\n <<50 characters api description eg: FAST, REST, small files. Displayed also in platform microservice detail page>>\\r\\n x-inputfilelimit: |+\\r\\n <>\\r\\n x-responsetime: |+\\r\\n <>\\r\\n x-billingmethod: |+\\r\\n <>\\r\\n x-notes: |+\\r\\n <>\\r\\n x-apidetailsdesc: |+\\r\\n <>\\r\\nservers:\\r\\n - url: \\'https://apis.sentient.io\\'\\r\\ntags:\\r\\n- name: \"v<>\"\\r\\n description: \"Published Date - <>\"\\r\\npaths:\\r\\n /microservices/ts<>/v<>/:\\r\\n post:\\r\\n tags:\\r\\n - v<>\\r\\n responses:\\r\\n \\'200\\':\\r\\n description: Ok\\r\\n content:\\r\\n application/json:\\r\\n schema:\\r\\n $ref: \\'#/components/schemas/success\\'\\r\\n example:\\r\\n results:\\r\\n output:\\r\\n - <>\\r\\n message: Successfully Processed\\r\\n status: Success\\r\\n \\'401\\': ## Add all supported error response\\r\\n description: Unauthorized\\r\\n content:\\r\\n application/json:\\r\\n schema:\\r\\n $ref: \\'#/components/schemas/unauthorized\\'\\r\\n \\'402\\':\\r\\n description: Payment Required\\r\\n content:\\r\\n application/json:\\r\\n schema:\\r\\n $ref: \\'#/components/schemas/paymentrequired\\'\\r\\n \\'403\\':\\r\\n description: Forbidden\\r\\n content:\\r\\n application/json:\\r\\n schema:\\r\\n $ref: \\'#/components/schemas/forbidden\\'\\r\\n \\'404\\':\\r\\n description: Not Found\\r\\n content:\\r\\n application/json:\\r\\n schema:\\r\\n $ref: \\'#/components/schemas/notfound\\'\\r\\n \\'419\\':\\r\\n description: Input Field Missing\\r\\n content:\\r\\n application/json:\\r\\n schema:\\r\\n $ref: \\'#/components/schemas/inputfieldmissing\\'\\r\\n \\'413\\':\\r\\n description: Payload Too Large\\r\\n content:\\r\\n application/json:\\r\\n schema:\\r\\n $ref: \\'#/components/schemas/inputlimitexceeded\\'\\r\\n \\'415\\':\\r\\n description: Unsupported Media Type\\r\\n content:\\r\\n application/json:\\r\\n schema:\\r\\n $ref: \\'#/components/schemas/invalidinput\\'\\r\\n \\'500\\':\\r\\n description: Internal Server Error\\r\\n content:\\r\\n application/json:\\r\\n schema:\\r\\n $ref: \\'#/components/schemas/servererror\\'\\r\\n \\'504\\':\\r\\n description: Gateway Timeout\\r\\n content:\\r\\n application/json:\\r\\n schema:\\r\\n $ref: \\'#/components/schemas/gatewaytimeout\\'\\r\\n security:\\r\\n - APIAuthorizer: []\\r\\n requestBody:\\r\\n content:\\r\\n application/json:\\r\\n schema:\\r\\n $ref: \\'#/components/schemas/input\\'\\r\\n required: true\\r\\ncomponents:\\r\\n schemas:\\r\\n success:\\r\\n type: object\\r\\n properties:\\r\\n results: \\r\\n type: object\\r\\n description: The result of the API call.\\r\\n example: { \"\" }\\r\\n properties:\\r\\n output: ## sample output\\r\\n type: <> ### verify types for the input type https://swagger.io/specification/\\r\\n example: >\\r\\n description: <>\\r\\n items:\\r\\n oneOf:\\r\\n - type: object \\r\\n properties:\\r\\n <>:\\r\\n type: <> ### verify types for the input type https://swagger.io/specification/\\r\\n format: <>\\r\\n example: <>\\r\\n description: <>\\r\\n <>:\\r\\n type: <> ### verify types for the input type https://swagger.io/specification/\\r\\n format: <>\\r\\n example: <>\\r\\n description: <>\\r\\n message:\\r\\n type: string\\r\\n example: Successfully Processed\\r\\n description: Description of the API status\\r\\n status:\\r\\n type: string\\r\\n example: Success\\r\\n description: The status of the API call - success/failure\\r\\n unauthorized:\\r\\n type: object\\r\\n properties:\\r\\n message:\\r\\n type: string\\r\\n example: Missing Authentication Token\\r\\n status:\\r\\n type: string\\r\\n example: Failure\\r\\n forbidden:\\r\\n type: object\\r\\n properties:\\r\\n message:\\r\\n type: string\\r\\n example: Access Denied Unauthorized User\\r\\n status:\\r\\n type: string\\r\\n example: Failure\\r\\n paymentrequired:\\r\\n type: object\\r\\n properties:\\r\\n message:\\r\\n type: string\\r\\n example: Insufficient Credits Kindly Top Up\\r\\n status:\\r\\n type: string\\r\\n example: Failure\\r\\n notfound:\\r\\n type: object\\r\\n properties:\\r\\n message:\\r\\n type: string\\r\\n example: Invalid Request URL\\r\\n status:\\r\\n type: string\\r\\n example: Failure\\r\\n servererror:\\r\\n type: object\\r\\n properties:\\r\\n message:\\r\\n type: string\\r\\n example: Internal Server Error\\r\\n status:\\r\\n type: string\\r\\n example: Failure\\r\\n gatewaytimeout:\\r\\n type: object\\r\\n properties:\\r\\n message:\\r\\n type: string\\r\\n example: Request Timeout\\r\\n status:\\r\\n type: string\\r\\n example: Failure\\r\\n inputfieldmissing:\\r\\n type: object\\r\\n properties:\\r\\n message:\\r\\n type: string\\r\\n example: Input Field Missing\\r\\n status:\\r\\n type: string\\r\\n example: Failure\\r\\n inputlimitexceeded:\\r\\n type: object\\r\\n properties:\\r\\n message:\\r\\n type: string\\r\\n example: Input Limit Exceeded\\r\\n status:\\r\\n type: string\\r\\n example: Failure\\r\\n invalidinput:\\r\\n type: object\\r\\n properties:\\r\\n message:\\r\\n type: string\\r\\n example: Invalid Input\\r\\n status:\\r\\n type: string\\r\\n example: Failure\\r\\n input: \\r\\n type: object\\r\\n required:\\r\\n - <>\\r\\n - <>\\r\\n properties:\\r\\n <>:\\r\\n x-name: <>\\r\\n type: <> ### verify types for the input type https://swagger.io/specification/\\r\\n default: <>\\r\\n example: <>\\r\\n description: |+\\r\\n <>\\r\\n \\r\\n <>:\\r\\n x-name: <>\\r\\n type: <> ### verify types for the input type https://swagger.io/specification/\\r\\n default: <>\\r\\n example: <>\\r\\n description: |+\\r\\n <>\\r\\n versions:\\r\\n type: object\\r\\n properties: \\r\\n v<>:\\r\\n type: array\\r\\n items:\\r\\n oneOf:\\r\\n - type: string\\r\\n example: \\'Published Date - <>\\'\\r\\n x-details: <>\\r\\n description: <>\\r\\n v<>:\\r\\n type: array\\r\\n items:\\r\\n oneOf:\\r\\n - type: string\\r\\n example: \\'Published Date - <>\\'\\r\\n x-details: <>\\r\\n description: <>\\r\\n securitySchemes: ## DO NOT change of the details here\\r\\n APIAuthorizer:\\r\\n type: apiKey\\r\\n name: x-api-key\\r\\n in: header\\r\\n x-amazon-apigateway-authtype: custom\\r\\n description: Authentication is done using the x-api-key in the request header'" \ No newline at end of file From 9edee44eefa925f31fc59086d2aab91197df640a Mon Sep 17 00:00:00 2001 From: karunakarv <76933934+karunakarv@users.noreply.github.com> Date: Thu, 22 Jun 2023 17:05:45 +0530 Subject: [PATCH 785/792] Add yaml files --- D:/New folder/sample.yaml | 1081 +++++++++++++++++++++++++++++++++++++ 1 file changed, 1081 insertions(+) create mode 100644 D:/New folder/sample.yaml diff --git a/D:/New folder/sample.yaml b/D:/New folder/sample.yaml new file mode 100644 index 000000000..4128ddb8c --- /dev/null +++ b/D:/New folder/sample.yaml @@ -0,0 +1,1081 @@ +openapi: 3.0.1 + + + +info: + + + + title: <> + + + + description: |+ + + + + <> + + + + version: '<>' + + + + x-additionalinfo: |+ + + + + << additional details about the microservice eg:use case, suggestions, model details>> + + + + x-subscribelink: <> + + + + x-apitype: <> + + + + x-apitypedescription: |+ + + + + <<50 characters api description eg: FAST, REST, small files. Displayed also in platform microservice detail page>> + + + + x-inputfilelimit: |+ + + + + <> + + + + x-responsetime: |+ + + + + <> + + + + x-billingmethod: |+ + + + + <> + + + + x-notes: |+ + + + + <> + + + + x-apidetailsdesc: |+ + + + + <> + + + +servers: + + + + - url: 'https://apis.sentient.io' + + + +tags: + + + +- name: "v<>" + + + + description: "Published Date - <>" + + + +paths: + + + + /microservices/ts<>/v<>/: + + + + post: + + + + tags: + + + + - v<> + + + + responses: + + + + '200': + + + + description: Ok + + + + content: + + + + application/json: + + + + schema: + + + + $ref: '#/components/schemas/success' + + + + example: + + + + results: + + + + output: + + + + - <> + + + + message: Successfully Processed + + + + status: Success + + + + '401': ## Add all supported error response + + + + description: Unauthorized + + + + content: + + + + application/json: + + + + schema: + + + + $ref: '#/components/schemas/unauthorized' + + + + '402': + + + + description: Payment Required + + + + content: + + + + application/json: + + + + schema: + + + + $ref: '#/components/schemas/paymentrequired' + + + + '403': + + + + description: Forbidden + + + + content: + + + + application/json: + + + + schema: + + + + $ref: '#/components/schemas/forbidden' + + + + '404': + + + + description: Not Found + + + + content: + + + + application/json: + + + + schema: + + + + $ref: '#/components/schemas/notfound' + + + + '419': + + + + description: Input Field Missing + + + + content: + + + + application/json: + + + + schema: + + + + $ref: '#/components/schemas/inputfieldmissing' + + + + '413': + + + + description: Payload Too Large + + + + content: + + + + application/json: + + + + schema: + + + + $ref: '#/components/schemas/inputlimitexceeded' + + + + '415': + + + + description: Unsupported Media Type + + + + content: + + + + application/json: + + + + schema: + + + + $ref: '#/components/schemas/invalidinput' + + + + '500': + + + + description: Internal Server Error + + + + content: + + + + application/json: + + + + schema: + + + + $ref: '#/components/schemas/servererror' + + + + '504': + + + + description: Gateway Timeout + + + + content: + + + + application/json: + + + + schema: + + + + $ref: '#/components/schemas/gatewaytimeout' + + + + security: + + + + - APIAuthorizer: [] + + + + requestBody: + + + + content: + + + + application/json: + + + + schema: + + + + $ref: '#/components/schemas/input' + + + + required: true + + + +components: + + + + schemas: + + + + success: + + + + type: object + + + + properties: + + + + results: + + + + type: object + + + + description: The result of the API call. + + + + example: { "" } + + + + properties: + + + + output: ## sample output + + + + type: <> ### verify types for the input type https://swagger.io/specification/ + + + + example: > + + + + description: <> + + + + items: + + + + oneOf: + + + + - type: object + + + + properties: + + + + <>: + + + + type: <> ### verify types for the input type https://swagger.io/specification/ + + + + format: <> + + + + example: <> + + + + description: <> + + + + <>: + + + + type: <> ### verify types for the input type https://swagger.io/specification/ + + + + format: <> + + + + example: <> + + + + description: <> + + + + message: + + + + type: string + + + + example: Successfully Processed + + + + description: Description of the API status + + + + status: + + + + type: string + + + + example: Success + + + + description: The status of the API call - success/failure + + + + unauthorized: + + + + type: object + + + + properties: + + + + message: + + + + type: string + + + + example: Missing Authentication Token + + + + status: + + + + type: string + + + + example: Failure + + + + forbidden: + + + + type: object + + + + properties: + + + + message: + + + + type: string + + + + example: Access Denied Unauthorized User + + + + status: + + + + type: string + + + + example: Failure + + + + paymentrequired: + + + + type: object + + + + properties: + + + + message: + + + + type: string + + + + example: Insufficient Credits Kindly Top Up + + + + status: + + + + type: string + + + + example: Failure + + + + notfound: + + + + type: object + + + + properties: + + + + message: + + + + type: string + + + + example: Invalid Request URL + + + + status: + + + + type: string + + + + example: Failure + + + + servererror: + + + + type: object + + + + properties: + + + + message: + + + + type: string + + + + example: Internal Server Error + + + + status: + + + + type: string + + + + example: Failure + + + + gatewaytimeout: + + + + type: object + + + + properties: + + + + message: + + + + type: string + + + + example: Request Timeout + + + + status: + + + + type: string + + + + example: Failure + + + + inputfieldmissing: + + + + type: object + + + + properties: + + + + message: + + + + type: string + + + + example: Input Field Missing + + + + status: + + + + type: string + + + + example: Failure + + + + inputlimitexceeded: + + + + type: object + + + + properties: + + + + message: + + + + type: string + + + + example: Input Limit Exceeded + + + + status: + + + + type: string + + + + example: Failure + + + + invalidinput: + + + + type: object + + + + properties: + + + + message: + + + + type: string + + + + example: Invalid Input + + + + status: + + + + type: string + + + + example: Failure + + + + input: + + + + type: object + + + + required: + + + + - <> + + + + - <> + + + + properties: + + + + <>: + + + + x-name: <> + + + + type: <> ### verify types for the input type https://swagger.io/specification/ + + + + default: <> + + + + example: <> + + + + description: |+ + + + + <> + + + + + + + + <>: + + + + x-name: <> + + + + type: <> ### verify types for the input type https://swagger.io/specification/ + + + + default: <> + + + + example: <> + + + + description: |+ + + + + <> + + + + versions: + + + + type: object + + + + properties: + + + + v<>: + + + + type: array + + + + items: + + + + oneOf: + + + + - type: string + + + + example: 'Published Date - <>' + + + + x-details: <> + + + + description: <> + + + + v<>: + + + + type: array + + + + items: + + + + oneOf: + + + + - type: string + + + + example: 'Published Date - <>' + + + + x-details: <> + + + + description: <> + + + + securitySchemes: ## DO NOT change of the details here + + + + APIAuthorizer: + + + + type: apiKey + + + + name: x-api-key + + + + in: header + + + + x-amazon-apigateway-authtype: custom + + + + description: Authentication is done using the x-api-key in the request header \ No newline at end of file From 00458c8ad01c006caed0c0a75e44d4ad8aa641f0 Mon Sep 17 00:00:00 2001 From: karunakarv <76933934+karunakarv@users.noreply.github.com> Date: Thu, 22 Jun 2023 17:12:29 +0530 Subject: [PATCH 786/792] Add yaml files --- D:/New folder/sample_ai_docs.yaml | 270 ++++++++++++++++++++++++++++++ 1 file changed, 270 insertions(+) diff --git a/D:/New folder/sample_ai_docs.yaml b/D:/New folder/sample_ai_docs.yaml index 91e77ac5b..eabe7bb09 100644 --- a/D:/New folder/sample_ai_docs.yaml +++ b/D:/New folder/sample_ai_docs.yaml @@ -1,271 +1,541 @@ openapi: 3.0.1 + info: + title: <> + description: |+ + <> + version: '<>' + x-additionalinfo: |+ + << additional details about the microservice eg:use case, suggestions, model details>> + x-subscribelink: <> + x-apitype: <> + x-apitypedescription: |+ + <<50 characters api description eg: FAST, REST, small files. Displayed also in platform microservice detail page>> + x-inputfilelimit: |+ + <> + x-responsetime: |+ + <> + x-billingmethod: |+ + <> + x-notes: |+ + <> + x-apidetailsdesc: |+ + <> + servers: + - url: 'https://apis.sentient.io' + tags: + - name: "v<>" + description: "Published Date - <>" + paths: + /microservices/ts<>/v<>/: + post: + tags: + - v<> + responses: + '200': + description: Ok + content: + application/json: + schema: + $ref: '#/components/schemas/success' + example: + results: + output: + - <> + message: Successfully Processed + status: Success + '401': ## Add all supported error response + description: Unauthorized + content: + application/json: + schema: + $ref: '#/components/schemas/unauthorized' + '402': + description: Payment Required + content: + application/json: + schema: + $ref: '#/components/schemas/paymentrequired' + '403': + description: Forbidden + content: + application/json: + schema: + $ref: '#/components/schemas/forbidden' + '404': + description: Not Found + content: + application/json: + schema: + $ref: '#/components/schemas/notfound' + '419': + description: Input Field Missing + content: + application/json: + schema: + $ref: '#/components/schemas/inputfieldmissing' + '413': + description: Payload Too Large + content: + application/json: + schema: + $ref: '#/components/schemas/inputlimitexceeded' + '415': + description: Unsupported Media Type + content: + application/json: + schema: + $ref: '#/components/schemas/invalidinput' + '500': + description: Internal Server Error + content: + application/json: + schema: + $ref: '#/components/schemas/servererror' + '504': + description: Gateway Timeout + content: + application/json: + schema: + $ref: '#/components/schemas/gatewaytimeout' + security: + - APIAuthorizer: [] + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/input' + required: true + components: + schemas: + success: + type: object + properties: + results: + type: object + description: The result of the API call. + example: { "" } + properties: + output: ## sample output + type: <> ### verify types for the input type https://swagger.io/specification/ + example: > + description: <> + items: + oneOf: + - type: object + properties: + <>: + type: <> ### verify types for the input type https://swagger.io/specification/ + format: <> + example: <> + description: <> + <>: + type: <> ### verify types for the input type https://swagger.io/specification/ + format: <> + example: <> + description: <> + message: + type: string + example: Successfully Processed + description: Description of the API status + status: + type: string + example: Success + description: The status of the API call - success/failure + unauthorized: + type: object + properties: + message: + type: string + example: Missing Authentication Token + status: + type: string + example: Failure + forbidden: + type: object + properties: + message: + type: string + example: Access Denied Unauthorized User + status: + type: string + example: Failure + paymentrequired: + type: object + properties: + message: + type: string + example: Insufficient Credits Kindly Top Up + status: + type: string + example: Failure + notfound: + type: object + properties: + message: + type: string + example: Invalid Request URL + status: + type: string + example: Failure + servererror: + type: object + properties: + message: + type: string + example: Internal Server Error + status: + type: string + example: Failure + gatewaytimeout: + type: object + properties: + message: + type: string + example: Request Timeout + status: + type: string + example: Failure + inputfieldmissing: + type: object + properties: + message: + type: string + example: Input Field Missing + status: + type: string + example: Failure + inputlimitexceeded: + type: object + properties: + message: + type: string + example: Input Limit Exceeded + status: + type: string + example: Failure + invalidinput: + type: object + properties: + message: + type: string + example: Invalid Input + status: + type: string + example: Failure + input: + type: object + required: + - <> + - <> + properties: + <>: + x-name: <> + type: <> ### verify types for the input type https://swagger.io/specification/ + default: <> + example: <> + description: |+ + <> + + <>: + x-name: <> + type: <> ### verify types for the input type https://swagger.io/specification/ + default: <> + example: <> + description: |+ + <> + versions: + type: object + properties: + v<>: + type: array + items: + oneOf: + - type: string + example: 'Published Date - <>' + x-details: <> + description: <> + v<>: + type: array + items: + oneOf: + - type: string + example: 'Published Date - <>' + x-details: <> + description: <> + securitySchemes: ## DO NOT change of the details here + APIAuthorizer: + type: apiKey + name: x-api-key + in: header + x-amazon-apigateway-authtype: custom + description: Authentication is done using the x-api-key in the request header \ No newline at end of file From 526d49c66b4bfe04661b7a68d3f9debbe5a22b83 Mon Sep 17 00:00:00 2001 From: karunakarv <76933934+karunakarv@users.noreply.github.com> Date: Thu, 22 Jun 2023 17:15:24 +0530 Subject: [PATCH 787/792] Add yaml files --- D:/New folder/sample_ai_docs (1).yaml | 1 + 1 file changed, 1 insertion(+) create mode 100644 D:/New folder/sample_ai_docs (1).yaml diff --git a/D:/New folder/sample_ai_docs (1).yaml b/D:/New folder/sample_ai_docs (1).yaml new file mode 100644 index 000000000..2dab2c695 --- /dev/null +++ b/D:/New folder/sample_ai_docs (1).yaml @@ -0,0 +1 @@ +https://cdn.sentient.io/63f448f2ea50d_sample_ai_docs.yaml \ No newline at end of file From c258029ad545019bac40f20e481dc6b673bed9c2 Mon Sep 17 00:00:00 2001 From: karunakarv <76933934+karunakarv@users.noreply.github.com> Date: Thu, 22 Jun 2023 17:16:56 +0530 Subject: [PATCH 788/792] Add yaml files --- D:/New folder/docsfile (3).yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/D:/New folder/docsfile (3).yaml b/D:/New folder/docsfile (3).yaml index 965d57b72..eb50da306 100644 --- a/D:/New folder/docsfile (3).yaml +++ b/D:/New folder/docsfile (3).yaml @@ -1 +1 @@ -"https://cdn.sentient.io//63f448f2ea50d_sample_ai_docs.yaml" \ No newline at end of file +https://cdn.sentient.io//63f448f2ea50d_sample_ai_docs.yaml \ No newline at end of file From d869bc2979de7cc627e26ddfce5ad0bf0d00f760 Mon Sep 17 00:00:00 2001 From: karunakarv <76933934+karunakarv@users.noreply.github.com> Date: Thu, 22 Jun 2023 17:19:26 +0530 Subject: [PATCH 789/792] Add yaml files From 3df145241ba0eb0c3041928e874d7e3b37d18f3d Mon Sep 17 00:00:00 2001 From: gopi140693 <103035586+gopi140693@users.noreply.github.com> Date: Fri, 23 Jun 2023 08:57:14 +0530 Subject: [PATCH 790/792] Delete New folder directory --- New folder/docsfile (3).yaml | 1 - 1 file changed, 1 deletion(-) delete mode 100644 New folder/docsfile (3).yaml diff --git a/New folder/docsfile (3).yaml b/New folder/docsfile (3).yaml deleted file mode 100644 index eb50da306..000000000 --- a/New folder/docsfile (3).yaml +++ /dev/null @@ -1 +0,0 @@ -https://cdn.sentient.io//63f448f2ea50d_sample_ai_docs.yaml \ No newline at end of file From eab8771d4d41b7569764150dfd985f62aa4d76ba Mon Sep 17 00:00:00 2001 From: gopi140693 <103035586+gopi140693@users.noreply.github.com> Date: Fri, 23 Jun 2023 08:57:33 +0530 Subject: [PATCH 791/792] Delete D:/New folder directory --- D:/New folder/decorators.py | 50 -- D:/New folder/docsfile (1).yaml | 0 D:/New folder/docsfile (2).yaml | 1 - D:/New folder/docsfile (3).yaml | 1 - D:/New folder/docsfile.yaml | 1 - D:/New folder/new.yaml | 1 - D:/New folder/new1.yaml | 1 - D:/New folder/sample.yaml | 1081 ------------------------- D:/New folder/sample_ai_docs (1).yaml | 1 - D:/New folder/sample_ai_docs.yaml | 541 ------------- D:/New folder/test_file.zip | 0 11 files changed, 1678 deletions(-) delete mode 100644 D:/New folder/decorators.py delete mode 100644 D:/New folder/docsfile (1).yaml delete mode 100644 D:/New folder/docsfile (2).yaml delete mode 100644 D:/New folder/docsfile (3).yaml delete mode 100644 D:/New folder/docsfile.yaml delete mode 100644 D:/New folder/new.yaml delete mode 100644 D:/New folder/new1.yaml delete mode 100644 D:/New folder/sample.yaml delete mode 100644 D:/New folder/sample_ai_docs (1).yaml delete mode 100644 D:/New folder/sample_ai_docs.yaml delete mode 100644 D:/New folder/test_file.zip diff --git a/D:/New folder/decorators.py b/D:/New folder/decorators.py deleted file mode 100644 index 4ffe4ea70..000000000 --- a/D:/New folder/decorators.py +++ /dev/null @@ -1,50 +0,0 @@ - -# def parent(func): -# def inner(a,b): -# if b==0: -# return False -# else: -# return func(a,b) -# return inner - -# @parent -# def decod(a,b): -# dev= a/b -# return dev - -# print(decod(10,0)) - -# def parent(func): -# def child(): -# data=func() -# result=data.upper() -# return result -# return child - -# def main(): -# return "I am the main function " - -# Result=parent(main) -# print(Result()) - -def grandfather(strg): - def parent(func): - def child(a,b): - if b !=0: - result=func(a,b) - print(result) - return str(result) +strg - else: - return "Can't divide by zero"+strg - return child - return parent -@grandfather(" i am a granfather ") -def div(a,b): - result=a/b - return result - -result=div(100,0) -print(result) - - - \ No newline at end of file diff --git a/D:/New folder/docsfile (1).yaml b/D:/New folder/docsfile (1).yaml deleted file mode 100644 index e69de29bb..000000000 diff --git a/D:/New folder/docsfile (2).yaml b/D:/New folder/docsfile (2).yaml deleted file mode 100644 index 993bab987..000000000 --- a/D:/New folder/docsfile (2).yaml +++ /dev/null @@ -1 +0,0 @@ -"docsfile (2).yaml" \ No newline at end of file diff --git a/D:/New folder/docsfile (3).yaml b/D:/New folder/docsfile (3).yaml deleted file mode 100644 index eb50da306..000000000 --- a/D:/New folder/docsfile (3).yaml +++ /dev/null @@ -1 +0,0 @@ -https://cdn.sentient.io//63f448f2ea50d_sample_ai_docs.yaml \ No newline at end of file diff --git a/D:/New folder/docsfile.yaml b/D:/New folder/docsfile.yaml deleted file mode 100644 index 965d57b72..000000000 --- a/D:/New folder/docsfile.yaml +++ /dev/null @@ -1 +0,0 @@ -"https://cdn.sentient.io//63f448f2ea50d_sample_ai_docs.yaml" \ No newline at end of file diff --git a/D:/New folder/new.yaml b/D:/New folder/new.yaml deleted file mode 100644 index e2bb6b4a2..000000000 --- a/D:/New folder/new.yaml +++ /dev/null @@ -1 +0,0 @@ -"openapi: 3.0.1\r\ninfo:\r\n title: <>\r\n description: |+\r\n <>\r\n version: '<>'\r\n x-additionalinfo: |+\r\n << additional details about the microservice eg:use case, suggestions, model details>>\r\n x-subscribelink: <>\r\n x-apitype: <>\r\n x-apitypedescription: |+\r\n <<50 characters api description eg: FAST, REST, small files. Displayed also in platform microservice detail page>>\r\n x-inputfilelimit: |+\r\n <>\r\n x-responsetime: |+\r\n <>\r\n x-billingmethod: |+\r\n <>\r\n x-notes: |+\r\n <>\r\n x-apidetailsdesc: |+\r\n <>\r\nservers:\r\n - url: 'https://apis.sentient.io'\r\ntags:\r\n- name: \"v<>\"\r\n description: \"Published Date - <>\"\r\npaths:\r\n /microservices/ts<>/v<>/:\r\n post:\r\n tags:\r\n - v<>\r\n responses:\r\n '200':\r\n description: Ok\r\n content:\r\n application/json:\r\n schema:\r\n $ref: '#/components/schemas/success'\r\n example:\r\n results:\r\n output:\r\n - <>\r\n message: Successfully Processed\r\n status: Success\r\n '401': ## Add all supported error response\r\n description: Unauthorized\r\n content:\r\n application/json:\r\n schema:\r\n $ref: '#/components/schemas/unauthorized'\r\n '402':\r\n description: Payment Required\r\n content:\r\n application/json:\r\n schema:\r\n $ref: '#/components/schemas/paymentrequired'\r\n '403':\r\n description: Forbidden\r\n content:\r\n application/json:\r\n schema:\r\n $ref: '#/components/schemas/forbidden'\r\n '404':\r\n description: Not Found\r\n content:\r\n application/json:\r\n schema:\r\n $ref: '#/components/schemas/notfound'\r\n '419':\r\n description: Input Field Missing\r\n content:\r\n application/json:\r\n schema:\r\n $ref: '#/components/schemas/inputfieldmissing'\r\n '413':\r\n description: Payload Too Large\r\n content:\r\n application/json:\r\n schema:\r\n $ref: '#/components/schemas/inputlimitexceeded'\r\n '415':\r\n description: Unsupported Media Type\r\n content:\r\n application/json:\r\n schema:\r\n $ref: '#/components/schemas/invalidinput'\r\n '500':\r\n description: Internal Server Error\r\n content:\r\n application/json:\r\n schema:\r\n $ref: '#/components/schemas/servererror'\r\n '504':\r\n description: Gateway Timeout\r\n content:\r\n application/json:\r\n schema:\r\n $ref: '#/components/schemas/gatewaytimeout'\r\n security:\r\n - APIAuthorizer: []\r\n requestBody:\r\n content:\r\n application/json:\r\n schema:\r\n $ref: '#/components/schemas/input'\r\n required: true\r\ncomponents:\r\n schemas:\r\n success:\r\n type: object\r\n properties:\r\n results: \r\n type: object\r\n description: The result of the API call.\r\n example: { \"\" }\r\n properties:\r\n output: ## sample output\r\n type: <> ### verify types for the input type https://swagger.io/specification/\r\n example: >\r\n description: <>\r\n items:\r\n oneOf:\r\n - type: object \r\n properties:\r\n <>:\r\n type: <> ### verify types for the input type https://swagger.io/specification/\r\n format: <>\r\n example: <>\r\n description: <>\r\n <>:\r\n type: <> ### verify types for the input type https://swagger.io/specification/\r\n format: <>\r\n example: <>\r\n description: <>\r\n message:\r\n type: string\r\n example: Successfully Processed\r\n description: Description of the API status\r\n status:\r\n type: string\r\n example: Success\r\n description: The status of the API call - success/failure\r\n unauthorized:\r\n type: object\r\n properties:\r\n message:\r\n type: string\r\n example: Missing Authentication Token\r\n status:\r\n type: string\r\n example: Failure\r\n forbidden:\r\n type: object\r\n properties:\r\n message:\r\n type: string\r\n example: Access Denied Unauthorized User\r\n status:\r\n type: string\r\n example: Failure\r\n paymentrequired:\r\n type: object\r\n properties:\r\n message:\r\n type: string\r\n example: Insufficient Credits Kindly Top Up\r\n status:\r\n type: string\r\n example: Failure\r\n notfound:\r\n type: object\r\n properties:\r\n message:\r\n type: string\r\n example: Invalid Request URL\r\n status:\r\n type: string\r\n example: Failure\r\n servererror:\r\n type: object\r\n properties:\r\n message:\r\n type: string\r\n example: Internal Server Error\r\n status:\r\n type: string\r\n example: Failure\r\n gatewaytimeout:\r\n type: object\r\n properties:\r\n message:\r\n type: string\r\n example: Request Timeout\r\n status:\r\n type: string\r\n example: Failure\r\n inputfieldmissing:\r\n type: object\r\n properties:\r\n message:\r\n type: string\r\n example: Input Field Missing\r\n status:\r\n type: string\r\n example: Failure\r\n inputlimitexceeded:\r\n type: object\r\n properties:\r\n message:\r\n type: string\r\n example: Input Limit Exceeded\r\n status:\r\n type: string\r\n example: Failure\r\n invalidinput:\r\n type: object\r\n properties:\r\n message:\r\n type: string\r\n example: Invalid Input\r\n status:\r\n type: string\r\n example: Failure\r\n input: \r\n type: object\r\n required:\r\n - <>\r\n - <>\r\n properties:\r\n <>:\r\n x-name: <>\r\n type: <> ### verify types for the input type https://swagger.io/specification/\r\n default: <>\r\n example: <>\r\n description: |+\r\n <>\r\n \r\n <>:\r\n x-name: <>\r\n type: <> ### verify types for the input type https://swagger.io/specification/\r\n default: <>\r\n example: <>\r\n description: |+\r\n <>\r\n versions:\r\n type: object\r\n properties: \r\n v<>:\r\n type: array\r\n items:\r\n oneOf:\r\n - type: string\r\n example: 'Published Date - <>'\r\n x-details: <>\r\n description: <>\r\n v<>:\r\n type: array\r\n items:\r\n oneOf:\r\n - type: string\r\n example: 'Published Date - <>'\r\n x-details: <>\r\n description: <>\r\n securitySchemes: ## DO NOT change of the details here\r\n APIAuthorizer:\r\n type: apiKey\r\n name: x-api-key\r\n in: header\r\n x-amazon-apigateway-authtype: custom\r\n description: Authentication is done using the x-api-key in the request header" \ No newline at end of file diff --git a/D:/New folder/new1.yaml b/D:/New folder/new1.yaml deleted file mode 100644 index c2a530589..000000000 --- a/D:/New folder/new1.yaml +++ /dev/null @@ -1 +0,0 @@ -"b'openapi: 3.0.1\\r\\ninfo:\\r\\n title: <>\\r\\n description: |+\\r\\n <>\\r\\n version: \\'<>\\'\\r\\n x-additionalinfo: |+\\r\\n << additional details about the microservice eg:use case, suggestions, model details>>\\r\\n x-subscribelink: <>\\r\\n x-apitype: <>\\r\\n x-apitypedescription: |+\\r\\n <<50 characters api description eg: FAST, REST, small files. Displayed also in platform microservice detail page>>\\r\\n x-inputfilelimit: |+\\r\\n <>\\r\\n x-responsetime: |+\\r\\n <>\\r\\n x-billingmethod: |+\\r\\n <>\\r\\n x-notes: |+\\r\\n <>\\r\\n x-apidetailsdesc: |+\\r\\n <>\\r\\nservers:\\r\\n - url: \\'https://apis.sentient.io\\'\\r\\ntags:\\r\\n- name: \"v<>\"\\r\\n description: \"Published Date - <>\"\\r\\npaths:\\r\\n /microservices/ts<>/v<>/:\\r\\n post:\\r\\n tags:\\r\\n - v<>\\r\\n responses:\\r\\n \\'200\\':\\r\\n description: Ok\\r\\n content:\\r\\n application/json:\\r\\n schema:\\r\\n $ref: \\'#/components/schemas/success\\'\\r\\n example:\\r\\n results:\\r\\n output:\\r\\n - <>\\r\\n message: Successfully Processed\\r\\n status: Success\\r\\n \\'401\\': ## Add all supported error response\\r\\n description: Unauthorized\\r\\n content:\\r\\n application/json:\\r\\n schema:\\r\\n $ref: \\'#/components/schemas/unauthorized\\'\\r\\n \\'402\\':\\r\\n description: Payment Required\\r\\n content:\\r\\n application/json:\\r\\n schema:\\r\\n $ref: \\'#/components/schemas/paymentrequired\\'\\r\\n \\'403\\':\\r\\n description: Forbidden\\r\\n content:\\r\\n application/json:\\r\\n schema:\\r\\n $ref: \\'#/components/schemas/forbidden\\'\\r\\n \\'404\\':\\r\\n description: Not Found\\r\\n content:\\r\\n application/json:\\r\\n schema:\\r\\n $ref: \\'#/components/schemas/notfound\\'\\r\\n \\'419\\':\\r\\n description: Input Field Missing\\r\\n content:\\r\\n application/json:\\r\\n schema:\\r\\n $ref: \\'#/components/schemas/inputfieldmissing\\'\\r\\n \\'413\\':\\r\\n description: Payload Too Large\\r\\n content:\\r\\n application/json:\\r\\n schema:\\r\\n $ref: \\'#/components/schemas/inputlimitexceeded\\'\\r\\n \\'415\\':\\r\\n description: Unsupported Media Type\\r\\n content:\\r\\n application/json:\\r\\n schema:\\r\\n $ref: \\'#/components/schemas/invalidinput\\'\\r\\n \\'500\\':\\r\\n description: Internal Server Error\\r\\n content:\\r\\n application/json:\\r\\n schema:\\r\\n $ref: \\'#/components/schemas/servererror\\'\\r\\n \\'504\\':\\r\\n description: Gateway Timeout\\r\\n content:\\r\\n application/json:\\r\\n schema:\\r\\n $ref: \\'#/components/schemas/gatewaytimeout\\'\\r\\n security:\\r\\n - APIAuthorizer: []\\r\\n requestBody:\\r\\n content:\\r\\n application/json:\\r\\n schema:\\r\\n $ref: \\'#/components/schemas/input\\'\\r\\n required: true\\r\\ncomponents:\\r\\n schemas:\\r\\n success:\\r\\n type: object\\r\\n properties:\\r\\n results: \\r\\n type: object\\r\\n description: The result of the API call.\\r\\n example: { \"\" }\\r\\n properties:\\r\\n output: ## sample output\\r\\n type: <> ### verify types for the input type https://swagger.io/specification/\\r\\n example: >\\r\\n description: <>\\r\\n items:\\r\\n oneOf:\\r\\n - type: object \\r\\n properties:\\r\\n <>:\\r\\n type: <> ### verify types for the input type https://swagger.io/specification/\\r\\n format: <>\\r\\n example: <>\\r\\n description: <>\\r\\n <>:\\r\\n type: <> ### verify types for the input type https://swagger.io/specification/\\r\\n format: <>\\r\\n example: <>\\r\\n description: <>\\r\\n message:\\r\\n type: string\\r\\n example: Successfully Processed\\r\\n description: Description of the API status\\r\\n status:\\r\\n type: string\\r\\n example: Success\\r\\n description: The status of the API call - success/failure\\r\\n unauthorized:\\r\\n type: object\\r\\n properties:\\r\\n message:\\r\\n type: string\\r\\n example: Missing Authentication Token\\r\\n status:\\r\\n type: string\\r\\n example: Failure\\r\\n forbidden:\\r\\n type: object\\r\\n properties:\\r\\n message:\\r\\n type: string\\r\\n example: Access Denied Unauthorized User\\r\\n status:\\r\\n type: string\\r\\n example: Failure\\r\\n paymentrequired:\\r\\n type: object\\r\\n properties:\\r\\n message:\\r\\n type: string\\r\\n example: Insufficient Credits Kindly Top Up\\r\\n status:\\r\\n type: string\\r\\n example: Failure\\r\\n notfound:\\r\\n type: object\\r\\n properties:\\r\\n message:\\r\\n type: string\\r\\n example: Invalid Request URL\\r\\n status:\\r\\n type: string\\r\\n example: Failure\\r\\n servererror:\\r\\n type: object\\r\\n properties:\\r\\n message:\\r\\n type: string\\r\\n example: Internal Server Error\\r\\n status:\\r\\n type: string\\r\\n example: Failure\\r\\n gatewaytimeout:\\r\\n type: object\\r\\n properties:\\r\\n message:\\r\\n type: string\\r\\n example: Request Timeout\\r\\n status:\\r\\n type: string\\r\\n example: Failure\\r\\n inputfieldmissing:\\r\\n type: object\\r\\n properties:\\r\\n message:\\r\\n type: string\\r\\n example: Input Field Missing\\r\\n status:\\r\\n type: string\\r\\n example: Failure\\r\\n inputlimitexceeded:\\r\\n type: object\\r\\n properties:\\r\\n message:\\r\\n type: string\\r\\n example: Input Limit Exceeded\\r\\n status:\\r\\n type: string\\r\\n example: Failure\\r\\n invalidinput:\\r\\n type: object\\r\\n properties:\\r\\n message:\\r\\n type: string\\r\\n example: Invalid Input\\r\\n status:\\r\\n type: string\\r\\n example: Failure\\r\\n input: \\r\\n type: object\\r\\n required:\\r\\n - <>\\r\\n - <>\\r\\n properties:\\r\\n <>:\\r\\n x-name: <>\\r\\n type: <> ### verify types for the input type https://swagger.io/specification/\\r\\n default: <>\\r\\n example: <>\\r\\n description: |+\\r\\n <>\\r\\n \\r\\n <>:\\r\\n x-name: <>\\r\\n type: <> ### verify types for the input type https://swagger.io/specification/\\r\\n default: <>\\r\\n example: <>\\r\\n description: |+\\r\\n <>\\r\\n versions:\\r\\n type: object\\r\\n properties: \\r\\n v<>:\\r\\n type: array\\r\\n items:\\r\\n oneOf:\\r\\n - type: string\\r\\n example: \\'Published Date - <>\\'\\r\\n x-details: <>\\r\\n description: <>\\r\\n v<>:\\r\\n type: array\\r\\n items:\\r\\n oneOf:\\r\\n - type: string\\r\\n example: \\'Published Date - <>\\'\\r\\n x-details: <>\\r\\n description: <>\\r\\n securitySchemes: ## DO NOT change of the details here\\r\\n APIAuthorizer:\\r\\n type: apiKey\\r\\n name: x-api-key\\r\\n in: header\\r\\n x-amazon-apigateway-authtype: custom\\r\\n description: Authentication is done using the x-api-key in the request header'" \ No newline at end of file diff --git a/D:/New folder/sample.yaml b/D:/New folder/sample.yaml deleted file mode 100644 index 4128ddb8c..000000000 --- a/D:/New folder/sample.yaml +++ /dev/null @@ -1,1081 +0,0 @@ -openapi: 3.0.1 - - - -info: - - - - title: <> - - - - description: |+ - - - - <> - - - - version: '<>' - - - - x-additionalinfo: |+ - - - - << additional details about the microservice eg:use case, suggestions, model details>> - - - - x-subscribelink: <> - - - - x-apitype: <> - - - - x-apitypedescription: |+ - - - - <<50 characters api description eg: FAST, REST, small files. Displayed also in platform microservice detail page>> - - - - x-inputfilelimit: |+ - - - - <> - - - - x-responsetime: |+ - - - - <> - - - - x-billingmethod: |+ - - - - <> - - - - x-notes: |+ - - - - <> - - - - x-apidetailsdesc: |+ - - - - <> - - - -servers: - - - - - url: 'https://apis.sentient.io' - - - -tags: - - - -- name: "v<>" - - - - description: "Published Date - <>" - - - -paths: - - - - /microservices/ts<>/v<>/: - - - - post: - - - - tags: - - - - - v<> - - - - responses: - - - - '200': - - - - description: Ok - - - - content: - - - - application/json: - - - - schema: - - - - $ref: '#/components/schemas/success' - - - - example: - - - - results: - - - - output: - - - - - <> - - - - message: Successfully Processed - - - - status: Success - - - - '401': ## Add all supported error response - - - - description: Unauthorized - - - - content: - - - - application/json: - - - - schema: - - - - $ref: '#/components/schemas/unauthorized' - - - - '402': - - - - description: Payment Required - - - - content: - - - - application/json: - - - - schema: - - - - $ref: '#/components/schemas/paymentrequired' - - - - '403': - - - - description: Forbidden - - - - content: - - - - application/json: - - - - schema: - - - - $ref: '#/components/schemas/forbidden' - - - - '404': - - - - description: Not Found - - - - content: - - - - application/json: - - - - schema: - - - - $ref: '#/components/schemas/notfound' - - - - '419': - - - - description: Input Field Missing - - - - content: - - - - application/json: - - - - schema: - - - - $ref: '#/components/schemas/inputfieldmissing' - - - - '413': - - - - description: Payload Too Large - - - - content: - - - - application/json: - - - - schema: - - - - $ref: '#/components/schemas/inputlimitexceeded' - - - - '415': - - - - description: Unsupported Media Type - - - - content: - - - - application/json: - - - - schema: - - - - $ref: '#/components/schemas/invalidinput' - - - - '500': - - - - description: Internal Server Error - - - - content: - - - - application/json: - - - - schema: - - - - $ref: '#/components/schemas/servererror' - - - - '504': - - - - description: Gateway Timeout - - - - content: - - - - application/json: - - - - schema: - - - - $ref: '#/components/schemas/gatewaytimeout' - - - - security: - - - - - APIAuthorizer: [] - - - - requestBody: - - - - content: - - - - application/json: - - - - schema: - - - - $ref: '#/components/schemas/input' - - - - required: true - - - -components: - - - - schemas: - - - - success: - - - - type: object - - - - properties: - - - - results: - - - - type: object - - - - description: The result of the API call. - - - - example: { "" } - - - - properties: - - - - output: ## sample output - - - - type: <> ### verify types for the input type https://swagger.io/specification/ - - - - example: > - - - - description: <> - - - - items: - - - - oneOf: - - - - - type: object - - - - properties: - - - - <>: - - - - type: <> ### verify types for the input type https://swagger.io/specification/ - - - - format: <> - - - - example: <> - - - - description: <> - - - - <>: - - - - type: <> ### verify types for the input type https://swagger.io/specification/ - - - - format: <> - - - - example: <> - - - - description: <> - - - - message: - - - - type: string - - - - example: Successfully Processed - - - - description: Description of the API status - - - - status: - - - - type: string - - - - example: Success - - - - description: The status of the API call - success/failure - - - - unauthorized: - - - - type: object - - - - properties: - - - - message: - - - - type: string - - - - example: Missing Authentication Token - - - - status: - - - - type: string - - - - example: Failure - - - - forbidden: - - - - type: object - - - - properties: - - - - message: - - - - type: string - - - - example: Access Denied Unauthorized User - - - - status: - - - - type: string - - - - example: Failure - - - - paymentrequired: - - - - type: object - - - - properties: - - - - message: - - - - type: string - - - - example: Insufficient Credits Kindly Top Up - - - - status: - - - - type: string - - - - example: Failure - - - - notfound: - - - - type: object - - - - properties: - - - - message: - - - - type: string - - - - example: Invalid Request URL - - - - status: - - - - type: string - - - - example: Failure - - - - servererror: - - - - type: object - - - - properties: - - - - message: - - - - type: string - - - - example: Internal Server Error - - - - status: - - - - type: string - - - - example: Failure - - - - gatewaytimeout: - - - - type: object - - - - properties: - - - - message: - - - - type: string - - - - example: Request Timeout - - - - status: - - - - type: string - - - - example: Failure - - - - inputfieldmissing: - - - - type: object - - - - properties: - - - - message: - - - - type: string - - - - example: Input Field Missing - - - - status: - - - - type: string - - - - example: Failure - - - - inputlimitexceeded: - - - - type: object - - - - properties: - - - - message: - - - - type: string - - - - example: Input Limit Exceeded - - - - status: - - - - type: string - - - - example: Failure - - - - invalidinput: - - - - type: object - - - - properties: - - - - message: - - - - type: string - - - - example: Invalid Input - - - - status: - - - - type: string - - - - example: Failure - - - - input: - - - - type: object - - - - required: - - - - - <> - - - - - <> - - - - properties: - - - - <>: - - - - x-name: <> - - - - type: <> ### verify types for the input type https://swagger.io/specification/ - - - - default: <> - - - - example: <> - - - - description: |+ - - - - <> - - - - - - - - <>: - - - - x-name: <> - - - - type: <> ### verify types for the input type https://swagger.io/specification/ - - - - default: <> - - - - example: <> - - - - description: |+ - - - - <> - - - - versions: - - - - type: object - - - - properties: - - - - v<>: - - - - type: array - - - - items: - - - - oneOf: - - - - - type: string - - - - example: 'Published Date - <>' - - - - x-details: <> - - - - description: <> - - - - v<>: - - - - type: array - - - - items: - - - - oneOf: - - - - - type: string - - - - example: 'Published Date - <>' - - - - x-details: <> - - - - description: <> - - - - securitySchemes: ## DO NOT change of the details here - - - - APIAuthorizer: - - - - type: apiKey - - - - name: x-api-key - - - - in: header - - - - x-amazon-apigateway-authtype: custom - - - - description: Authentication is done using the x-api-key in the request header \ No newline at end of file diff --git a/D:/New folder/sample_ai_docs (1).yaml b/D:/New folder/sample_ai_docs (1).yaml deleted file mode 100644 index 2dab2c695..000000000 --- a/D:/New folder/sample_ai_docs (1).yaml +++ /dev/null @@ -1 +0,0 @@ -https://cdn.sentient.io/63f448f2ea50d_sample_ai_docs.yaml \ No newline at end of file diff --git a/D:/New folder/sample_ai_docs.yaml b/D:/New folder/sample_ai_docs.yaml deleted file mode 100644 index eabe7bb09..000000000 --- a/D:/New folder/sample_ai_docs.yaml +++ /dev/null @@ -1,541 +0,0 @@ -openapi: 3.0.1 - -info: - - title: <> - - description: |+ - - <> - - version: '<>' - - x-additionalinfo: |+ - - << additional details about the microservice eg:use case, suggestions, model details>> - - x-subscribelink: <> - - x-apitype: <> - - x-apitypedescription: |+ - - <<50 characters api description eg: FAST, REST, small files. Displayed also in platform microservice detail page>> - - x-inputfilelimit: |+ - - <> - - x-responsetime: |+ - - <> - - x-billingmethod: |+ - - <> - - x-notes: |+ - - <> - - x-apidetailsdesc: |+ - - <> - -servers: - - - url: 'https://apis.sentient.io' - -tags: - -- name: "v<>" - - description: "Published Date - <>" - -paths: - - /microservices/ts<>/v<>/: - - post: - - tags: - - - v<> - - responses: - - '200': - - description: Ok - - content: - - application/json: - - schema: - - $ref: '#/components/schemas/success' - - example: - - results: - - output: - - - <> - - message: Successfully Processed - - status: Success - - '401': ## Add all supported error response - - description: Unauthorized - - content: - - application/json: - - schema: - - $ref: '#/components/schemas/unauthorized' - - '402': - - description: Payment Required - - content: - - application/json: - - schema: - - $ref: '#/components/schemas/paymentrequired' - - '403': - - description: Forbidden - - content: - - application/json: - - schema: - - $ref: '#/components/schemas/forbidden' - - '404': - - description: Not Found - - content: - - application/json: - - schema: - - $ref: '#/components/schemas/notfound' - - '419': - - description: Input Field Missing - - content: - - application/json: - - schema: - - $ref: '#/components/schemas/inputfieldmissing' - - '413': - - description: Payload Too Large - - content: - - application/json: - - schema: - - $ref: '#/components/schemas/inputlimitexceeded' - - '415': - - description: Unsupported Media Type - - content: - - application/json: - - schema: - - $ref: '#/components/schemas/invalidinput' - - '500': - - description: Internal Server Error - - content: - - application/json: - - schema: - - $ref: '#/components/schemas/servererror' - - '504': - - description: Gateway Timeout - - content: - - application/json: - - schema: - - $ref: '#/components/schemas/gatewaytimeout' - - security: - - - APIAuthorizer: [] - - requestBody: - - content: - - application/json: - - schema: - - $ref: '#/components/schemas/input' - - required: true - -components: - - schemas: - - success: - - type: object - - properties: - - results: - - type: object - - description: The result of the API call. - - example: { "" } - - properties: - - output: ## sample output - - type: <> ### verify types for the input type https://swagger.io/specification/ - - example: > - - description: <> - - items: - - oneOf: - - - type: object - - properties: - - <>: - - type: <> ### verify types for the input type https://swagger.io/specification/ - - format: <> - - example: <> - - description: <> - - <>: - - type: <> ### verify types for the input type https://swagger.io/specification/ - - format: <> - - example: <> - - description: <> - - message: - - type: string - - example: Successfully Processed - - description: Description of the API status - - status: - - type: string - - example: Success - - description: The status of the API call - success/failure - - unauthorized: - - type: object - - properties: - - message: - - type: string - - example: Missing Authentication Token - - status: - - type: string - - example: Failure - - forbidden: - - type: object - - properties: - - message: - - type: string - - example: Access Denied Unauthorized User - - status: - - type: string - - example: Failure - - paymentrequired: - - type: object - - properties: - - message: - - type: string - - example: Insufficient Credits Kindly Top Up - - status: - - type: string - - example: Failure - - notfound: - - type: object - - properties: - - message: - - type: string - - example: Invalid Request URL - - status: - - type: string - - example: Failure - - servererror: - - type: object - - properties: - - message: - - type: string - - example: Internal Server Error - - status: - - type: string - - example: Failure - - gatewaytimeout: - - type: object - - properties: - - message: - - type: string - - example: Request Timeout - - status: - - type: string - - example: Failure - - inputfieldmissing: - - type: object - - properties: - - message: - - type: string - - example: Input Field Missing - - status: - - type: string - - example: Failure - - inputlimitexceeded: - - type: object - - properties: - - message: - - type: string - - example: Input Limit Exceeded - - status: - - type: string - - example: Failure - - invalidinput: - - type: object - - properties: - - message: - - type: string - - example: Invalid Input - - status: - - type: string - - example: Failure - - input: - - type: object - - required: - - - <> - - - <> - - properties: - - <>: - - x-name: <> - - type: <> ### verify types for the input type https://swagger.io/specification/ - - default: <> - - example: <> - - description: |+ - - <> - - - - <>: - - x-name: <> - - type: <> ### verify types for the input type https://swagger.io/specification/ - - default: <> - - example: <> - - description: |+ - - <> - - versions: - - type: object - - properties: - - v<>: - - type: array - - items: - - oneOf: - - - type: string - - example: 'Published Date - <>' - - x-details: <> - - description: <> - - v<>: - - type: array - - items: - - oneOf: - - - type: string - - example: 'Published Date - <>' - - x-details: <> - - description: <> - - securitySchemes: ## DO NOT change of the details here - - APIAuthorizer: - - type: apiKey - - name: x-api-key - - in: header - - x-amazon-apigateway-authtype: custom - - description: Authentication is done using the x-api-key in the request header \ No newline at end of file diff --git a/D:/New folder/test_file.zip b/D:/New folder/test_file.zip deleted file mode 100644 index e69de29bb..000000000 From 3c1aa48f6590c321678a935e1d477c72d9b36944 Mon Sep 17 00:00:00 2001 From: karunakarv <76933934+karunakarv@users.noreply.github.com> Date: Fri, 23 Jun 2023 09:56:12 +0530 Subject: [PATCH 792/792] Add yaml files --- D:/New folder/sample_ai_docs.yaml | 271 ++++++++++++++++++++++++++++++ 1 file changed, 271 insertions(+) create mode 100644 D:/New folder/sample_ai_docs.yaml diff --git a/D:/New folder/sample_ai_docs.yaml b/D:/New folder/sample_ai_docs.yaml new file mode 100644 index 000000000..91e77ac5b --- /dev/null +++ b/D:/New folder/sample_ai_docs.yaml @@ -0,0 +1,271 @@ +openapi: 3.0.1 +info: + title: <> + description: |+ + <> + version: '<>' + x-additionalinfo: |+ + << additional details about the microservice eg:use case, suggestions, model details>> + x-subscribelink: <> + x-apitype: <> + x-apitypedescription: |+ + <<50 characters api description eg: FAST, REST, small files. Displayed also in platform microservice detail page>> + x-inputfilelimit: |+ + <> + x-responsetime: |+ + <> + x-billingmethod: |+ + <> + x-notes: |+ + <> + x-apidetailsdesc: |+ + <> +servers: + - url: 'https://apis.sentient.io' +tags: +- name: "v<>" + description: "Published Date - <>" +paths: + /microservices/ts<>/v<>/: + post: + tags: + - v<> + responses: + '200': + description: Ok + content: + application/json: + schema: + $ref: '#/components/schemas/success' + example: + results: + output: + - <> + message: Successfully Processed + status: Success + '401': ## Add all supported error response + description: Unauthorized + content: + application/json: + schema: + $ref: '#/components/schemas/unauthorized' + '402': + description: Payment Required + content: + application/json: + schema: + $ref: '#/components/schemas/paymentrequired' + '403': + description: Forbidden + content: + application/json: + schema: + $ref: '#/components/schemas/forbidden' + '404': + description: Not Found + content: + application/json: + schema: + $ref: '#/components/schemas/notfound' + '419': + description: Input Field Missing + content: + application/json: + schema: + $ref: '#/components/schemas/inputfieldmissing' + '413': + description: Payload Too Large + content: + application/json: + schema: + $ref: '#/components/schemas/inputlimitexceeded' + '415': + description: Unsupported Media Type + content: + application/json: + schema: + $ref: '#/components/schemas/invalidinput' + '500': + description: Internal Server Error + content: + application/json: + schema: + $ref: '#/components/schemas/servererror' + '504': + description: Gateway Timeout + content: + application/json: + schema: + $ref: '#/components/schemas/gatewaytimeout' + security: + - APIAuthorizer: [] + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/input' + required: true +components: + schemas: + success: + type: object + properties: + results: + type: object + description: The result of the API call. + example: { "" } + properties: + output: ## sample output + type: <> ### verify types for the input type https://swagger.io/specification/ + example: > + description: <> + items: + oneOf: + - type: object + properties: + <>: + type: <> ### verify types for the input type https://swagger.io/specification/ + format: <> + example: <> + description: <> + <>: + type: <> ### verify types for the input type https://swagger.io/specification/ + format: <> + example: <> + description: <> + message: + type: string + example: Successfully Processed + description: Description of the API status + status: + type: string + example: Success + description: The status of the API call - success/failure + unauthorized: + type: object + properties: + message: + type: string + example: Missing Authentication Token + status: + type: string + example: Failure + forbidden: + type: object + properties: + message: + type: string + example: Access Denied Unauthorized User + status: + type: string + example: Failure + paymentrequired: + type: object + properties: + message: + type: string + example: Insufficient Credits Kindly Top Up + status: + type: string + example: Failure + notfound: + type: object + properties: + message: + type: string + example: Invalid Request URL + status: + type: string + example: Failure + servererror: + type: object + properties: + message: + type: string + example: Internal Server Error + status: + type: string + example: Failure + gatewaytimeout: + type: object + properties: + message: + type: string + example: Request Timeout + status: + type: string + example: Failure + inputfieldmissing: + type: object + properties: + message: + type: string + example: Input Field Missing + status: + type: string + example: Failure + inputlimitexceeded: + type: object + properties: + message: + type: string + example: Input Limit Exceeded + status: + type: string + example: Failure + invalidinput: + type: object + properties: + message: + type: string + example: Invalid Input + status: + type: string + example: Failure + input: + type: object + required: + - <> + - <> + properties: + <>: + x-name: <> + type: <> ### verify types for the input type https://swagger.io/specification/ + default: <> + example: <> + description: |+ + <> + + <>: + x-name: <> + type: <> ### verify types for the input type https://swagger.io/specification/ + default: <> + example: <> + description: |+ + <> + versions: + type: object + properties: + v<>: + type: array + items: + oneOf: + - type: string + example: 'Published Date - <>' + x-details: <> + description: <> + v<>: + type: array + items: + oneOf: + - type: string + example: 'Published Date - <>' + x-details: <> + description: <> + securitySchemes: ## DO NOT change of the details here + APIAuthorizer: + type: apiKey + name: x-api-key + in: header + x-amazon-apigateway-authtype: custom + description: Authentication is done using the x-api-key in the request header \ No newline at end of file